VAD Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
enableVADpropertySpecifies if Voice Activity Detection will be enabled on the recorded audio. Default:
"false". The value can be set at runtime using the"enableVADRuntime"property.Parameter is optional.
-
enableVADRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableVAD"property. Example:"$[EnableVAD]".Parameter is optional.
-
trimSilencepropertySpecifies if silence to be trimmed from the recorded audio. Default:
"false". The value can be set at runtime using the"trimSilenceRuntime"property.Parameter is optional.
-
trimSilenceRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"trimSilence"property. Example:"$[TrimSilence]".Parameter is optional.
-
savePreTrimAudiopropertySpecifies if the original recorded audio should also be saved in its own file if
"trimSilence"is"true". Default:"false". if"true", this will result in another file to be recorded with base file name containing"preTrim"string. The value can be set at runtime using the"savePreTrimAudioRuntime"property.Parameter is optional.
-
savePreTrimAudioRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"savePreTrimAudio"property. Example:"$[SavePreTrimAudio]".Parameter is optional.
-
vadLikelihoodpropertySpecifies the likelihood category of VAD which impacts the sensitivity of VAD. Values:
"very low","low","moderate","high", or"custom". Default:"custom"."custom"value requires"vadCustomLikelihoodParams"to be configured. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
vadCustomLikelihoodParamspropertySpecifies the custom likelihood parameters for VAD which determines the VAD sensitivity.
Parameter is optional.
Properties
enableVAD
"enableVAD": boolean
Discussion
Specifies if Voice Activity Detection will be enabled on the recorded audio. Default: "false". The value can be set at runtime using the "enableVADRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableVADRuntime
"enableVADRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableVAD" property. Example: "$[EnableVAD]".
Parameter is optional.
Declared In
Voiceflow.schema.json
savePreTrimAudio
"savePreTrimAudio": boolean
Discussion
Specifies if the original recorded audio should also be saved in its own file if "trimSilence" is "true". Default: "false". if "true", this will result in another file to be recorded with base file name containing "preTrim" string. The value can be set at runtime using the "savePreTrimAudioRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
savePreTrimAudioRuntime
"savePreTrimAudioRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "savePreTrimAudio" property. Example: "$[SavePreTrimAudio]".
Parameter is optional.
Declared In
Voiceflow.schema.json
trimSilence
"trimSilence": boolean
Discussion
Specifies if silence to be trimmed from the recorded audio. Default: "false". The value can be set at runtime using the "trimSilenceRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
trimSilenceRuntime
"trimSilenceRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "trimSilence" property. Example: "$[TrimSilence]".
Parameter is optional.
Declared In
Voiceflow.schema.json
vadCustomLikelihoodParams
"vadCustomLikelihoodParams": object - VADCustomLikelihoodParams
Discussion
Specifies the custom likelihood parameters for VAD which determines the VAD sensitivity.
Parameter is optional.
Declared In
Voiceflow.schema.json
vadLikelihood
"vadLikelihood": string
Discussion
Specifies the likelihood category of VAD which impacts the sensitivity of VAD. Values: "very low", "low", "moderate", "high", or "custom". Default: "custom". "custom" value requires "vadCustomLikelihoodParams" to be configured. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json