Declared in Voiceflow.schema.json

Overview

Specifies custom ipa phonemes 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

  •   loadSSPhonemes

    Specifies whether to have the speech synthesizer load the ipa phonemes 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 "loadSSPhonemesRuntime" property.

    Parameter is optional.

           json parameter
  •   loadSSPhonemesRuntime

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

    Parameter is optional.

           json parameter
  •   ssPhonemeList

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

    Aliases example entries: "ssPhonemes": { "loadSSPhonemes": true, "ssPhonemeList": "Beijing: beɪˈʒɪŋ | Goethe: ˈɡɜːtə" }

    Parameter is optional.

           json parameter
  •   ssPhonemeFileName

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

    Xavier: ˈzeɪ.vi.ər
José: xoˈse
Nguyen: wɪn
Siobhan: ʃəˈvɔːn
Joaquin: wɑːˈkiːn
Reykjavik: ˈreɪkjəvɪk
#Beijing: beɪˈʒɪŋ

    Parameter is optional.

           json parameter
  •   ssPhonemeFileLocation

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

    Parameter is optional.

           json parameter

JSON Parameters

loadSSPhonemes

"loadSSPhonemes": boolean

Discussion

Specifies whether to have the speech synthesizer load the ipa phonemes 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 "loadSSPhonemesRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

loadSSPhonemesRuntime

"loadSSPhonemesRuntime": 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 "loadSSPhonemes" property. Example: "$[LoadSSPhonemes]".

Parameter is optional.

Declared In

Voiceflow.schema.json

ssPhonemeFileLocation

"ssPhonemeFileLocation": string

Discussion

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

Parameter is optional.

Declared In

Voiceflow.schema.json

ssPhonemeFileName

"ssPhonemeFileName": string

Discussion

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

Xavier: ˈzeɪ.vi.ər
José: xoˈse
Nguyen: wɪn
Siobhan: ʃəˈvɔːn
Joaquin: wɑːˈkiːn
Reykjavik: ˈreɪkjəvɪk
#Beijing: beɪˈʒɪŋ

Parameter is optional.

Declared In

Voiceflow.schema.json

ssPhonemeList

"ssPhonemeList": string

Discussion

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

Aliases example entries: "ssPhonemes": { "loadSSPhonemes": true, "ssPhonemeList": "Beijing: beɪˈʒɪŋ | Goethe: ˈɡɜːtə" }

Parameter is optional.

Declared In

Voiceflow.schema.json