homeassistant.components.group.media_player Namespace Reference

Classes
class	MediaPlayerGroup

Functions
MediaPlayerGroup	async_create_preview_media_player (HomeAssistant hass, str name, dict[str, Any] validated_config)
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
string	DEFAULT_NAME = "Media Group"
string	KEY_ANNOUNCE = "announce"
string	KEY_CLEAR_PLAYLIST = "clear_playlist"
string	KEY_ENQUEUE = "enqueue"
string	KEY_ON_OFF = "on_off"
string	KEY_PAUSE_PLAY_STOP = "play"
string	KEY_PLAY_MEDIA = "play_media"
string	KEY_SEEK = "seek"
string	KEY_SHUFFLE = "shuffle"
string	KEY_TRACKS = "tracks"
string	KEY_VOLUME = "volume"
	PLATFORM_SCHEMA

Detailed Description

Platform allowing several media players to be grouped into one media player.

Function Documentation

async_create_preview_media_player()

MediaPlayerGroup homeassistant.components.group.media_player.async_create_preview_media_player	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 116 of file media_player.py.

async_setup_entry()

None homeassistant.components.group.media_player.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize MediaPlayer Group config entry.

Definition at line 99 of file media_player.py.

async_setup_platform()

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

Set up the MediaPlayer Group platform.

Definition at line 83 of file media_player.py.

Variable Documentation

DEFAULT_NAME

string homeassistant.components.group.media_player.DEFAULT_NAME = "Media Group"

Definition at line 72 of file media_player.py.

KEY_ANNOUNCE

string homeassistant.components.group.media_player.KEY_ANNOUNCE = "announce"

Definition at line 61 of file media_player.py.

KEY_CLEAR_PLAYLIST

string homeassistant.components.group.media_player.KEY_CLEAR_PLAYLIST = "clear_playlist"

Definition at line 62 of file media_player.py.

KEY_ENQUEUE

string homeassistant.components.group.media_player.KEY_ENQUEUE = "enqueue"

Definition at line 63 of file media_player.py.

KEY_ON_OFF

string homeassistant.components.group.media_player.KEY_ON_OFF = "on_off"

Definition at line 64 of file media_player.py.

KEY_PAUSE_PLAY_STOP

string homeassistant.components.group.media_player.KEY_PAUSE_PLAY_STOP = "play"

Definition at line 65 of file media_player.py.

KEY_PLAY_MEDIA

string homeassistant.components.group.media_player.KEY_PLAY_MEDIA = "play_media"

Definition at line 66 of file media_player.py.

KEY_SEEK

string homeassistant.components.group.media_player.KEY_SEEK = "seek"

Definition at line 68 of file media_player.py.

KEY_SHUFFLE

string homeassistant.components.group.media_player.KEY_SHUFFLE = "shuffle"

Definition at line 67 of file media_player.py.

KEY_TRACKS

string homeassistant.components.group.media_player.KEY_TRACKS = "tracks"

Definition at line 69 of file media_player.py.

KEY_VOLUME

string homeassistant.components.group.media_player.KEY_VOLUME = "volume"

Definition at line 70 of file media_player.py.

PLATFORM_SCHEMA

homeassistant.components.group.media_player.PLATFORM_SCHEMA

Initial value:

=  MEDIA_PLAYER_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITIES): cv.entities_domain(MEDIA_PLAYER_DOMAIN),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 74 of file media_player.py.