Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.cloud.tts.CloudProvider Class Reference
Inheritance diagram for homeassistant.components.cloud.tts.CloudProvider:
[legend]
Collaboration diagram for homeassistant.components.cloud.tts.CloudProvider:
[legend]

Public Member Functions

None __init__ (self, Cloud[CloudClient] cloud)
 
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)
 
dict[str, Any] default_options (self)
 
list[str] supported_languages (self)
 
list[str] supported_options (self)
 

Public Attributes

 cloud
 
 name
 

Private Member Functions

None _sync_prefs (self, CloudPreferences prefs)
 

Private Attributes

 _voice
 

Detailed Description

Home Assistant Cloud speech API provider.

Definition at line 218 of file tts.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.cloud.tts.CloudProvider.__init__ (   self,
Cloud[CloudClient cloud 
)
Initialize cloud provider.

Definition at line 221 of file tts.py.

Member Function Documentation

◆ _sync_prefs()

None homeassistant.components.cloud.tts.CloudProvider._sync_prefs (   self,
CloudPreferences  prefs 
)
private
Sync preferences.

Definition at line 228 of file tts.py.

◆ async_get_supported_voices()

list[Voice] | None homeassistant.components.cloud.tts.CloudProvider.async_get_supported_voices (   self,
str  language 
)
Return a list of supported voices for a language.

Definition at line 249 of file tts.py.

◆ async_get_tts_audio()

TtsAudioType homeassistant.components.cloud.tts.CloudProvider.async_get_tts_audio (   self,
str  message,
str  language,
dict[str, Any]   options 
)
Load TTS from Home Assistant Cloud.

Definition at line 262 of file tts.py.

◆ default_language()

str | None homeassistant.components.cloud.tts.CloudProvider.default_language (   self)
Return the default language.

Definition at line 233 of file tts.py.

◆ default_options()

dict[str, Any] homeassistant.components.cloud.tts.CloudProvider.default_options (   self)
Return a dict include default options.

Definition at line 256 of file tts.py.

◆ supported_languages()

list[str] homeassistant.components.cloud.tts.CloudProvider.supported_languages (   self)
Return list of supported languages.

Definition at line 238 of file tts.py.

◆ supported_options()

list[str] homeassistant.components.cloud.tts.CloudProvider.supported_options (   self)
Return list of supported options like voice, emotion.

Definition at line 243 of file tts.py.

Member Data Documentation

◆ _voice

homeassistant.components.cloud.tts.CloudProvider._voice
private

Definition at line 225 of file tts.py.

◆ cloud

homeassistant.components.cloud.tts.CloudProvider.cloud

Definition at line 223 of file tts.py.

◆ name

homeassistant.components.cloud.tts.CloudProvider.name

Definition at line 224 of file tts.py.


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