audioPlaybackParams JSON Reference
| Declared in | AudioPromptModuleList.schema.json |
Overview
The audio playback parameters of an Audio Segment that is referenced from an Audio Prompt Module.
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
-
loopPlayjson parameterSpecifies whether to repeat audio playback of Audio Segment after audio playback ends. The value can be set at runtime using the
"loopPlayRuntime"property. Default:"false".Parameter is optional.
-
loopPlayRuntimejson parameterContains 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"loopPlay"property. Example:"$[LoopPlay]".Parameter is optional.
-
loopCountjson parameterAutomatic maximum count of audio playbacks of Audio Segment if
"loopPlay"property is"true". The value can be set at runtime using the"loopCountRuntime"property. Default: 1.Parameter is optional.
-
loopCountRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"loopCount"property. Example:"$[loopCount]".Parameter is optional.
-
volumejson parameterSpecifies a volume to apply to audio playback. The value can be set at runtime using the
"volumeRuntime"property. Values: minimum value > 0.0. Max value is 1.0. Default: 1.0.Parameter is optional.
-
volumeRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the"volume"property. Example:"$[Volume]".Parameter is optional.
-
ratejson parameterSpecifies a rate to apply to audio playback. The value can be set at runtime using the
"rateRuntime"property. Values: beetween 0.5 and 2.0. Default: 1.0.Parameter is optional.
-
rateRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the"rate"property. Example:"$[Rolume]".Parameter is optional.
-
pitchjson parameterSpecifies a pitch to apply to audio playback. The value can be set at runtime using the
"pitchRuntime"property. Values between -5.0 and 5.0. Default: 0.0.Parameter is optional.
-
pitchRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the"pitch"property. Example:"$[Pitch]".Parameter is optional.
-
fadeOutMsjson parameterThe duration in milliseconds for audio playback of the Audio Segment to fade out before completely stopping. The value can be set at runtime using the
"fadeOutMsRuntime"property. Default: 0.Parameter is optional.
-
fadeOutMsRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"fadeOutMs"property. Example:"$[FadeOutMs]".Parameter is optional.
-
startPosMsjson parameterTime position in milliseconds for when audio playback to start for the Audio Segment. The value can be set at runtime using the
"startPosMsRuntime"property. Default: 0.Parameter is optional.
-
startPosMsRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"startPosMs"property. Example:"$[StartPosMs]".Parameter is optional.
-
stopPosMsjson parameterTime position in milliseconds for when audio playback to stop for the Audio Segment. The value can be set at runtime using the
"stopPosMsRuntime"property. Default: 0 for audio playback to continue to the end of the audio.Parameter is optional.
-
stopPosMsRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"stopPosMs"property. Example:"$[StopPosMs]".Parameter is optional.
-
notifyPosMsjson parameterTime position in milliseconds for when audio playback is reached, a notification is sent to Client. The value can be set at runtime using the
"notifyPosMsRuntime"property.Parameter is optional.
-
notifyPosMsRuntimejson parameterContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"notifyPosMs"property. Example:"$[NotifyPosMs]".Parameter is optional.
-
playSSSilenceParamsjson parameterSpecifies the Speech Synthesis parameters for audio play of synthesized text.
Parameter is optional.
-
recordSSParamsjson parameterThe parameters to control saving speech synthesis of an audio segment into a file.
Parameter is optional.
JSON Parameters
fadeOutMs
"fadeOutMs": integer
Discussion
The duration in milliseconds for audio playback of the Audio Segment to fade out before completely stopping. The value can be set at runtime using the "fadeOutMsRuntime" property. Default: 0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
fadeOutMsRuntime
"fadeOutMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "fadeOutMs" property. Example: "$[FadeOutMs]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
loopCount
"loopCount": integer
Discussion
Automatic maximum count of audio playbacks of Audio Segment if "loopPlay" property is "true". The value can be set at runtime using the "loopCountRuntime" property. Default: 1.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
loopCountRuntime
"loopCountRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "loopCount" property. Example: "$[loopCount]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
loopPlay
"loopPlay": boolean
Discussion
Specifies whether to repeat audio playback of Audio Segment after audio playback ends. The value can be set at runtime using the "loopPlayRuntime" property. Default: "false".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
loopPlayRuntime
"loopPlayRuntime": 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 "loopPlay" property. Example: "$[LoopPlay]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
notifyPosMs
"notifyPosMs": integer
Discussion
Time position in milliseconds for when audio playback is reached, a notification is sent to Client. The value can be set at runtime using the "notifyPosMsRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
notifyPosMsRuntime
"notifyPosMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "notifyPosMs" property. Example: "$[NotifyPosMs]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
pitch
"pitch": number
Discussion
Specifies a pitch to apply to audio playback. The value can be set at runtime using the "pitchRuntime" property. Values between -5.0 and 5.0. Default: 0.0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
pitchRuntime
"pitchRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the "pitch" property. Example: "$[Pitch]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
playSSSilenceParams
"playSSSilenceParams": object - playSSSilenceParams
Discussion
Specifies the Speech Synthesis parameters for audio play of synthesized text.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
rate
"rate": number
Discussion
Specifies a rate to apply to audio playback. The value can be set at runtime using the "rateRuntime" property. Values: beetween 0.5 and 2.0. Default: 1.0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
rateRuntime
"rateRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the "rate" property. Example: "$[Rolume]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
recordSSParams
"recordSSParams": object - recordSSParams
Discussion
The parameters to control saving speech synthesis of an audio segment into a file.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
startPosMs
"startPosMs": integer
Discussion
Time position in milliseconds for when audio playback to start for the Audio Segment. The value can be set at runtime using the "startPosMsRuntime" property. Default: 0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
startPosMsRuntime
"startPosMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "startPosMs" property. Example: "$[StartPosMs]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
stopPosMs
"stopPosMs": integer
Discussion
Time position in milliseconds for when audio playback to stop for the Audio Segment. The value can be set at runtime using the "stopPosMsRuntime" property. Default: 0 for audio playback to continue to the end of the audio.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
stopPosMsRuntime
"stopPosMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "stopPosMs" property. Example: "$[StopPosMs]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
volume
"volume": number
Discussion
Specifies a volume to apply to audio playback. The value can be set at runtime using the "volumeRuntime" property. Values: minimum value > 0.0. Max value is 1.0. Default: 1.0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
volumeRuntime
"volumeRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose float value can be set at runtime by an application. If the value of the field is a valid float, then it will replace the value entered in the "volume" property. Example: "$[Volume]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json