Inheritance diagram for homeassistant.components.tts.TextToSpeechEntity:

Collaboration diagram for homeassistant.components.tts.TextToSpeechEntity:

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)

None	async_internal_added_to_hass (self)

None	async_speak (self, list[str] media_player_entity_id, str message, bool cache, str\|None language=None, dict\|None options=None)

str	default_language (self)

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

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

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

str\|None	state (self)

list[str]	supported_languages (self)

list[str]\|None	supported_options (self)

Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData\|None	async_get_last_extra_data (self)

State\|None	async_get_last_state (self)

None	async_internal_will_remove_from_hass (self)

ExtraStoredData\|None	extra_restore_state_data (self)

Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)

str	__repr__ (self)

None	add_to_platform_abort (self)

None	add_to_platform_finish (self)

None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore\|None parallel_updates)

bool	assumed_state (self)

None	async_added_to_hass (self)

None	async_device_update (self, bool warning=True)

None	async_on_remove (self, CALLBACK_TYPE func)

None	async_registry_entry_updated (self)

None	async_remove (self, *bool force_remove=False)

None	async_removed_from_registry (self)

None	async_schedule_update_ha_state (self, bool force_refresh=False)

None	async_set_context (self, Context context)

None	async_update_ha_state (self, bool force_refresh=False)

None	async_will_remove_from_hass (self)

None	async_write_ha_state (self)

str\|None	attribution (self)

bool	available (self)

dict[str, Any]\|None	capability_attributes (self)

str\|None	device_class (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (self)

str\|None	entity_picture (self)

bool	entity_registry_enabled_default (self)

bool	entity_registry_visible_default (self)

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

bool	force_update (self)

HassJobType	get_hassjob_type (self, str function_name)

er.EntityOptionsType\|None	get_initial_entity_options (self)

bool	has_entity_name (self)

str\|None	icon (self)

str\|UndefinedType\|None	name (self)

None	schedule_update_ha_state (self, bool force_refresh=False)

bool	should_poll (self)

dict[str, Any]\|None	state_attributes (self)

str\|None	suggested_object_id (self)

int\|None	supported_features (self)

str\|None	translation_key (self)

Mapping[str, str]	translation_placeholders (self)

str\|None	unique_id (self)

str\|None	unit_of_measurement (self)

bool	use_device_name (self)

Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)

Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]\|None cached_properties=None, **Any kwargs)

Static Public Attributes
	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Attributes
	__last_tts_loaded

Static Private Attributes
bool	_attr_should_poll = False

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Represent a single TTS engine.

Definition at line 386 of file __init__.py.

Member Function Documentation

◆ async_get_supported_voices()

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

Return a list of supported voices for a language.

Reimplemented in homeassistant.components.wyoming.tts.WyomingTtsProvider, homeassistant.components.elevenlabs.tts.ElevenLabsTTSEntity, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 426 of file __init__.py.

◆ async_get_tts_audio()

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

Load tts audio file from the engine.

Return a tuple of file extension and data as bytes.

Reimplemented in homeassistant.components.google_cloud.tts.GoogleCloudTTSEntity, homeassistant.components.elevenlabs.tts.ElevenLabsTTSEntity, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 502 of file __init__.py.

◆ async_internal_added_to_hass()

None homeassistant.components.tts.TextToSpeechEntity.async_internal_added_to_hass ( self )

Call when the entity is added to hass.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 430 of file __init__.py.

◆ async_speak()

None homeassistant.components.tts.TextToSpeechEntity.async_speak	(		self,
		list[str]	media_player_entity_id,
		str	message,
		bool	cache,
		str \| None	language = `None`,
		dict \| None	options = `None`
	)

Speak via a Media Player.

Definition at line 453 of file __init__.py.

◆ default_language()

str homeassistant.components.tts.TextToSpeechEntity.default_language ( self )

Return the default language.

Reimplemented in homeassistant.components.wyoming.tts.WyomingTtsProvider, homeassistant.components.google_translate.tts.GoogleTTSEntity, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 411 of file __init__.py.

◆ default_options()

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

Return a mapping with the default options.

Reimplemented in homeassistant.components.wyoming.tts.WyomingTtsProvider, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 421 of file __init__.py.

◆ get_tts_audio()

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

Load tts audio file from the engine.

Definition at line 496 of file __init__.py.

◆ internal_async_get_tts_audio()

TtsAudioType homeassistant.components.tts.TextToSpeechEntity.internal_async_get_tts_audio	(		self,
		str	message,
		str	language,
		dict[str, Any]	options
	)

Process an audio stream to TTS service.

Only streaming content is allowed!

Definition at line 483 of file __init__.py.

◆ state()

str | None homeassistant.components.tts.TextToSpeechEntity.state ( self )

Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 399 of file __init__.py.

◆ supported_languages()

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

Return a list of supported languages.

Reimplemented in homeassistant.components.wyoming.tts.WyomingTtsProvider, homeassistant.components.google_translate.tts.GoogleTTSEntity, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 406 of file __init__.py.

◆ supported_options()

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

Return a list of supported options like voice, emotions.

Reimplemented in homeassistant.components.wyoming.tts.WyomingTtsProvider, homeassistant.components.google_translate.tts.GoogleTTSEntity, and homeassistant.components.cloud.tts.CloudTTSEntity.

Definition at line 416 of file __init__.py.

Member Data Documentation

◆ __last_tts_loaded

homeassistant.components.tts.TextToSpeechEntity.__last_tts_loaded

private

Definition at line 451 of file __init__.py.

◆ _attr_should_poll

bool homeassistant.components.tts.TextToSpeechEntity._attr_should_poll = False

staticprivate

Definition at line 389 of file __init__.py.

◆ None

homeassistant.components.tts.TextToSpeechEntity.None

static

Definition at line 390 of file __init__.py.

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

core/homeassistant/components/tts/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ async_get_supported_voices()

◆ async_get_tts_audio()

◆ async_internal_added_to_hass()

◆ async_speak()

◆ default_language()

◆ default_options()

◆ get_tts_audio()

◆ internal_async_get_tts_audio()

◆ state()

◆ supported_languages()

◆ supported_options()

Member Data Documentation

◆ __last_tts_loaded

◆ _attr_should_poll

◆ None