Audio Playback Params 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.
Tasks
-
loopPlaypropertySpecifies 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.
-
loopPlayRuntimepropertyContains 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.
-
maxPlayCountpropertyAutomatic maximum count of audio playbacks of Audio Segment if
"loopPlay"property is"true". The value can be set at runtime using the"maxPlayCountRuntime"property. Default: 1.Parameter is optional.
-
maxPlayCountRuntimepropertyContains 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"maxPlayCount"property. Example:"$[MaxPlayCount]".Parameter is optional.
-
audioFormatpropertyAudio format of recorded audio in audio file. May be required if audio file does not contain header that specifies audio format of audio data. Values:
"pcm_8khz","pcm_16khz","pcm_32khz","pcm_48khz","wav","compressed"(experimental),"preencoded"(experimental),"media", or"raw". Default:"pcm_16khz". Default:"pcm_16khz"if audio format is not automatically detected. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
volumeScalepropertySpecifies a volume scale to apply to audio playback. The value can be set at runtime using the
"volumeScaleRuntime"property. Values: minimum value > 0.0. Default: 1.0.Parameter is optional.
-
volumeScaleRuntimepropertyContains 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"volumeScale"property. Example:"$[VolumeScale]".Parameter is optional.
-
startPosMspropertyTime 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.
-
startPosMsRuntimepropertyContains 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.
-
stopPosMspropertyTime 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.
-
stopPosMsRuntimepropertyContains 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.
-
notifyPosMspropertyTime 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.
-
notifyPosMsRuntimepropertyContains 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.
-
audioCodecproperty(Experimental) The audio codec parameters to use for audio playback if one is not specified in
"audioFormat"parameter.Parameter is optional.
-
ssEngineParamspropertySpecifies the Speech Synthesizer parameters.
Parameter is optional.
-
recordSSParamspropertyThe parameters to control saving speech synthesis of an audio segment into a file.
Parameter is optional.
Properties
audioCodec
"audioCodec": object - AudioCodec
Discussion
(Experimental) The audio codec parameters to use for audio playback if one is not specified in "audioFormat" parameter.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
audioFormat
"audioFormat": string
Discussion
Audio format of recorded audio in audio file. May be required if audio file does not contain header that specifies audio format of audio data. Values: "pcm_8khz", "pcm_16khz", "pcm_32khz", "pcm_48khz", "wav", "compressed" (experimental), "preencoded" (experimental), "media", or "raw". Default: "pcm_16khz". Default: "pcm_16khz" if audio format is not automatically detected. The value can be set at runtime using "$[<FieldName>]" entry convention.
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
maxPlayCount
"maxPlayCount": 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 "maxPlayCountRuntime" property. Default: 1.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
maxPlayCountRuntime
"maxPlayCountRuntime": 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 "maxPlayCount" property. Example: "$[MaxPlayCount]".
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
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
ssEngineParams
"ssEngineParams": object - SSEngineParams
Discussion
Specifies the Speech Synthesizer parameters.
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
volumeScale
"volumeScale": number
Discussion
Specifies a volume scale to apply to audio playback. The value can be set at runtime using the "volumeScaleRuntime" property. Values: minimum value > 0.0. Default: 1.0.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
volumeScaleRuntime
"volumeScaleRuntime": 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 "volumeScale" property. Example: "$[VolumeScale]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json