Configuration Reference

Speech Synthesis Recording

JSON property speechSynthesisRecording

JSON type object

Used in Audio Playback Parameters, Audio Playback Parameters

Speech Synthesis Recording controls whether synthesized speech is written to an audio file, whether synthesis is performed without audio-device playback, whether inserted silence is included, and where and in what format the recording is stored.

JSON form

object

Properties

Jump to a property:

enabled · offlineMode · includeInsertedSilence · fileType · fileName · resourceLocation · resourceLanguage · audioFormat

`enabled`

booleanOptionalDefault: False

Specifies whether synthesized speech is recorded to an audio file.

Runtime fields: Supported

`offlineMode`

booleanOptionalDefault: False

Specifies whether synthesized speech is generated and recorded without playing the synthesized audio through the audio output device.

Runtime fields: Supported

`includeInsertedSilence`

booleanOptionalDefault: False

Specifies whether silence introduced by insertedSpeechSynthesisSilence is included in the synthesized-speech recording.

Runtime fields: Supported

`fileType`

stringOptionalDefault: wav

Specifies the audio file type used to store the synthesized-speech recording. The selected type also determines the extension Andamento expects for fileName.

Allowed values

wav — WAV audio file.
caf — Core Audio Format file.
m4a — MPEG-4 audio file.

Runtime fields: Supported

`fileName`

stringOptional

Specifies the recording file name. If the value does not already end with the extension selected by fileType, Andamento appends that extension preceded by a period. An existing extension of another type is not replaced; for example, with fileType "wav", "welcome.caf" becomes "welcome.caf.wav".

Runtime fields: Supported

`resourceLocation`

stringOptional

Specifies where the synthesized-speech recording is stored. An absolute filesystem path is used directly. A relative resource location is resolved through the framework's configured resource locations. If the target folder does not exist, Andamento can create it when the application has the required filesystem permissions.

Runtime fields: Supported

`resourceLanguage`

stringOptionalDefault: en-US

Specifies the language folder in which the synthesized-speech recording is stored. Andamento creates the language folder within the resolved resourceLocation when it does not already exist, provided the application has the required filesystem permissions.

Runtime fields: Supported

`audioFormat`

objectOptional

Specifies the audio encoding and format parameters used for the synthesized-speech recording.

Examples

Record synthesized speech

{
  "enabled": true,
  "fileType": "wav",
  "fileName": "welcome",
  "resourceLocation": "generated-prompts",
  "resourceLanguage": "en-US"
}