SS Engine Params JSON Reference
| Declared in | AudioPromptModuleList.schema.json |
Overview
Specifies the Speech Synthesizer parameters.
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
-
ssVoiceParamspropertySpecifies the parameters of the voice used for Speech Synthesis.
Parameter is optional.
-
volumepropertySpecifies volume of synthesized audio. Values: minimum value > 0.0. Default: 1.0. The value can be set at runtime using the
"volumeRuntime"property.Parameter is optional.
-
volumeRuntimepropertyContains 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.
-
inStreamModeproperty(Flite only) Specifies whether to stream synthesized audio blocks for audio playback in small packets to simulate real-time audio streaming. If false, audio blocks generated by a speech synthesizer are sent as whole to audio playback. Default:
"false". The value can be set at runtime using the"inStreamModeRuntime"property.Parameter is optional.
-
inStreamModeRuntimeproperty(Flite only) 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"inStreamMode"property. Example:"$[InStreamMode]".Parameter is optional.
-
startPlayFileTextPosBytesproperty(Flite only) Specifies the position in text in bytes where to start speech synthesis for audio playback. Default: 0. The value can be set at runtime using the
"startPlayFileTextPosBytesRuntime"property.Parameter is optional.
-
startPlayFileTextPosBytesRuntimeproperty(Flite only) 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"startPlayFileTextPosBytes"property. Example:"$[StartPlayFileTextPosBytes]".Parameter is optional.
-
durationStretchproperty(Flite only) Specifies duration stretch for synthesized audio. Default: 1.0. The value can be set at runtime using the
"durationStretchRuntime"property.Parameter is optional.
-
durationStretchRuntimeproperty(Flite only) 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"durationStretch"property. Example:"$[DurationStretch]".Parameter is optional.
-
targetMeanproperty(Flite only) Specifies target mean for synthesized audio. Default: 1.0. The value can be set at runtime using the
"targetMeanRuntime"property.Parameter is optional.
-
targetMeanRuntimeproperty(Flite only) 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"targetMean"property. Example:"$[TargetMean]".Parameter is optional.
-
targetStandardDeviationproperty(Flite only) Specifies target standard deviation for synthesized audio. Default: 1.0. The value can be set at runtime using the
"targetStandardDeviationRuntime"property.Parameter is optional.
-
targetStandardDeviationRuntimeproperty(Flite only) 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"targetStandardDeviation"property. Example:"$[TargetStandardDeviation]".Parameter is optional.
-
pitchMultiplierproperty(Apple only) Specifies pitch multiplier for synthesized audio. Default: 1.0. The value can be set at runtime using the
"pitchMultiplierRuntime"property.Parameter is optional.
-
pitchMultiplierRuntimeproperty(Apple only) 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"pitchMultiplier"property. Example:"$[PitchMultiplier]".Parameter is optional.
-
preUtteranceDelaySecproperty(Apple only) Specifies pre utterance delay in seconds to be inserted at start of synthesized audio. Default: 0. The value can be set at runtime using the
"preUtteranceDelaySecRuntime"property.Parameter is optional.
-
preUtteranceDelaySecRuntimeproperty(Apple only) 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"preUtteranceDelaySec"property. Example:"$[PreUtteranceDelaySec]".Parameter is optional.
-
postUtteranceDelaySecproperty(Apple only) Specifies post utterance delay in seconds to be inserted at end of synthesized audio. Default: 0. The value can be set at runtime using the
"postUtteranceDelaySecRuntime"property.Parameter is optional.
-
postUtteranceDelaySecRuntimeproperty(Apple only) 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"postUtteranceDelaySec"property. Example:"$[PostUtteranceDelaySec]".Parameter is optional.
-
rateproperty(Apple only) Specifies the speaking rate of synthesized audio. Default: 0.5. The value can be set at runtime using the
"rateRuntime"property.Parameter is optional.
-
rateRuntimeproperty(Apple only) 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:"$[Rate]".Parameter is optional.
Properties
durationStretch
"durationStretch": number
Discussion
(Flite only) Specifies duration stretch for synthesized audio. Default: 1.0. The value can be set at runtime using the "durationStretchRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
durationStretchRuntime
"durationStretchRuntime": string
Discussion
(Flite only) 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 "durationStretch" property. Example: "$[DurationStretch]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
inStreamMode
"inStreamMode": boolean
Discussion
(Flite only) Specifies whether to stream synthesized audio blocks for audio playback in small packets to simulate real-time audio streaming. If false, audio blocks generated by a speech synthesizer are sent as whole to audio playback. Default: "false". The value can be set at runtime using the "inStreamModeRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
inStreamModeRuntime
"inStreamModeRuntime": string
Discussion
(Flite only) 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 "inStreamMode" property. Example: "$[InStreamMode]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
pitchMultiplier
"pitchMultiplier": number
Discussion
(Apple only) Specifies pitch multiplier for synthesized audio. Default: 1.0. The value can be set at runtime using the "pitchMultiplierRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
pitchMultiplierRuntime
"pitchMultiplierRuntime": string
Discussion
(Apple only) 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 "pitchMultiplier" property. Example: "$[PitchMultiplier]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
postUtteranceDelaySec
"postUtteranceDelaySec": integer
Discussion
(Apple only) Specifies post utterance delay in seconds to be inserted at end of synthesized audio. Default: 0. The value can be set at runtime using the "postUtteranceDelaySecRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
postUtteranceDelaySecRuntime
"postUtteranceDelaySecRuntime": string
Discussion
(Apple only) 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 "postUtteranceDelaySec" property. Example: "$[PostUtteranceDelaySec]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
preUtteranceDelaySec
"preUtteranceDelaySec": integer
Discussion
(Apple only) Specifies pre utterance delay in seconds to be inserted at start of synthesized audio. Default: 0. The value can be set at runtime using the "preUtteranceDelaySecRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
preUtteranceDelaySecRuntime
"preUtteranceDelaySecRuntime": string
Discussion
(Apple only) 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 "preUtteranceDelaySec" property. Example: "$[PreUtteranceDelaySec]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
rate
"rate": number
Discussion
(Apple only) Specifies the speaking rate of synthesized audio. Default: 0.5. The value can be set at runtime using the "rateRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
rateRuntime
"rateRuntime": string
Discussion
(Apple only) 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: "$[Rate]".
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
startPlayFileTextPosBytes
"startPlayFileTextPosBytes": integer
Discussion
(Flite only) Specifies the position in text in bytes where to start speech synthesis for audio playback. Default: 0. The value can be set at runtime using the "startPlayFileTextPosBytesRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
startPlayFileTextPosBytesRuntime
"startPlayFileTextPosBytesRuntime": string
Discussion
(Flite only) 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 "startPlayFileTextPosBytes" property. Example: "$[StartPlayFileTextPosBytes]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
targetMean
"targetMean": number
Discussion
(Flite only) Specifies target mean for synthesized audio. Default: 1.0. The value can be set at runtime using the "targetMeanRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
targetMeanRuntime
"targetMeanRuntime": string
Discussion
(Flite only) 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 "targetMean" property. Example: "$[TargetMean]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
targetStandardDeviation
"targetStandardDeviation": number
Discussion
(Flite only) Specifies target standard deviation for synthesized audio. Default: 1.0. The value can be set at runtime using the "targetStandardDeviationRuntime" property.
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
targetStandardDeviationRuntime
"targetStandardDeviationRuntime": string
Discussion
(Flite only) 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 "targetStandardDeviation" property. Example: "$[TargetStandardDeviation]".
Parameter is optional.
Declared In
AudioPromptModuleList.schema.json
volume
"volume": number
Discussion
Specifies volume of synthesized audio. Values: minimum value > 0.0. Default: 1.0. The value can be set at runtime using the "volumeRuntime" property.
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