Declared in AudioPromptModuleList.schema.json

Overview

Specifies the parameters of the voice used for Speech Synthesis.

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

  •   identifier

    The voice identifier. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   name

    The voice name. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   gender

    The voice gender. Options are: "male", "female" and "unknown". Default value is "unknown". All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   quality

    The voice quality. Options are: "default", "enhanced", "premium", "unspecified", and "unknown". Default value is "unknown". All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   language

    The voice language. Example: "en-US" for US english. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter

JSON Parameters

identifier

"identifier": string

Discussion

The voice identifier. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

gender

"gender": string

Discussion

The voice gender. Options are: "male", "female" and "unknown". Default value is "unknown". All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

language

"language": string

Discussion

The voice language. Example: "en-US" for US english. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

name

"name": string

Discussion

The voice name. All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

quality

"quality": string

Discussion

The voice quality. Options are: "default", "enhanced", "premium", "unspecified", and "unknown". Default value is "unknown". All supported speech synthesis voices with their parameters can be extracted from STVoiceFlow framewok via STVoiceFlow and STMedia SDKs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json