Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.demo.stt.DemoProviderEntity Class Reference
Inheritance diagram for homeassistant.components.demo.stt.DemoProviderEntity:
[legend]
Collaboration diagram for homeassistant.components.demo.stt.DemoProviderEntity:
[legend]

Public Member Functions

SpeechResult async_process_audio_stream (self, SpeechMetadata metadata, AsyncIterable[bytes] stream)
 
list[AudioBitRates] supported_bit_rates (self)
 
list[AudioChannels] supported_channels (self)
 
list[AudioCodecs] supported_codecs (self)
 
list[AudioFormats] supported_formats (self)
 
list[strsupported_languages (self)
 
list[AudioSampleRates] supported_sample_rates (self)
 
- Public Member Functions inherited from homeassistant.components.stt.SpeechToTextEntity
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)
 
- 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, strtranslation_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 Private Attributes

string _attr_name = "Demo STT"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.stt.SpeechToTextEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Demo speech API provider entity.

Definition at line 34 of file stt.py.

Member Function Documentation

◆ async_process_audio_stream()

SpeechResult homeassistant.components.demo.stt.DemoProviderEntity.async_process_audio_stream (   self,
SpeechMetadata  metadata,
AsyncIterable[bytes]   stream 
)
Process an audio stream to STT service.

Definition at line 69 of file stt.py.

◆ supported_bit_rates()

list[AudioBitRates] homeassistant.components.demo.stt.DemoProviderEntity.supported_bit_rates (   self)
Return a list of supported bit rates.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 55 of file stt.py.

◆ supported_channels()

list[AudioChannels] homeassistant.components.demo.stt.DemoProviderEntity.supported_channels (   self)
Return a list of supported channels.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 65 of file stt.py.

◆ supported_codecs()

list[AudioCodecs] homeassistant.components.demo.stt.DemoProviderEntity.supported_codecs (   self)
Return a list of supported codecs.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 50 of file stt.py.

◆ supported_formats()

list[AudioFormats] homeassistant.components.demo.stt.DemoProviderEntity.supported_formats (   self)
Return a list of supported formats.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 45 of file stt.py.

◆ supported_languages()

list[str] homeassistant.components.demo.stt.DemoProviderEntity.supported_languages (   self)
Return a list of supported languages.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 40 of file stt.py.

◆ supported_sample_rates()

list[AudioSampleRates] homeassistant.components.demo.stt.DemoProviderEntity.supported_sample_rates (   self)
Return a list of supported sample rates.

Reimplemented from homeassistant.components.stt.SpeechToTextEntity.

Definition at line 60 of file stt.py.

Member Data Documentation

◆ _attr_name

string homeassistant.components.demo.stt.DemoProviderEntity._attr_name = "Demo STT"
staticprivate

Definition at line 37 of file stt.py.


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