View Source ExAzureSpeech.TextToSpeech.SpeechSynthesisConfig (ex_azure_speech v0.2.2)

Configures the Text-to-Speech Synthesis context.

Summary

Types

t()
  • :audio (keyword/0) - The default value is [].

Functions

Returns a valid configuration for the Text-to-Speech context.

Types

@type t() :: [audio: keyword(), language: keyword()]
  • :audio (keyword/0) - The default value is [].

    • :metadata_options (keyword/0) - The default value is [].

      • :bookmark_enabled (boolean/0) - The default value is false.

      • :punctuation_boundary_enabled (boolean/0) - Specifies whether punctuation boundary data should be included in the output. The default value is true.

      • :sentence_boundary_enabled (boolean/0) - Specifies whether sentence boundary data should be included in the output. The default value is true.

      • :word_boundary_enabled (boolean/0) - Specifies whether word boundary data should be included in the output. The default value is false.

      • :session_end_enabled (boolean/0) - Specifies whether session end data should be included in the output. The default value is false.

      • :viseme_enabled (boolean/0) - Specifies whether viseme data should be included in the output. The default value is false.

    • :output_format (ExAzureSpeech.Common.OutputFormats.t()) - Specifies the output format for the audio. The default value is "riff-24khz-16bit-mono-pcm".

  • :language (keyword/0) - The default value is [].

    • :auto_detection (boolean/0) - Specifies whether the language should be automatically detected. The default value is false.

Example Configuration

[
  audio: [
    metadata_options: [
      bookmark_enabled: false,
      punctuation_boundary_enabled: true,
      sentence_boundary_enabled: true,
      word_boundary_enabled: false,
      session_end_enabled: false,
      viseme_enabled: false
    ],
    output_format: "riff-24khz-16bit-mono-pcm"
  ],
  language: [
    auto_detection: false
  ]
]

Functions

@spec new(Keyword.t()) :: {:ok, t()} | {:error, NimbleOptions.ValidationError.t()}

Returns a valid configuration for the Text-to-Speech context.