Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_req_aux_set_vad_properties

Reference the Vivox Core SDK API.
Read time 2 minutesLast updated 20 hours ago

Module: Audio Devices Set the connector VAD (Voice Activity Detector) properties. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
intvad_hangover
The time in milliseconds that it takes for the VAD to switch back to silence from speech mode after the last speech frame has been detected.
intvad_sensitivity
A dimensionless value between 0 and 100 that indicates the sensitivity of the VAD.
intvad_noise_floor
A dimensionless value between 0 and 20000 that controls the maximum level at which the noise floor can be set to by the VAD's noise tracking.
intvad_auto
VAD automatic parameter selection.
VX_HANDLEaccount_handle
An optional parameter that specifies the account handle of the user whose connector VAD properties will be set.

Detailed Description

struct vx_req_aux_set_vad_properties;
Set the connector VAD (Voice Activity Detector) properties. The following properties update when capture audio is active:
  • vad_hangover
  • vad_sensitivity
  • vad_auto The vad_noise_floor property requires capture audio restart to update (for example, the update occurs after rejoining a voice channel). vx_req_aux_set_vad_properties

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable vad_hangover

int vad_hangover;
The time in milliseconds that it takes for the VAD to switch back to silence from speech mode after the last speech frame has been detected.

variable vad_sensitivity

int vad_sensitivity;
A dimensionless value between 0 and 100 that indicates the sensitivity of the VAD. Increasing this value corresponds to decreasing the sensitivity of the VAD. 0 is the most sensitive, and 100 is the least sensitive.

variable vad_noise_floor

int vad_noise_floor;
A dimensionless value between 0 and 20000 that controls the maximum level at which the noise floor can be set to by the VAD's noise tracking. The default value is 576. Too low of a value can make noise tracking ineffective. A value of 0 disables noise tracking, at which point the VAD must rely only on the sensitivity property. Too high of a value can make long speech classifiable as noise.

variable vad_auto

int vad_auto;
VAD automatic parameter selection. If this mode is 1 (enabled), then vad_hangover, vad_sensitivity, and vad_noise_floor are ignored, and the VAD automatically optimizes parameters.

variable account_handle

VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose connector VAD properties will be set. This must either be unset or the account_handle that was passed in to a vx_req_account_anonymous_login request that previously succeeded. If unset, the default account_handle is used.