Method SetVoiceActivityDetectionPropertiesAsync
SetVoiceActivityDetectionPropertiesAsync(int, int, int)
Sets voice activity detection parameters. Parameters will be defaulted to their original default value if not provided. Call this with no parameters provided if you wish to reset the VAD settings. It is recommended to cache the settings and apply all of them each time this method is called. Must be logged in to perform this action.
Declaration
Task SetVoiceActivityDetectionPropertiesAsync(int hangover = 2000, int noiseFloor = 576, int sensitivity = 43)Parameters
| Type | Name | Description |
|---|---|---|
| int | hangover | The hangover time is the time (in milliseconds) it takes for the VAD to switch back from speech mode to silence after the last speech frame is detected. The default value is 2000. |
| int | noiseFloor | The noise floor is a dimensionless value between 0 and 20000 that controls how the VAD separates speech from background noise. Lower values assume the user is in a quieter environment where the audio is only speech. Higher values assume a noisy background environment.The default value is 576. Note: Changes to the VAD noiseFloor settings do not affect currently joined channels. If the ability to change VAD settings is available to the end-user, indicate that noiseFloor changes only take effect in the next voice session or only allow changing the noiseFloor when the client is not in a channel. |
| int | sensitivity | The sensitivity is 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). Higher values of sensitivity require louder audio to trigger the VAD. The default value is 43. |
Returns
| Type | Description |
|---|---|
| Task | Task for the operation |