Declared in AudioPromptModuleList.schema.json

Overview

An Audio Prompt Module is configured for audio playback of multiple Audio Segments or for audio playback of other referenced multiple Audio Prompt Modules.

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

  •   id

    Unique ID of an Audio Prompt Module. The value cannot be set at runtime.`

    Parameter is required.

           json parameter
  •   style

    Style of selection of audio segments or Audio Prompt Modules. Values: "single", "select", "combo", or "serial". If Audio Prompt Module references a collection of other Audio Prompt Module IDs then Default: "combo". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is required.

           json parameter
  •   audioFile

    The name of the audio file containing the recorded Audio Segment for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   textString

    The text string to be synthesized for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   textFile

    The name of the text file containing the text to be synthesized for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   textIsSSML

    Specifies whether the text to be synthesized contains Speech Synthesis Markup Language "SSML". Values: "true" or "false". Default: "false". The value can be set at runtime using the "textIsSSMLRuntime" property.

    Parameter is optional.

           json parameter
  •   textIsSSMLRuntime

    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 "textIsSSML" property. Example: "textIsSSMLRuntime": "$[TextIsSSML]".

    Parameter is optional.

           json parameter
  •   autoDetectSSML

    Specifies whether the the speech synthesis should attempt to auto detect if the text contains SSML markup and to process accordingly.

    Parameter is optional.

           json parameter
  •   autoDetectSSMLRuntime

    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 "autoDetectSSML" property. Example: "autoDetectSSMLRuntime": "$[AutoDetectSSML]".

    Parameter is optional.

           json parameter
  •   autoDetectLanguage

    Specifies whether the the speech synthesis should attempt to auto detect the language of the text and to select the proper voice for speech synthesis.

    Parameter is optional.

           json parameter
  •   autoDetectLanguageRuntime

    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 "autoDetectLanguage" property. Example: "autoDetectLanguageRuntime": "$[AutoDetectLanguage]".

    Parameter is optional.

           json parameter
  •   ssEngine

    The Text To Speech or Speech Synthesizer engine to be used for Speech Synthesis. Currently, only value of "Apple" is supported which is also the default if this parameter is not specified. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   languageFolder

    The name of the language folder name set up to contain the recorded audio files. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   promptCollection

    Specifies a reference to an array of other Audio Prompt Module IDs referenced from this Audio Prompt Module.

    Parameter is optional.

           json parameter
  •   ssVoiceParams

    Specifies the parameters of the voice used for Speech Synthesis.

    Parameter is optional.

           json parameter
  •   audioPlaybackParams

    Specifies audio playback parameters of the Audio Segment referenced in an Audio Prompt Module.

    Parameter is optional.

           json parameter

JSON Parameters

audioFile

"audioFile": string

Discussion

The name of the audio file containing the recorded Audio Segment for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

audioPlaybackParams

"audioPlaybackParams": object - audioPlayBackParams

Discussion

Specifies audio playback parameters of the Audio Segment referenced in an Audio Prompt Module.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

autoDetectLanguage

"autoDetectLanguage": boolean

Discussion

Specifies whether the the speech synthesis should attempt to auto detect the language of the text and to select the proper voice for speech synthesis.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

autoDetectLanguageRuntime

"autoDetectLanguageRuntime": 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 "autoDetectLanguage" property. Example: "autoDetectLanguageRuntime": "$[AutoDetectLanguage]".

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

autoDetectSSML

"autoDetectSSML": boolean

Discussion

Specifies whether the the speech synthesis should attempt to auto detect if the text contains SSML markup and to process accordingly.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

autoDetectSSMLRuntime

"autoDetectSSMLRuntime": 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 "autoDetectSSML" property. Example: "autoDetectSSMLRuntime": "$[AutoDetectSSML]".

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

id

"id": string

Discussion

Unique ID of an Audio Prompt Module. The value cannot be set at runtime.`

Parameter is required.

Declared In

AudioPromptModuleList.schema.json

languageFolder

"languageFolder": string

Discussion

The name of the language folder name set up to contain the recorded audio files. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

promptCollection

"promptCollection": array - [prompt]

Discussion

Specifies a reference to an array of other Audio Prompt Module IDs referenced from this Audio Prompt Module.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

ssEngine

"ssEngine": string

Discussion

The Text To Speech or Speech Synthesizer engine to be used for Speech Synthesis. Currently, only value of "Apple" is supported which is also the default if this parameter is not specified. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

ssVoiceParams

"ssVoiceParams": object - ssVoiceParams

Discussion

Specifies the parameters of the voice used for Speech Synthesis.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

style

"style": string

Discussion

Style of selection of audio segments or Audio Prompt Modules. Values: "single", "select", "combo", or "serial". If Audio Prompt Module references a collection of other Audio Prompt Module IDs then Default: "combo". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is required.

Declared In

AudioPromptModuleList.schema.json

textFile

"textFile": string

Discussion

The name of the text file containing the text to be synthesized for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

textIsSSML

"textIsSSML": boolean

Discussion

Specifies whether the text to be synthesized contains Speech Synthesis Markup Language "SSML". Values: "true" or "false". Default: "false". The value can be set at runtime using the "textIsSSMLRuntime" property.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

textIsSSMLRuntime

"textIsSSMLRuntime": 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 "textIsSSML" property. Example: "textIsSSMLRuntime": "$[TextIsSSML]".

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

textString

"textString": string

Discussion

The text string to be synthesized for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json