Declared in Voiceflow.schema.json

Overview

Specifies the parameters for recording audio. "recordAudioParams" configuration is used in Voiceflow Modules of types "recordAudio", "recognizeAudio", "audioDialog" and "audioListener".

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.

Properties

  •   id

    Specifies an ID form the audio recording task. User Defined. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   notifyPosMs

    Time duration in milliseconds for, when audio recording is reached, a notification is sent to Client. Default: 0. The value can be set at runtime using the "notifyPosMsRuntime" property.

    Parameter is optional.

           json parameter
  •   notifyPosMsRuntime

    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 "notifyPosMs" property. Example: "$[NotifyPosMs]".

    Parameter is optional.

           json parameter
  •   recordPlayPromptParams

    Specifies the parameters for recording audio during or after a prompt is processed for audio playback, or for recording audio directly from a audio prompt module as the audio source.

    Parameter is optional.

           json parameter
  •   saveAudioParams

    Specifies the parameters for saving recorded audio to a file.

    Parameter is optional.

           json parameter
  •   vadParams

    Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.

    Parameter is optional.

           json parameter
  •   stopRecordParams

    Specifies the recording audio thresholds, which when reached, result in record audio to stop automatically.

    Parameter is optional.

           json parameter

JSON Parameters

id

"id": string

Discussion

Specifies an ID form the audio recording task. User Defined. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

notifyPosMs

"notifyPosMs": integer

Discussion

Time duration in milliseconds for, when audio recording is reached, a notification is sent to Client. Default: 0. The value can be set at runtime using the "notifyPosMsRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

notifyPosMsRuntime

"notifyPosMsRuntime": 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 "notifyPosMs" property. Example: "$[NotifyPosMs]".

Parameter is optional.

Declared In

Voiceflow.schema.json

recordPlayPromptParams

"recordPlayPromptParams": object - recordPlayPromptParams

Discussion

Specifies the parameters for recording audio during or after a prompt is processed for audio playback, or for recording audio directly from a audio prompt module as the audio source.

Parameter is optional.

Declared In

Voiceflow.schema.json

saveAudioParams

"saveAudioParams": object - saveAudioParams

Discussion

Specifies the parameters for saving recorded audio to a file.

Parameter is optional.

Declared In

Voiceflow.schema.json

stopRecordParams

"stopRecordParams": object - stopRecordParams

Discussion

Specifies the recording audio thresholds, which when reached, result in record audio to stop automatically.

Parameter is optional.

Declared In

Voiceflow.schema.json

vadParams

"vadParams": object - vadParams

Discussion

Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.

Parameter is optional.

Declared In

Voiceflow.schema.json