Configuration Reference
Recording Playback Parameters
Controls how audio capture interacts with an associated Prompt Module.
Behavior and notes
- When recordWhilePlaying is true, use configureParams.audioProcessingMode = conversational to prevent prompt echo from entering the recording stream.
Properties
Jump to a property:
promptID · recordPromptAudio · recordWhilePlaying · stopPlaybackWhenSpeechDetected · stopPlaybackWhenValidHypothesis · includePartialHypothesis · stopPlaybackHypothesespromptID
stringOptional
Associated Prompt Module.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
recordPromptAudio
booleanOptionalDefault: False
When true, records the prompt audio itself rather than normal microphone capture.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
recordWhilePlaying
booleanOptionalDefault: False
When true, microphone recording and prompt playback run concurrently.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
stopPlaybackWhenSpeechDetected
booleanOptionalDefault: False
Stops the playing prompt when VAD detects speech; recording continues.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
stopPlaybackWhenValidHypothesis
booleanOptionalDefault: False
For interactive capture, allows a valid recognition hypothesis to stop concurrent prompt playback.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
includePartialHypothesis
booleanOptionalDefault: False
Allows partial hypotheses to participate in stop-playback hypothesis evaluation.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].
stopPlaybackHypotheses
stringOptional
Case-insensitive | separated substrings that can stop playback when matched.
Runtime fields: Supported — The complete property value may be supplied using $[FieldName].