homeassistant.components.universal.media_player Namespace Reference

Classes
class	UniversalMediaPlayer

Functions
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
string	ATTR_ACTIVE_CHILD = "active_child"
	ATTRS_SCHEMA = cv.schema_with_slug_keys(cv.string)
	CMD_SCHEMA = cv.schema_with_slug_keys(cv.SERVICE_SCHEMA)
string	CONF_ACTIVE_CHILD_TEMPLATE = "active_child_template"
string	CONF_ATTRS = "attributes"
string	CONF_BROWSE_MEDIA_ENTITY = "browse_media_entity"
string	CONF_CHILDREN = "children"
string	CONF_COMMANDS = "commands"
	PLATFORM_SCHEMA
list	STATES_ORDER
dictionary	STATES_ORDER_IDLE = STATES_ORDER_LOOKUP[MediaPlayerState.IDLE]
dictionary	STATES_ORDER_LOOKUP = {state: idx for idx, state in enumerate(STATES_ORDER)}

Detailed Description

Combination of multiple media players for a universal controller.

Function Documentation

async_setup_platform()

None homeassistant.components.universal.media_player.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the universal media players.

Definition at line 140 of file media_player.py.

Variable Documentation

ATTR_ACTIVE_CHILD

string homeassistant.components.universal.media_player.ATTR_ACTIVE_CHILD = "active_child"

Definition at line 97 of file media_player.py.

ATTRS_SCHEMA

homeassistant.components.universal.media_player.ATTRS_SCHEMA = cv.schema_with_slug_keys(cv.string)

Definition at line 119 of file media_player.py.

CMD_SCHEMA

homeassistant.components.universal.media_player.CMD_SCHEMA = cv.schema_with_slug_keys(cv.SERVICE_SCHEMA)

Definition at line 120 of file media_player.py.

CONF_ACTIVE_CHILD_TEMPLATE

string homeassistant.components.universal.media_player.CONF_ACTIVE_CHILD_TEMPLATE = "active_child_template"

Definition at line 99 of file media_player.py.

CONF_ATTRS

string homeassistant.components.universal.media_player.CONF_ATTRS = "attributes"

Definition at line 100 of file media_player.py.

CONF_BROWSE_MEDIA_ENTITY

string homeassistant.components.universal.media_player.CONF_BROWSE_MEDIA_ENTITY = "browse_media_entity"

Definition at line 103 of file media_player.py.

CONF_CHILDREN

string homeassistant.components.universal.media_player.CONF_CHILDREN = "children"

Definition at line 101 of file media_player.py.

CONF_COMMANDS

string homeassistant.components.universal.media_player.CONF_COMMANDS = "commands"

Definition at line 102 of file media_player.py.

PLATFORM_SCHEMA

homeassistant.components.universal.media_player.PLATFORM_SCHEMA

Initial value:

=  MEDIA_PLAYER_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Optional(CONF_CHILDREN, default=[]): cv.entity_ids,
        vol.Optional(CONF_COMMANDS, default={}): CMD_SCHEMA,
        vol.Optional(CONF_ATTRS, default={}): vol.Or(
            cv.ensure_list(ATTRS_SCHEMA), ATTRS_SCHEMA
        ),
        vol.Optional(CONF_BROWSE_MEDIA_ENTITY): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
        vol.Optional(CONF_ACTIVE_CHILD_TEMPLATE): cv.template,
        vol.Optional(CONF_STATE_TEMPLATE): cv.template,
    },
    extra=vol.REMOVE_EXTRA,
)

Definition at line 122 of file media_player.py.

STATES_ORDER

list homeassistant.components.universal.media_player.STATES_ORDER

Initial value:

=  [
    STATE_UNKNOWN,
    STATE_UNAVAILABLE,
    MediaPlayerState.OFF,
    MediaPlayerState.IDLE,
    MediaPlayerState.STANDBY,
    MediaPlayerState.ON,
    MediaPlayerState.PAUSED,
    MediaPlayerState.BUFFERING,
    MediaPlayerState.PLAYING,
]

Definition at line 105 of file media_player.py.

STATES_ORDER_IDLE

dictionary homeassistant.components.universal.media_player.STATES_ORDER_IDLE = STATES_ORDER_LOOKUP[MediaPlayerState.IDLE]

Definition at line 117 of file media_player.py.

STATES_ORDER_LOOKUP

dictionary homeassistant.components.universal.media_player.STATES_ORDER_LOOKUP = {state: idx for idx, state in enumerate(STATES_ORDER)}

Definition at line 116 of file media_player.py.