Configuration Reference

Audio Playback Parameters

JSON property audioPlaybackParams

JSON type object

Used in Prompt Module Properties, Audio Prompt Module

Audio Playback Parameters control looping, volume, rate, pitch, playback positions, fade-out behavior, inserted speech-synthesis silence, and optional recording of synthesized speech.

JSON form

object

Developer guidance

Playback parameters control looping, gain, speed, pitch, positions, and optional speech-synthesis silence or recording settings. Numeric values such as volume, rate, and pitch are JSON numbers; time offsets are in milliseconds.

Example in context

Illustrative JSON excerpt (not a complete configuration document):

{
  "audioPlaybackParams": {
    "loop": false,
    "volume": 1.0,
    "rate": 1.0,
    "pitch": 1.0
  }
}

The structure is reusable; this example shows its property shape rather than a full conversation.

Properties

Jump to a property:

loop · loopCount · volume · rate · pitch · fadeOutMs · startPositionMs · stopPositionMs · bookmarkPositionMs · insertedSpeechSynthesisSilence · speechSynthesisRecording

`loop`

booleanOptionalDefault: False

Specifies whether playback should repeat. When true, playback repeats according to loopCount. When false, playback does not repeat.

Runtime fields: Supported

`loopCount`

integerOptionalDefault: 1

Specifies the maximum number of additional times playback is repeated when loop is enabled. A value of 0 results in no additional playback. A value of 1 repeats the audio once after its initial playback, resulting in two total playbacks. A negative value causes playback to repeat continuously until playback is otherwise stopped.

Runtime fields: Supported

`volume`

numberOptionalDefault: 1.0

Specifies playback volume as a normalized level, where 1.0 represents full playback volume. Valid values are greater than 0.0 through 1.0.

Runtime fields: Supported

`rate`

numberOptionalDefault: 1.0

Specifies playback rate. A value of 1.0 is normal speed; values below 1.0 slow playback and values above 1.0 increase playback speed. The supported range is 0.5 through 2.0.

Runtime fields: Supported

`pitch`

numberOptionalDefault: 0.0

Specifies pitch adjustment during playback. A value of 0.0 leaves the original pitch unchanged. Negative values lower pitch and positive values raise pitch. The supported range is -5.0 through 5.0.

Runtime fields: Supported

`fadeOutMs`

integerOptionalDefault: 0

Specifies the duration, in milliseconds, over which audio fades out when playback is stopped. A value of 0 disables fade-out.

Runtime fields: Supported

`startPositionMs`

integerOptionalDefault: 0

Specifies the position within the audio resource, in milliseconds, at which playback begins. A value of 0 starts at the beginning.

Runtime fields: Supported

`stopPositionMs`

integerOptionalDefault: 0

Specifies the position within the audio resource, in milliseconds, at which playback stops. A value of 0 allows playback to continue to the end.

Runtime fields: Supported

`bookmarkPositionMs`

integerOptionalDefault: 0

Specifies a position within the audio resource, in milliseconds, at which Andamento generates a playback notification to the application. A value of 0 disables the bookmark notification.

Runtime fields: Supported

`insertedSpeechSynthesisSilence`

objectOptional

Specifies silence inserted around and within synthesized speech.

`speechSynthesisRecording`

objectOptional

Specifies whether and how synthesized speech is recorded to an audio file.

Examples

Playback parameters

{
  "volume": 1.0,
  "rate": 1.0,
  "insertedSpeechSynthesisSilence": {
    "initialSilenceMs": 250,
    "finalSilenceMs": 250
  }
}