Record SS Params JSON Reference
| Declared in | AudioPromptModuleList.schema.json |
Overview
The parameters to control saving speech synthesis of an audio segment into a file.
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
-
enablepropertyEnable or disable saving speech synthesis into a file. The value can be set at runtime using the
"enableRuntime"property.Parameter is optional.
-
enableRuntimepropertyContains 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"enable"property. Example:"$[Enable]".Parameter is optional.
-
offlineModepropertyIf true, then audio playback will not occur on a device. Only speech synthesis is saved into a file. The value can be set at runtime using the
"offlineModeRuntime"property.Parameter is optional.
-
offlineModeRuntimepropertyContains 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"offlineMode"property. Example:"$[OfflineMode]".Parameter is optional.
-
filetypepropertyType of audio file to contain the synthesized audip. options are
"wav"and"caf". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
fileBaseNamepropertyFile base name.
".wav"or".caf"is appended. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
fileURLPathpropertyFolder path where the synthesized audio file is saved. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
languageCodepropertyIf specified that
"languageCode"will be appended ot the"fileURLPath". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
Properties
enable
"enable": boolean
Discussion
Enable or disable saving speech synthesis into a file. The value can be set at runtime using the "enableRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
enableRuntime
"enableRuntime": 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 "enable" property. Example: "$[Enable]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
fileBaseName
"fileBaseName": string
Discussion
File base name. ".wav" or ".caf" is appended. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
fileURLPath
"fileURLPath": string
Discussion
Folder path where the synthesized audio file is saved. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
filetype
"filetype": string
Discussion
Type of audio file to contain the synthesized audip. options are "wav" and "caf". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
languageCode
"languageCode": string
Discussion
If specified that "languageCode" will be appended ot the "fileURLPath". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
offlineMode
"offlineMode": boolean
Discussion
If true, then audio playback will not occur on a device. Only speech synthesis is saved into a file. The value can be set at runtime using the "offlineModeRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
offlineModeRuntime
"offlineModeRuntime": 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 "offlineMode" property. Example: "$[OfflineMode]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json