Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
homeassistant.components.stt.SpeechToTextView Class Reference
Inheritance diagram for homeassistant.components.stt.SpeechToTextView:
[legend]
Collaboration diagram for homeassistant.components.stt.SpeechToTextView:
[legend]

Public Member Functions

None __init__ (self, dict[str, Provider] providers)
 
web.Response get (self, web.Request request, str provider)
 
web.Response post (self, web.Request request, str provider)
 

Public Attributes

 providers
 

Static Public Attributes

string name = "api:stt:provider"
 
bool requires_auth = True
 
string url = "/api/stt/{provider}"
 

Private Member Functions

Provider _get_provider (self, HomeAssistant hass, str provider)
 
str _suggest_report_issue (self, HomeAssistant hass, str provider, object provider_instance)
 

Private Attributes

 _legacy_provider_reported
 

Static Private Attributes

bool _legacy_provider_reported = False
 

Detailed Description

STT view to generate a text from audio stream.

Definition at line 247 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.stt.SpeechToTextView.__init__ (   self,
dict[str, Provider]  providers 
) 
Initialize a tts view.

Definition at line 255 of file __init__.py.

Member Function Documentation

◆ _get_provider()

Provider homeassistant.components.stt.SpeechToTextView._get_provider (   self,
HomeAssistant  hass,
str  provider 
)
private 
Get provider.

Method for legacy providers.
This can be removed when we remove the legacy provider support.

Definition at line 333 of file __init__.py.

◆ _suggest_report_issue()

str homeassistant.components.stt.SpeechToTextView._suggest_report_issue (   self,
HomeAssistant  hass,
str  provider,
object   provider_instance 
)
private 
Suggest to report an issue.

Definition at line 356 of file __init__.py.

◆ get()

web.Response homeassistant.components.stt.SpeechToTextView.get (   self,
web.Request  request,
str  provider 
) 
Return provider specific audio information.

Definition at line 299 of file __init__.py.

◆ post()

web.Response homeassistant.components.stt.SpeechToTextView.post (   self,
web.Request  request,
str  provider 
) 
Convert Speech (audio) to text.

Definition at line 259 of file __init__.py.

Member Data Documentation

◆ _legacy_provider_reported [1/2]

bool homeassistant.components.stt.SpeechToTextView._legacy_provider_reported = False
staticprivate

Definition at line 250 of file __init__.py.

◆ _legacy_provider_reported [2/2]

homeassistant.components.stt.SpeechToTextView._legacy_provider_reported
private

Definition at line 342 of file __init__.py.

◆ name

string homeassistant.components.stt.SpeechToTextView.name = "api:stt:provider"
static

Definition at line 253 of file __init__.py.

◆ providers

homeassistant.components.stt.SpeechToTextView.providers

Definition at line 257 of file __init__.py.

◆ requires_auth

bool homeassistant.components.stt.SpeechToTextView.requires_auth = True
static

Definition at line 251 of file __init__.py.

◆ url

string homeassistant.components.stt.SpeechToTextView.url = "/api/stt/{provider}"
static

Definition at line 252 of file __init__.py.

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