Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.alexa.capabilities.AlexaEqualizerController Class Reference
Inheritance diagram for homeassistant.components.alexa.capabilities.AlexaEqualizerController:
[legend]
Collaboration diagram for homeassistant.components.alexa.capabilities.AlexaEqualizerController:
[legend]

Public Member Functions

dict[str, Any]|None configurations (self)
 
Any get_property (self, str name)
 
list[dict[str, str]] get_valid_inputs (cls, list[str] sound_mode_list)
 
str name (self)
 
bool properties_retrievable (self)
 
list[dict[str, str]] properties_supported (self)
 
- Public Member Functions inherited from homeassistant.components.alexa.capabilities.AlexaCapability
None __init__ (self, State entity, str|None instance=None, bool|None non_controllable_properties=None)
 
list[dict[str, Any]]|None camera_stream_configurations (self)
 
bool|None capability_proactively_reported (self)
 
dict[str, list[dict[str, Any]]] capability_resources (self)
 
dict[str, Any]|None configuration (self)
 
list[dict[str, str]]|None inputs (self)
 
bool|None properties_non_controllable (self)
 
bool properties_proactively_reported (self)
 
dict[str, Any]|None semantics (self)
 
dict[str, Any] serialize_discovery (self)
 
Generator[dict[str, Any]] serialize_properties (self)
 
list[str] supported_operations (self)
 
bool|None supports_deactivation (self)
 

Static Public Attributes

dictionary supported_locales
 
dictionary VALID_SOUND_MODES
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.alexa.capabilities.AlexaCapability
 entity
 
 instance
 

Detailed Description

Implements Alexa.EqualizerController.

https://developer.amazon.com/en-US/docs/alexa/device-apis/alexa-equalizercontroller.html

Definition at line 2342 of file capabilities.py.

Member Function Documentation

◆ configurations()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaEqualizerController.configurations (   self)
Return the sound modes supported in the configurations object.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2401 of file capabilities.py.

◆ get_property()

Any homeassistant.components.alexa.capabilities.AlexaEqualizerController.get_property (   self,
str  name 
)
Read and return a property.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2390 of file capabilities.py.

◆ get_valid_inputs()

list[dict[str, str]] homeassistant.components.alexa.capabilities.AlexaEqualizerController.get_valid_inputs (   cls,
list[str]  sound_mode_list 
)
Return list of supported inputs.

Definition at line 2413 of file capabilities.py.

◆ name()

str homeassistant.components.alexa.capabilities.AlexaEqualizerController.name (   self)
Return the Alexa API name of this interface.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2374 of file capabilities.py.

◆ properties_retrievable()

bool homeassistant.components.alexa.capabilities.AlexaEqualizerController.properties_retrievable (   self)
Return True if properties can be retrieved.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2386 of file capabilities.py.

◆ properties_supported()

list[dict[str, str]] homeassistant.components.alexa.capabilities.AlexaEqualizerController.properties_supported (   self)
Return what properties this entity supports.

Either bands, mode or both can be specified. Only mode is supported
at this time.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2378 of file capabilities.py.

Member Data Documentation

◆ supported_locales

dictionary homeassistant.components.alexa.capabilities.AlexaEqualizerController.supported_locales
static
Initial value:
= {
"de-DE",
"en-AU",
"en-CA",
"en-GB",
"en-IN",
"en-US",
"es-ES",
"es-MX",
"es-US",
"fr-CA",
"fr-FR",
"hi-IN",
"it-IT",
"ja-JP",
"pt-BR",
}

Definition at line 2348 of file capabilities.py.

◆ VALID_SOUND_MODES

dictionary homeassistant.components.alexa.capabilities.AlexaEqualizerController.VALID_SOUND_MODES
static
Initial value:
= {
"MOVIE",
"MUSIC",
"NIGHT",
"SPORT",
"TV",
}

Definition at line 2366 of file capabilities.py.


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