Stop Record Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the recording audio thresholds, which when reached, result in record audio to stop automatically.
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
-
maxRecordLengthMspropertySpecifies the maximum recording duration threshold in milliseconds of audio recorded to destination. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the
"maxRecordLengthMsRuntime"property.Parameter is optional.
-
maxRecordLengthMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"maxRecordLengthMs"property. Example:"$[MaxRecordLengthMs]".Parameter is optional.
-
maxAudioLengthMspropertySpecifies the maximum audio duration threshold in milliseconds of audio captured at a source to be processed and recorded. if VAD is filtering silence from recorded audio then recorded audio duration would be less than duration of audio captured at source. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the
"maxAudioLengthMsRuntime"property.Parameter is optional.
-
maxAudioLengthMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"maxAudioLengthMs"property. Example:"$[MaxAudioLengthMs]".Parameter is optional.
-
maxSpeechLengthMspropertySpecifies the maximum speech duration threshold in milliseconds in recorded audio. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the
"maxSpeechLengthMsRuntime"property.Parameter is optional.
-
maxSpeechLengthMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"maxSpeechLengthMs"property. Example:"$[MaxSpeechLengthMs]".Parameter is optional.
-
maxPreSpeechSilenceLengthMspropertySpecifies the maximum pre-speech silence duration threshold in milliseconds. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the
"maxPreSpeechSilenceLengthMsRuntime"property.Parameter is optional.
-
maxPreSpeechSilenceLengthMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"maxPreSpeechSilenceLengthMs"property. Example:"$[MaxPreSpeechSilenceLengthMs]".Parameter is optional.
-
maxPostSpeechSilenceLengthMspropertySpecifies the maximum post-speech silence duration threshold in milliseconds. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the
"maxPostSpeechSilenceLengthMsRuntime"property.Parameter is optional.
-
maxPostSpeechSilenceLengthMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"maxPostSpeechSilenceLengthMs"property. Example:"$[MaxPostSpeechSilenceLengthMs]".Parameter is optional.
Properties
maxAudioLengthMs
"maxAudioLengthMs": integer
Discussion
Specifies the maximum audio duration threshold in milliseconds of audio captured at a source to be processed and recorded. if VAD is filtering silence from recorded audio then recorded audio duration would be less than duration of audio captured at source. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the "maxAudioLengthMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
maxAudioLengthMsRuntime
"maxAudioLengthMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "maxAudioLengthMs" property. Example: "$[MaxAudioLengthMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
maxPostSpeechSilenceLengthMs
"maxPostSpeechSilenceLengthMs": integer
Discussion
Specifies the maximum post-speech silence duration threshold in milliseconds. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the "maxPostSpeechSilenceLengthMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
maxPostSpeechSilenceLengthMsRuntime
"maxPostSpeechSilenceLengthMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "maxPostSpeechSilenceLengthMs" property. Example: "$[MaxPostSpeechSilenceLengthMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
maxPreSpeechSilenceLengthMs
"maxPreSpeechSilenceLengthMs": integer
Discussion
Specifies the maximum pre-speech silence duration threshold in milliseconds. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the "maxPreSpeechSilenceLengthMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
maxPreSpeechSilenceLengthMsRuntime
"maxPreSpeechSilenceLengthMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "maxPreSpeechSilenceLengthMs" property. Example: "$[MaxPreSpeechSilenceLengthMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
maxRecordLengthMs
"maxRecordLengthMs": integer
Discussion
Specifies the maximum recording duration threshold in milliseconds of audio recorded to destination. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the "maxRecordLengthMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
maxRecordLengthMsRuntime
"maxRecordLengthMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "maxRecordLengthMs" property. Example: "$[MaxRecordLengthMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
maxSpeechLengthMs
"maxSpeechLengthMs": integer
Discussion
Specifies the maximum speech duration threshold in milliseconds in recorded audio. Record audio ends when this threshold is reached. Default: 0 (disabled). The value can be set at runtime using the "maxSpeechLengthMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
maxSpeechLengthMsRuntime
"maxSpeechLengthMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "maxSpeechLengthMs" property. Example: "$[MaxSpeechLengthMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json