$dialer.getTtsConfig

This method returns the TTS provider settings of the phone channel used for the current call.

Syntax

The method is called without arguments:

$dialer.getTtsConfig();

The method returns a settings object. The properties of this object are different based on the provider. If the provider supports no additional settings, the method returns an empty object {}.

tip

All settings returned by the method can be overridden for the current call using the $dialer.setTtsConfig method.

Provider settings

Google

• lang

  • Synthesized speech language.

• voice

  • Speech synthesis language.
  tip

  See the complete list of languages and voices for synthesis in the Google documentation.

• pitch

  • Voice pitch. Takes an integer or float value from -20 to 20, where -20 means a 20-halftone decrease from the original tone, and 20 means the same increase.

• speakingRate

  • Synthesized speech rate. Takes an integer or float value from 0.25 to 4, where 1 is the normal voice speed.

• volumeGain

  • Volume increase in dB relative to the normal voice volume. Takes an integer or float value from -96 to 16. When set to 6, the volume is approximately twice as high as normal.

Yandex

• lang

  • Synthesized speech language.

• voice

  • Speech synthesis language.

• emotion

  • Voice mode or emotional tone.
  tip

  See the complete list of languages, voices, and modes in the Yandex documentation.

• speed

  • Synthesized speech rate. Takes an integer or float value from 0.1 to 3, where 1 is the normal voice speed.

• useV3

  • If the setting is enabled, the third version of the Yandex SpeechKit protocol is used for speech synthesis. Contact your account manager if you want to enable this setting.

The following settings are available only when useV3 is enabled:

• volume
  • Synthesized speech loudness relative to full scale (LUFS). Takes an integer or float value from -145 to 0. The recommended value range is from −20 to −16 LUFS.
• useVariables
  • If the setting is enabled, speech synthesis is done via Yandex SpeechKit Brand Voice Adaptive, which supports variables.

Azure

• language

  • Synthesized speech language.

• voiceName

  • Speech synthesis language.
  tip

  See the complete list of languages and voices for synthesis in the Azure documentation.

• sampleRate

  • Sample rate.

Aimyvoice

• voice
  • Speech synthesis language.

3iTech

• model
  • Speech synthesis language model.
• sampleRate
  • Sample rate.
• speed
  • Synthesized speech rate.
• tone
  • Voice tone.