Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tts.media_source Namespace Reference

Classes

class  MediaSourceOptions
 
class  TTSMediaSource
 

Functions

TTSMediaSource async_get_media_source (HomeAssistant hass)
 
str generate_media_source_id (HomeAssistant hass, str message, str|None engine=None, str|None language=None, dict|None options=None, bool|None cache=None)
 
MediaSourceOptions media_source_id_to_kwargs (str media_source_id)
 

Variables

string URL_QUERY_TTS_OPTIONS = "tts_options"
 

Detailed Description

Text-to-speech media source.

Function Documentation

◆ async_get_media_source()

TTSMediaSource homeassistant.components.tts.media_source.async_get_media_source ( HomeAssistant  hass)
Set up tts media source.

Definition at line 29 of file media_source.py.

◆ generate_media_source_id()

str homeassistant.components.tts.media_source.generate_media_source_id ( HomeAssistant  hass,
str  message,
str | None   engine = None,
str | None   language = None,
dict | None   options = None,
bool | None   cache = None 
)
Generate a media source ID for text-to-speech.

Definition at line 35 of file media_source.py.

◆ media_source_id_to_kwargs()

MediaSourceOptions homeassistant.components.tts.media_source.media_source_id_to_kwargs ( str  media_source_id)
Turn a media source ID into options.

Definition at line 80 of file media_source.py.

Variable Documentation

◆ URL_QUERY_TTS_OPTIONS

string homeassistant.components.tts.media_source.URL_QUERY_TTS_OPTIONS = "tts_options"

Definition at line 26 of file media_source.py.