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

Classes

class  VoiceRSSProvider
 

Functions

def async_get_engine (hass, config, discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_CODEC = "codec"
 
string CONF_FORMAT = "format"
 
string DEFAULT_CODEC = "mp3"
 
string DEFAULT_FORMAT = "8khz_8bit_mono"
 
string DEFAULT_LANG = "en-us"
 
list ERROR_MSG
 
 PLATFORM_SCHEMA
 
list SUPPORT_CODECS = ["mp3", "wav", "aac", "ogg", "caf"]
 
list SUPPORT_FORMATS
 
list SUPPORT_LANGUAGES
 
string VOICERSS_API_URL = "https://api.voicerss.org/"
 

Detailed Description

Support for the voicerss speech service.

Function Documentation

◆ async_get_engine()

def homeassistant.components.voicerss.tts.async_get_engine (   hass,
  config,
  discovery_info = None 
)
Set up VoiceRSS TTS component.

Definition at line 162 of file tts.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.voicerss.tts._LOGGER = logging.getLogger(__name__)
private

Definition at line 19 of file tts.py.

◆ CONF_CODEC

string homeassistant.components.voicerss.tts.CONF_CODEC = "codec"

Definition at line 144 of file tts.py.

◆ CONF_FORMAT

string homeassistant.components.voicerss.tts.CONF_FORMAT = "format"

Definition at line 145 of file tts.py.

◆ DEFAULT_CODEC

string homeassistant.components.voicerss.tts.DEFAULT_CODEC = "mp3"

Definition at line 148 of file tts.py.

◆ DEFAULT_FORMAT

string homeassistant.components.voicerss.tts.DEFAULT_FORMAT = "8khz_8bit_mono"

Definition at line 149 of file tts.py.

◆ DEFAULT_LANG

string homeassistant.components.voicerss.tts.DEFAULT_LANG = "en-us"

Definition at line 147 of file tts.py.

◆ ERROR_MSG

list homeassistant.components.voicerss.tts.ERROR_MSG
Initial value:
1 = [
2  b"Error description",
3  b"The subscription is expired or requests count limitation is exceeded!",
4  b"The request content length is too large!",
5  b"The language does not support!",
6  b"The language is not specified!",
7  b"The text is not specified!",
8  b"The API key is not available!",
9  b"The API key is not specified!",
10  b"The subscription does not support SSML!",
11 ]

Definition at line 23 of file tts.py.

◆ PLATFORM_SCHEMA

homeassistant.components.voicerss.tts.PLATFORM_SCHEMA
Initial value:
1 = TTS_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_API_KEY): cv.string,
4  vol.Optional(CONF_LANG, default=DEFAULT_LANG): vol.In(SUPPORT_LANGUAGES),
5  vol.Optional(CONF_CODEC, default=DEFAULT_CODEC): vol.In(SUPPORT_CODECS),
6  vol.Optional(CONF_FORMAT, default=DEFAULT_FORMAT): vol.In(SUPPORT_FORMATS),
7  }
8 )

Definition at line 152 of file tts.py.

◆ SUPPORT_CODECS

list homeassistant.components.voicerss.tts.SUPPORT_CODECS = ["mp3", "wav", "aac", "ogg", "caf"]

Definition at line 87 of file tts.py.

◆ SUPPORT_FORMATS

list homeassistant.components.voicerss.tts.SUPPORT_FORMATS

Definition at line 89 of file tts.py.

◆ SUPPORT_LANGUAGES

list homeassistant.components.voicerss.tts.SUPPORT_LANGUAGES

Definition at line 35 of file tts.py.

◆ VOICERSS_API_URL

string homeassistant.components.voicerss.tts.VOICERSS_API_URL = "https://api.voicerss.org/"

Definition at line 21 of file tts.py.