Audio Recording
JSON type object
audioRecording JSON type objectCapture audio in a Conversation and control how and when recording ends.
Behavior and notes
- A speechRecognition operation uses audioRecording for capture-side behavior such as VAD, stop conditions, playback interaction, and saved utterance output. Include audioRecording when those controls are needed.
Developer guidance
Audio Recording groups capture-side controls. recordingPlayback coordinates capture with prompt playback, recordingOutput controls saved audio, voiceActivityDetection controls speech/silence detection, and stopConditions provides limits.
Example in context
Illustrative JSON excerpt (not a complete configuration document):
{
"audioRecording": {
"voiceActivityDetection": {
"enabled": true,
"sensitivity": "low",
"trimSilence": false
},
"stopConditions": {
"maximumPreSpeechSilenceMs": 2000,
"maximumPostSpeechSilenceMs": 1200
}
}
}
Stop-condition values are milliseconds. These settings belong under audioRecording.
Properties
Jump to a property:
id · bookmarkPositionMs · recordingPlayback · recordingOutput · voiceActivityDetection · stopConditionsid
Optional recording-operation identifier used for callbacks and events.
bookmarkPositionMs
Playback/capture bookmark position in milliseconds. Zero disables the bookmark.
recordingPlayback
Controls interaction between recording and associated prompt playback.
recordingOutput
Controls saved recording output.
voiceActivityDetection
Configures voice activity detection.
stopConditions
Configures duration and silence conditions that stop capture.