Declared in Voiceflow.schema.json

Overview

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. "recordPlayPromptParams" configuration is used in Voiceflow Modules of type "recordAudio", "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

  •   promptID

    The ID of an Audio Prompt Module to process for audio playback before starting or during audio recording, or to record audio diretly fromit as the audio source. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   recordPromptNoPlay

    Specifies how to use the audio prompt module for recording audio. If "false" then the audio prompt module is processed for audio playback before or during audio recording. If "true" then the audio generated by processing the audio prompt module is used as the source for audio recording. Default: "false". The value can be set at runtime using the "recordPromptNoPlayRuntime" property.

    Parameter is optional.

           json parameter
  •   recordPromptNoPlayRuntime

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

    Parameter is optional.

           json parameter
  •   recordWhilePlay

    Specifies when to process the audio prompt module for audio playback. If "false" then the audio prompt module is processed for audio playback, and audio recording is started after audio playback is completed. If "true" then the audio prompt module is processed for audio playback just after audio recording starts. Default: "false". The value can be set at runtime using the "recordPromptNoPlayRuntime" property.

    Parameter is optional.

           json parameter
  •   recordWhilePlayRuntime

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

    Parameter is optional.

           json parameter
  •   stopPlayAudioWhenSpeechDetected

    Specifies if audio playback should automatically stop if speech is detected during audio recording. Default: "false". if "true" then this requires "vadParams" to be also configured in "recordAudio" voice flow module. The value can be set at runtime using the "stopPlayAudioWhenSpeechDetectedRuntime" property.

    Parameter is optional.

           json parameter
  •   stopPlayAudioWhenSpeechDetectedRuntime

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

    Parameter is optional.

           json parameter
  •   stopPlayAudioWhenValidSRHypothesis

    Specifies if audio playback should automatically stop if a valid Speech Recognition hypothesis is recognized during audio recording. Default: "false". Requires "stopPlaySRHypothesisList" to be configured. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "stopPlayAudioWhenValidSRHypothesisRuntime" property.

    Parameter is optional.

           json parameter
  •   stopPlayAudioWhenValidSRHypothesisRuntime

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

    Parameter is optional.

           json parameter
  •   enableStopPlaySRHypothesisPartial

    Specifies if audio playback should automatically stop if a partial Speech Recognition hypothesis is recognized during audio recording. Default: "false". This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "enableStopPlaySRHypothesisPartialRuntime" property.

    Parameter is optional.

           json parameter
  •   enableStopPlaySRHypothesisPartialRuntime

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

    Parameter is optional.

           json parameter
  •   stopPlaySRHypothesisList

    String containing multiple SR Hypotheses separated by "|" delimiter. Audio recording will automatically stop if SR hypothesis matches any hypothesis in the list. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. Example: "stopPlaySRHypothesisList": "hey veronica | Go to sleep | wake up". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter

JSON Parameters

enableStopPlaySRHypothesisPartial

"enableStopPlaySRHypothesisPartial": boolean

Discussion

Specifies if audio playback should automatically stop if a partial Speech Recognition hypothesis is recognized during audio recording. Default: "false". This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "enableStopPlaySRHypothesisPartialRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

enableStopPlaySRHypothesisPartialRuntime

"enableStopPlaySRHypothesisPartialRuntime": 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 "enableStopPlaySRHypothesisPartial" property. Example: "$[EnableStopPlaySRHypothesisPartial]".

Parameter is optional.

Declared In

Voiceflow.schema.json

promptID

"promptID": string

Discussion

The ID of an Audio Prompt Module to process for audio playback before starting or during audio recording, or to record audio diretly fromit as the audio source. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

recordPromptNoPlay

"recordPromptNoPlay": boolean

Discussion

Specifies how to use the audio prompt module for recording audio. If "false" then the audio prompt module is processed for audio playback before or during audio recording. If "true" then the audio generated by processing the audio prompt module is used as the source for audio recording. Default: "false". The value can be set at runtime using the "recordPromptNoPlayRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

recordPromptNoPlayRuntime

"recordPromptNoPlayRuntime": 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 "recordPromptNoPlay" property. Example: "$[RecordPromptNoPlay]".

Parameter is optional.

Declared In

Voiceflow.schema.json

recordWhilePlay

"recordWhilePlay": boolean

Discussion

Specifies when to process the audio prompt module for audio playback. If "false" then the audio prompt module is processed for audio playback, and audio recording is started after audio playback is completed. If "true" then the audio prompt module is processed for audio playback just after audio recording starts. Default: "false". The value can be set at runtime using the "recordPromptNoPlayRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

recordWhilePlayRuntime

"recordWhilePlayRuntime": 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 "recordPromptNoPlay" property. Example: "$[RecordPromptNoPlay]".

Parameter is optional.

Declared In

Voiceflow.schema.json

stopPlayAudioWhenSpeechDetected

"stopPlayAudioWhenSpeechDetected": boolean

Discussion

Specifies if audio playback should automatically stop if speech is detected during audio recording. Default: "false". if "true" then this requires "vadParams" to be also configured in "recordAudio" voice flow module. The value can be set at runtime using the "stopPlayAudioWhenSpeechDetectedRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

stopPlayAudioWhenSpeechDetectedRuntime

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

Parameter is optional.

Declared In

Voiceflow.schema.json

stopPlayAudioWhenValidSRHypothesis

"stopPlayAudioWhenValidSRHypothesis": boolean

Discussion

Specifies if audio playback should automatically stop if a valid Speech Recognition hypothesis is recognized during audio recording. Default: "false". Requires "stopPlaySRHypothesisList" to be configured. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "stopPlayAudioWhenValidSRHypothesisRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

stopPlayAudioWhenValidSRHypothesisRuntime

"stopPlayAudioWhenValidSRHypothesisRuntime": 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 "stopPlayAudioWhenValidSRHypothesis" property. Example: "$[StopPlayAudioWhenValidSRHypothesis]".

Parameter is optional.

Declared In

Voiceflow.schema.json

stopPlaySRHypothesisList

"stopPlaySRHypothesisList": string

Discussion

String containing multiple SR Hypotheses separated by "|" delimiter. Audio recording will automatically stop if SR hypothesis matches any hypothesis in the list. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. Example: "stopPlaySRHypothesisList": "hey veronica | Go to sleep | wake up". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json