homeassistant.components.stt.SpeechToTextEntity Class Reference

Inheritance diagram for homeassistant.components.stt.SpeechToTextEntity:

Collaboration diagram for homeassistant.components.stt.SpeechToTextEntity:

Public Member Functions
None	async_internal_added_to_hass (self)
SpeechResult	async_process_audio_stream (self, SpeechMetadata metadata, AsyncIterable[bytes] stream)
bool	check_metadata (self, SpeechMetadata metadata)
SpeechResult	internal_async_process_audio_stream (self, SpeechMetadata metadata, AsyncIterable[bytes] stream)
str|None	state (self)
list[AudioBitRates]	supported_bit_rates (self)
list[AudioChannels]	supported_channels (self)
list[AudioCodecs]	supported_codecs (self)
list[AudioFormats]	supported_formats (self)
list[str]	supported_languages (self)
list[AudioSampleRates]	supported_sample_rates (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_processed

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 STT provider.

Definition at line 156 of file __init__.py.

Member Function Documentation

async_internal_added_to_hass()

None homeassistant.components.stt.SpeechToTextEntity.async_internal_added_to_hass

(

self

)

Call when the provider entity is added to hass.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 200 of file __init__.py.

async_process_audio_stream()

SpeechResult homeassistant.components.stt.SpeechToTextEntity.async_process_audio_stream	(		self,
		SpeechMetadata	metadata,
		AsyncIterable[bytes]	stream
	)

Process an audio stream to STT service.

Only streaming content is allowed!

Definition at line 224 of file __init__.py.

check_metadata()

bool homeassistant.components.stt.SpeechToTextEntity.check_metadata	(		self,
		SpeechMetadata	metadata
	)

Check if given metadata supported by this provider.

Definition at line 233 of file __init__.py.

internal_async_process_audio_stream()

SpeechResult homeassistant.components.stt.SpeechToTextEntity.internal_async_process_audio_stream	(		self,
		SpeechMetadata	metadata,
		AsyncIterable[bytes]	stream
	)

Process an audio stream to STT service.

Only streaming content is allowed!

Definition at line 212 of file __init__.py.

state()

str | None homeassistant.components.stt.SpeechToTextEntity.state

(

self

)

Return the state of the provider entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 164 of file __init__.py.

supported_bit_rates()

list[AudioBitRates] homeassistant.components.stt.SpeechToTextEntity.supported_bit_rates

(

self

)

Return a list of supported bit rates.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 187 of file __init__.py.

supported_channels()

list[AudioChannels] homeassistant.components.stt.SpeechToTextEntity.supported_channels

(

self

)

Return a list of supported channels.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 197 of file __init__.py.

supported_codecs()

list[AudioCodecs] homeassistant.components.stt.SpeechToTextEntity.supported_codecs

(

self

)

Return a list of supported codecs.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 182 of file __init__.py.

supported_formats()

list[AudioFormats] homeassistant.components.stt.SpeechToTextEntity.supported_formats

(

self

)

Return a list of supported formats.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 177 of file __init__.py.

supported_languages()

list[str] homeassistant.components.stt.SpeechToTextEntity.supported_languages

(

self

)

Return a list of supported languages.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 172 of file __init__.py.

supported_sample_rates()

list[AudioSampleRates] homeassistant.components.stt.SpeechToTextEntity.supported_sample_rates

(

self

)

Return a list of supported sample rates.

Reimplemented in homeassistant.components.wyoming.stt.WyomingSttProvider, homeassistant.components.google_cloud.stt.GoogleCloudSpeechToTextEntity, homeassistant.components.demo.stt.DemoProviderEntity, and homeassistant.components.cloud.stt.CloudProviderEntity.

Definition at line 192 of file __init__.py.

Member Data Documentation

__last_processed

homeassistant.components.stt.SpeechToTextEntity.__last_processed

private

Definition at line 209 of file __init__.py.

_attr_should_poll

bool homeassistant.components.stt.SpeechToTextEntity._attr_should_poll = False

staticprivate

Definition at line 159 of file __init__.py.

None

homeassistant.components.stt.SpeechToTextEntity.None

static

Definition at line 160 of file __init__.py.

---

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

• core/homeassistant/components/stt/__init__.py