homeassistant.components.group.media_player.MediaPlayerGroup Class Reference

Inheritance diagram for homeassistant.components.group.media_player.MediaPlayerGroup:

Collaboration diagram for homeassistant.components.group.media_player.MediaPlayerGroup:

Public Member Functions
None	__init__ (self, str|None unique_id, str name, list[str] entities)
None	async_added_to_hass (self)
None	async_clear_playlist (self)
None	async_media_next_track (self)
None	async_media_pause (self)
None	async_media_play (self)
None	async_media_previous_track (self)
None	async_media_seek (self, float position)
None	async_media_stop (self)
None	async_mute_volume (self, bool mute)
None	async_on_state_change (self, Event[EventStateChangedData] event)
None	async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
None	async_set_shuffle (self, bool shuffle)
None	async_set_volume_level (self, float volume)
CALLBACK_TYPE	async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_update_group_state (self)
None	async_update_supported_features (self, str entity_id, State|None new_state)
None	async_volume_down (self)
None	async_volume_up (self)
Mapping[str, Any]	extra_state_attributes (self)
str	name (self)
Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
str|None	app_id (self)
str|None	app_name (self)
BrowseMedia	async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
tuple[bytes|None, str|None]	async_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
tuple[bytes|None, str|None]	async_get_media_image (self)
None	async_join_players (self, list[str] group_members)
None	async_media_play_pause (self)
None	async_select_sound_mode (self, str sound_mode)
None	async_select_source (self, str source)
None	async_set_repeat (self, RepeatMode repeat)
None	async_toggle (self)
None	async_unjoin_player (self)
dict[str, Any]	capability_attributes (self)
None	clear_playlist (self)
MediaPlayerDeviceClass|None	device_class (self)
str|None	entity_picture (self)
str	get_browse_image_url (self, str media_content_type, str media_content_id, str|None media_image_id=None)
list[str]|None	group_members (self)
bool|None	is_volume_muted (self)
None	join_players (self, list[str] group_members)
str|None	media_album_artist (self)
str|None	media_album_name (self)
str|None	media_artist (self)
str|None	media_channel (self)
str|None	media_content_id (self)
MediaType|str|None	media_content_type (self)
int|None	media_duration (self)
str|None	media_episode (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
bool	media_image_remotely_accessible (self)
str|None	media_image_url (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
str|None	media_playlist (self)
int|None	media_position (self)
dt.datetime|None	media_position_updated_at (self)
None	media_previous_track (self)
str|None	media_season (self)
None	media_seek (self, float position)
str|None	media_series_title (self)
None	media_stop (self)
str|None	media_title (self)
int|None	media_track (self)
None	mute_volume (self, bool mute)
None	play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
RepeatMode|str|None	repeat (self)
None	select_sound_mode (self, str sound_mode)
None	select_source (self, str source)
None	set_repeat (self, RepeatMode repeat)
None	set_shuffle (self, bool shuffle)
None	set_volume_level (self, float volume)
bool|None	shuffle (self)
str|None	sound_mode (self)
list[str]|None	sound_mode_list (self)
str|None	source (self)
list[str]|None	source_list (self)
MediaPlayerState|None	state (self)
dict[str, Any]	state_attributes (self)
bool	support_clear_playlist (self)
bool	support_grouping (self)
bool	support_next_track (self)
bool	support_pause (self)
bool	support_play (self)
bool	support_play_media (self)
bool	support_previous_track (self)
bool	support_seek (self)
bool	support_select_sound_mode (self)
bool	support_select_source (self)
bool	support_shuffle_set (self)
bool	support_stop (self)
bool	support_volume_mute (self)
bool	support_volume_set (self)
MediaPlayerEntityFeature	supported_features (self)
MediaPlayerEntityFeature	supported_features_compat (self)
None	turn_off (self)
None	turn_on (self)
None	unjoin_player (self)
float|None	volume_level (self)
float	volume_step (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Static Public Attributes
	bool
Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool
	MediaPlayerEntityFeature
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Attributes
	_attr_available
	_attr_state
	_attr_supported_features
	_attr_unique_id
	_entities
	_name

Static Private Attributes
bool	_attr_should_poll = False
	_unrecorded_attributes = frozenset({ATTR_ENTITY_ID})

Additional Inherited Members
Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Representation of a Media Group.

Definition at line 127 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.group.media_player.MediaPlayerGroup.__init__	(		self,
		str | None	unique_id,
		str	name,
		list[str]	entities
	)

Initialize a Media Group entity.

Definition at line 135 of file media_player.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_added_to_hass

(

self

)

Register listeners.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 252 of file media_player.py.

async_clear_playlist()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_clear_playlist

(

self

)

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 273 of file media_player.py.

async_media_next_track()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 283 of file media_player.py.

async_media_pause()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 293 of file media_player.py.

async_media_play()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 303 of file media_player.py.

async_media_previous_track()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 313 of file media_player.py.

async_media_seek()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_seek	(		self,
		float	position
	)

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 323 of file media_player.py.

async_media_stop()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_media_stop

(

self

)

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 336 of file media_player.py.

async_mute_volume()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 346 of file media_player.py.

async_on_state_change()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_on_state_change	(		self,
		Event[EventStateChangedData]	event
	)

Update supported features and state when a new state is received.

Definition at line 155 of file media_player.py.

async_play_media()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play a piece of media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 359 of file media_player.py.

async_set_shuffle()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 377 of file media_player.py.

async_set_volume_level()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_set_volume_level	(		self,
		float	volume
	)

Set volume level(s).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 400 of file media_player.py.

async_start_preview()

CALLBACK_TYPE homeassistant.components.group.media_player.MediaPlayerGroup.async_start_preview	(		self,
		Callable[[str, Mapping[str, Any]], None]	preview_callback
	)

Render a preview.

Definition at line 232 of file media_player.py.

async_turn_off()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_turn_off

(

self

)

Forward the turn_off command to all media in the media group.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 413 of file media_player.py.

async_turn_on()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_turn_on

(

self

)

Forward the turn_on command to all media in the media group.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 390 of file media_player.py.

async_update_group_state()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_update_group_state

(

self

)

Query all members and determine the media group state.

Definition at line 438 of file media_player.py.

async_update_supported_features()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_update_supported_features	(		self,
		str	entity_id,
		State | None	new_state
	)

Update dictionaries with supported features.

Definition at line 165 of file media_player.py.

async_volume_down()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_volume_down

(

self

)

Turn volume down for media player(s).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 430 of file media_player.py.

async_volume_up()

None homeassistant.components.group.media_player.MediaPlayerGroup.async_volume_up

(

self

)

Turn volume up for media player(s).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 423 of file media_player.py.

extra_state_attributes()

Mapping[str, Any] homeassistant.components.group.media_player.MediaPlayerGroup.extra_state_attributes

(

self

)

Return the state attributes for the media group.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 269 of file media_player.py.

name()

str homeassistant.components.group.media_player.MediaPlayerGroup.name

(

self

)

Return the name of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 264 of file media_player.py.

Member Data Documentation

_attr_available

homeassistant.components.group.media_player.MediaPlayerGroup._attr_available

private

Definition at line 447 of file media_player.py.

_attr_should_poll

bool homeassistant.components.group.media_player.MediaPlayerGroup._attr_should_poll = False

staticprivate

Definition at line 133 of file media_player.py.

_attr_state

homeassistant.components.group.media_player.MediaPlayerGroup._attr_state

private

Definition at line 454 of file media_player.py.

_attr_supported_features

homeassistant.components.group.media_player.MediaPlayerGroup._attr_supported_features

private

Definition at line 501 of file media_player.py.

_attr_unique_id

homeassistant.components.group.media_player.MediaPlayerGroup._attr_unique_id

private

Definition at line 138 of file media_player.py.

_entities

homeassistant.components.group.media_player.MediaPlayerGroup._entities

private

Definition at line 140 of file media_player.py.

_name

homeassistant.components.group.media_player.MediaPlayerGroup._name

private

Definition at line 137 of file media_player.py.

_unrecorded_attributes

homeassistant.components.group.media_player.MediaPlayerGroup._unrecorded_attributes = frozenset({ATTR_ENTITY_ID})

staticprivate

Definition at line 130 of file media_player.py.

bool

homeassistant.components.group.media_player.MediaPlayerGroup.bool

static

Definition at line 132 of file media_player.py.

---

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

• core/homeassistant/components/group/media_player.py