imm_clearvoice Class Reference

#include <immersitech_clearvoice.h>

Public Member Functions
	imm_clearvoice (const char *license_filepath, int sampling_rate, bool enable_auto_eq, bool enable_agc, float anc_mix)
	Constructor for the Immersitech ClearVoice object. More...
	imm_clearvoice (uint8_t *license_file_data, size_t license_file_data_size, int sampling_rate, bool enable_auto_eq, bool enable_agc, float anc_mix)
	Constructor for the Immersitech ClearVoice object. More...
	~imm_clearvoice ()
	Destructor for the Immersitech ClearVoice object. More...
float	process (float *input, float *output)
	Process a single channel 10ms audio block and return VAD flag. More...
void	set_anc_mix (float val)
	Set output mixture level (0 - 100) between noisy input and clean output. More...
float	get_anc_mix (void)
	Get output mixture level between noisy input and clean output. More...
void	set_auto_eq (bool val)
	Enable or disable automatic equalization. More...
bool	get_auto_eq (void)
	Get automatic equalization setting. More...
void	set_agc (bool val)
	Enable or disable automatic gain control. More...
bool	get_agc (void)
	Get automatic gain control setting. More...

Constructor & Destructor Documentation

imm_clearvoice() [1/2]

imm_clearvoice::imm_clearvoice	(	const char *	license_filepath,
		int	sampling_rate,
		bool	enable_auto_eq,
		bool	enable_agc,
		float	anc_mix
	)

Constructor for the Immersitech ClearVoice object.

Parameters

[in]	license_file_name	The path to your immersitech license file including the file name ("/path/my_license.dat").
[in]	sampling_rate	The input sampling rate of the new participant (must be an integer divisible by 100).
[in]	enable_auto_eq	Whether automatic EQ is enabled or not.
[in]	enable_agc	Whether automatic gain control is enabled or not.
[in]	anc_mix	The wet/dry mix of the automatic noise cancellation. (0-100. 100 is only clean output, while 0 is only noisy)

Returns

An Immersitech Clear Voice object of your initialized library. This object will be used for the other functions in the Immersitech API

imm_clearvoice() [2/2]

imm_clearvoice::imm_clearvoice	(	uint8_t *	license_file_data,
		size_t	license_file_data_size,
		int	sampling_rate,
		bool	enable_auto_eq,
		bool	enable_agc,
		float	anc_mix
	)

Constructor for the Immersitech ClearVoice object.

Parameters

[in]	license_file_data	The pointer to the in-memory license file data.
[in]	license_file_data_size	The size of your in-memory license file data.
[in]	sampling_rate	The input sampling rate of the new participant (must be an integer divisible by 100).
[in]	enable_auto_eq	Whether automatic EQ is enabled or not.
[in]	enable_agc	Whether automatic gain control is enabled or not.
[in]	anc_mix	The wet/dry mix of the automatic noise cancellation. (0-100. 100 is only clean output, while 0 is only noisy)

Returns

An Immersitech Clear Voice object of your initialized library. This object will be used for the other functions in the Immersitech API

~imm_clearvoice()

imm_clearvoice::~imm_clearvoice

(

)

Destructor for the Immersitech ClearVoice object.

Member Function Documentation

get_agc()

bool imm_clearvoice::get_agc

(

void

)

Get automatic gain control setting.

Returns

bool value true or false

get_anc_mix()

float imm_clearvoice::get_anc_mix

(

void

)

Get output mixture level between noisy input and clean output.

Returns

float value 0-100

get_auto_eq()

bool imm_clearvoice::get_auto_eq

(

void

)

Get automatic equalization setting.

Returns

bool value true or false

process()

float imm_clearvoice::process	(	float *	input,
		float *	output
	)

Process a single channel 10ms audio block and return VAD flag.

Parameters

[in]	input	The pointer to your input buffer
[out]	output	The pointer to your output buffer

Returns

float value 0.0-1.0 representing the likelihood that speech is present in the output buffer

set_agc()

void imm_clearvoice::set_agc

(

bool

val

)

Enable or disable automatic gain control.

Parameters

[in]

val

True for enable, False for disable

set_anc_mix()

void imm_clearvoice::set_anc_mix

(

float

val

)

Set output mixture level (0 - 100) between noisy input and clean output.

Parameters

[in]

val

float value 0-100

set_auto_eq()

void imm_clearvoice::set_auto_eq

(

bool

val

)

Enable or disable automatic equalization.

Parameters

[in]

val

True for enable, False for disable

---

The documentation for this class was generated from the following file:

• immersitech_clearvoice.h