Inheritance diagram for homeassistant.components.tts.legacy.Provider:

[legend]

Public Member Functions
list[Voice]\|None	async_get_supported_voices (self, str language)

TtsAudioType	async_get_tts_audio (self, str message, str language, dict[str, Any] options)

str\|None	default_language (self)

Mapping[str, Any]\|None	default_options (self)

TtsAudioType	get_tts_audio (self, str message, str language, dict[str, Any] options)

list[str]	supported_languages (self)

list[str]\|None	supported_options (self)

Static Public Attributes
	None

Detailed Description

Represent a single TTS provider.

Definition at line 206 of file legacy.py.

Member Function Documentation

◆ async_get_supported_voices()

list[Voice] \| None homeassistant.components.tts.legacy.Provider.async_get_supported_voices	(		self,
		str	language
	)

Return a list of supported voices for a language.

Definition at line 228 of file legacy.py.

◆ async_get_tts_audio()

TtsAudioType homeassistant.components.tts.legacy.Provider.async_get_tts_audio	(		self,
		str	message,
		str	language,
		dict[str, Any]	options
	)

Load tts audio file from provider.

Return a tuple of file extension and data as bytes.

Definition at line 243 of file legacy.py.

◆ default_language()

str | None homeassistant.components.tts.legacy.Provider.default_language ( self )

Return the default language.

Reimplemented in homeassistant.components.yandextts.tts.YandexSpeechKitProvider, homeassistant.components.watson_tts.tts.WatsonTTSProvider, and homeassistant.components.voicerss.tts.VoiceRSSProvider.

Definition at line 213 of file legacy.py.

◆ default_options()

Mapping[str, Any] | None homeassistant.components.tts.legacy.Provider.default_options ( self )

Return a mapping with the default options.

Reimplemented in homeassistant.components.watson_tts.tts.WatsonTTSProvider.

Definition at line 233 of file legacy.py.

◆ get_tts_audio()

TtsAudioType homeassistant.components.tts.legacy.Provider.get_tts_audio	(		self,
		str	message,
		str	language,
		dict[str, Any]	options
	)

Load tts audio file from provider.

Definition at line 237 of file legacy.py.

◆ supported_languages()

list[str] homeassistant.components.tts.legacy.Provider.supported_languages ( self )

Return a list of supported languages.

Reimplemented in homeassistant.components.yandextts.tts.YandexSpeechKitProvider, homeassistant.components.watson_tts.tts.WatsonTTSProvider, and homeassistant.components.voicerss.tts.VoiceRSSProvider.

Definition at line 219 of file legacy.py.

◆ supported_options()

list[str] | None homeassistant.components.tts.legacy.Provider.supported_options ( self )

Return a list of supported options like voice, emotions.

Reimplemented in homeassistant.components.yandextts.tts.YandexSpeechKitProvider, and homeassistant.components.watson_tts.tts.WatsonTTSProvider.

Definition at line 223 of file legacy.py.

Member Data Documentation

◆ None

homeassistant.components.tts.legacy.Provider.None

static

Definition at line 209 of file legacy.py.

The documentation for this class was generated from the following file:

core/homeassistant/components/tts/legacy.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes