Declared in Voiceflow.schema.json

Overview

Specifies custom aliases assigned to replace particular words during speech synthesis for more accurate speech synthesis results.

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

  •   loadSSAliases

    Specifies whether to have the speech synthesizer load the aliases for more accurate speech syntehsis of the vocabulary or words replaced by the aliases. Default: "false". The value can be set at runtime using the "loadSSAliasesRuntime" property.

    Parameter is optional.

           json parameter
  •   loadSSAliasesRuntime

    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 "loadSSAliases" property. Example: "$[LoadSSAliases]".

    Parameter is optional.

           json parameter
  •   ssAliasList

    A string containing all words to alias entries delimited by "|".

    Aliases example entries: "ssAliases": { "loadSSAliases": true, "ssAliasList": "Versailles: Ver-sigh | Edinburgh: Edin-burra" }

    Parameter is optional.

           json parameter
  •   ssAliasFileName

    Specifies the file name that contains a list of all words and their respective aliases. The value can be set at runtime using "$[<FieldName>]" entry convention.
    The entries in the aliases file should confirm to the following entry style:

    #Goethe: Gurta
Charlotte: Sharlot
Worcester: Wooster
Colonel: Kernel
Arkansas: Ar-kan-saw

    Parameter is optional.

           json parameter
  •   ssAliasFileLocation

    Specifies the location path of the file containing the list of words and their aliases. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter

JSON Parameters

loadSSAliases

"loadSSAliases": boolean

Discussion

Specifies whether to have the speech synthesizer load the aliases for more accurate speech syntehsis of the vocabulary or words replaced by the aliases. Default: "false". The value can be set at runtime using the "loadSSAliasesRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

loadSSAliasesRuntime

"loadSSAliasesRuntime": 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 "loadSSAliases" property. Example: "$[LoadSSAliases]".

Parameter is optional.

Declared In

Voiceflow.schema.json

ssAliasFileLocation

"ssAliasFileLocation": string

Discussion

Specifies the location path of the file containing the list of words and their aliases. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

ssAliasFileName

"ssAliasFileName": string

Discussion

Specifies the file name that contains a list of all words and their respective aliases. The value can be set at runtime using "$[<FieldName>]" entry convention.
The entries in the aliases file should confirm to the following entry style:

#Goethe: Gurta
Charlotte: Sharlot
Worcester: Wooster
Colonel: Kernel
Arkansas: Ar-kan-saw

Parameter is optional.

Declared In

Voiceflow.schema.json

ssAliasList

"ssAliasList": string

Discussion

A string containing all words to alias entries delimited by "|".

Aliases example entries: "ssAliases": { "loadSSAliases": true, "ssAliasList": "Versailles: Ver-sigh | Edinburgh: Edin-burra" }

Parameter is optional.

Declared In

Voiceflow.schema.json