Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Voice Activity Detection

Understand voice activity detection in Vivox.
Read time 1 minuteLast updated 2 days ago

Voice activity detection detects the presence or absence of speech in an application. In most cases, customers do not need to adjust the default voice activity detection (VAD) settings of the Vivox SDK. The Vivox Unreal SDK does not provide an API to adjust the VAD settings. If you want to modify the code for the Unreal wrapper, you can add support for the
vx_req_aux_set_vad_properties
request from the Core SDK. You can manipulate the VAD mic gating by using these requests and handling their responses.
To use
vx_req_aux_set_vad_properties
and
vx_req_aux_get_vad_properties
, you need to add these requests to an existing endpoint or an exposed function of the Unity API, or create a new endpoint. To confirm your successful requests, ensure that you handle the responses.
Before manually tuning the VAD settings, test your setup using Automatically Adjusted VAD. Automatically Adjusted VAD is better at detecting a player speaking than the default VAD settings. Set
vad_auto
to 1 in the
vx_req_aux_set_vad_properties
call to enable automatic adjustment. See the example shown below to enable
vad_auto
:
vx_req_aux_set_vad_properties_t *req;vx_req_aux_set_vad_properties_create(&req);req->vad_hangover = 2000;req->vad_sensitivity = 43;req->vad_noise_floor = 576;req->vad_auto = 1;vx_issue_request(&req->base);
If the Automatically Adjusted VAD does not help, disable vad_auto by setting it to 0 and provide values for
vad_hangover
,
vad_sensitivity
, and
vad_noise_floor
.