Configuration Reference

Speech Synthesis Aliases

JSON property speechSynthesisAliases

JSON type object

Used in Configure Parameters

Defines text substitutions used for speech synthesis.

Behavior and notes

Inline mappings and an external file may be used together. External files use one mapping per line; lines beginning with # are comments.

Properties

Jump to a property:

enabled · aliases · fileName · resourceLocation

`enabled`

booleanOptional

Enables or disables these mappings.

Runtime fields: Supported — The complete property value may be supplied using $[FieldName].

`aliases`

stringOptional

Inline mappings separated by |. Each mapping uses source: replacement notation.

Runtime fields: Supported — The complete property value may be supplied using $[FieldName].

`fileName`

stringOptional

Name of an external mapping file.

Runtime fields: Supported — The complete property value may be supplied using $[FieldName].

`resourceLocation`

stringOptional

Resource location containing the external mapping file.

Runtime fields: Supported — The complete property value may be supplied using $[FieldName].

Examples

Inline aliases in Configure Parameters

{
  "configureParams": {
    "speechSynthesisAliases": {
      "enabled": true,
      "aliases": "Versailles: Ver-sigh | Edinburgh: Edin-burra"
    }
  }
}

Each source: replacement pair supplies ordinary replacement text for speech synthesis. Separate multiple inline pairs with |. These are illustrative pronunciations, not phonetic transcriptions.

External alias file

# Pronunciation aliases
Versailles: Ver-sigh
Edinburgh: Edin-burra

An external file contains one mapping per line; lines beginning with # are comments. Set fileName and resourceLocation to identify the file. Inline and file-based mappings can be used together; no precedence between conflicting entries is specified here.

Individual properties support runtime-field substitution, such as "aliases": "$[AliasMappings]"; the containing object is not substituted wholesale.