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.

Tasks

  •   id

    ID of the voice, if known. Apple Example: "com.apple.ttsbundle.Samantha-compact". Flite example: "slt-hts". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

      property
  •   name

    Name of the voice, if known. Apple Example: "Samantha". Flite example: "slt-hts". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

      property
  •   gender

    Gender of the voice. Values: "male" or "female". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

      property
  •   quality

    Voice quality. Values: "compact", "enhanced", "premium" or an empty string. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

      property
  •   languageCode

    Language locale of the voice. Example: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

      property

Properties

gender

"gender": string

Discussion

Gender of the voice. Values: "male" or "female". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

id

"id": string

Discussion

ID of the voice, if known. Apple Example: "com.apple.ttsbundle.Samantha-compact". Flite example: "slt-hts". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

languageCode

"languageCode": string

Discussion

Language locale of the voice. Example: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

name

"name": string

Discussion

Name of the voice, if known. Apple Example: "Samantha". Flite example: "slt-hts". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json

quality

"quality": string

Discussion

Voice quality. Values: "compact", "enhanced", "premium" or an empty string. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

AudioPromptModuleList.schema.json