Immersitech Logo Developer Resources
imm_cv_config Struct Reference

A structure containing all necessary configuration options to initialize ClearVoice. More...

#include <immersitech_clearvoice.h>

Data Fields

int input_sample_rate
 
int output_sample_rate
 
imm_cv_anc_mode anc_mode
 
int aeq_enabled
 
int agc_enabled
 
int anc_mix
 
int bsd_low_vad_threshold
 
int bsd_inactive_speech_cooldown
 
imm_cv_vad_mode vad_mode
 
int multistream_mode_enabled
 

Detailed Description

A structure containing all necessary configuration options to initialize ClearVoice.

Parameters
input_sample_rateThe sample rate of the audio input.
output_sample_rateThe desired sample rate of the audio output.
anc_modeThe operating mode of AI Noise Cancellation
aeq_enabledWhether Automatic Equalization is On or Off
agc_enabledWhether Automatic Gain Control is On or Off
anc_mixThe wet/dry mix [0-100] of the AI Noise Cancellation. 0 is only noisy audio, 100 is only noise cancelled audio.
bsd_low_vad_thresholdThe VAD Score threshold considered speech when calculating Binary Speech Detection (BSD).
bsd_inactive_speech_cooldownThe time in ms the VAD Score must be under bsd_low_vad_threshold in order to BSD to return False.
vad_modeThe operating mode of the Voice Activity Detector
multistream_mode_enabledWhether ClearVoice is operating in Multistream Mode or not. In Multistream Mode, you must add individual audio streams with imm_cv_add_stream(), and process them using imm_cv_process_stream().

Field Documentation

◆ aeq_enabled

int imm_cv_config::aeq_enabled

◆ agc_enabled

int imm_cv_config::agc_enabled

◆ anc_mix

int imm_cv_config::anc_mix

◆ anc_mode

imm_cv_anc_mode imm_cv_config::anc_mode

◆ bsd_inactive_speech_cooldown

int imm_cv_config::bsd_inactive_speech_cooldown

◆ bsd_low_vad_threshold

int imm_cv_config::bsd_low_vad_threshold

◆ input_sample_rate

int imm_cv_config::input_sample_rate

◆ multistream_mode_enabled

int imm_cv_config::multistream_mode_enabled

◆ output_sample_rate

int imm_cv_config::output_sample_rate

◆ vad_mode

imm_cv_vad_mode imm_cv_config::vad_mode

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