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

Public Member Functions

def __init__ (self, apikey, lang, gender, ttype, rate, volume, pitch, contour, region)
 
def default_language (self)
 
def default_options (self)
 
def get_tts_audio (self, message, language, options)
 
def supported_languages (self)
 
def supported_options (self)
 

Public Attributes

 name
 

Private Attributes

 _apikey
 
 _contour
 
 _gender
 
 _lang
 
 _output
 
 _pitch
 
 _rate
 
 _region
 
 _type
 
 _volume
 

Detailed Description

The Microsoft speech API provider.

Definition at line 72 of file tts.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.microsoft.tts.MicrosoftProvider.__init__ (   self,
  apikey,
  lang,
  gender,
  ttype,
  rate,
  volume,
  pitch,
  contour,
  region 
)
Init Microsoft TTS service.

Definition at line 75 of file tts.py.

Member Function Documentation

◆ default_language()

def homeassistant.components.microsoft.tts.MicrosoftProvider.default_language (   self)
Return the default language.

Definition at line 92 of file tts.py.

◆ default_options()

def homeassistant.components.microsoft.tts.MicrosoftProvider.default_options (   self)
Return a dict include default options.

Definition at line 107 of file tts.py.

◆ get_tts_audio()

def homeassistant.components.microsoft.tts.MicrosoftProvider.get_tts_audio (   self,
  message,
  language,
  options 
)
Load TTS from Microsoft.

Definition at line 111 of file tts.py.

◆ supported_languages()

def homeassistant.components.microsoft.tts.MicrosoftProvider.supported_languages (   self)
Return list of supported languages.

Definition at line 97 of file tts.py.

◆ supported_options()

def homeassistant.components.microsoft.tts.MicrosoftProvider.supported_options (   self)
Return list of supported options like voice, emotion.

Definition at line 102 of file tts.py.

Member Data Documentation

◆ _apikey

homeassistant.components.microsoft.tts.MicrosoftProvider._apikey
private

Definition at line 79 of file tts.py.

◆ _contour

homeassistant.components.microsoft.tts.MicrosoftProvider._contour
private

Definition at line 87 of file tts.py.

◆ _gender

homeassistant.components.microsoft.tts.MicrosoftProvider._gender
private

Definition at line 81 of file tts.py.

◆ _lang

homeassistant.components.microsoft.tts.MicrosoftProvider._lang
private

Definition at line 80 of file tts.py.

◆ _output

homeassistant.components.microsoft.tts.MicrosoftProvider._output
private

Definition at line 83 of file tts.py.

◆ _pitch

homeassistant.components.microsoft.tts.MicrosoftProvider._pitch
private

Definition at line 86 of file tts.py.

◆ _rate

homeassistant.components.microsoft.tts.MicrosoftProvider._rate
private

Definition at line 84 of file tts.py.

◆ _region

homeassistant.components.microsoft.tts.MicrosoftProvider._region
private

Definition at line 88 of file tts.py.

◆ _type

homeassistant.components.microsoft.tts.MicrosoftProvider._type
private

Definition at line 82 of file tts.py.

◆ _volume

homeassistant.components.microsoft.tts.MicrosoftProvider._volume
private

Definition at line 85 of file tts.py.

◆ name

homeassistant.components.microsoft.tts.MicrosoftProvider.name

Definition at line 89 of file tts.py.


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