homeassistant.components.heos.GroupManager Class Reference

Public Member Functions
def	__init__ (self, hass, controller)
def	async_get_group_membership (self)
None	async_join_players (self, str leader_entity_id, list[str] member_entity_ids)
def	async_unjoin_player (self, str player_entity_id)
def	async_update_groups (self, event, data=None)
def	connect_update (self)
def	disconnect_update (self)
def	group_membership (self)

Public Attributes
	controller

Private Member Functions
dict	_get_entity_id_to_player_id_map (self)

Private Attributes
	_disconnect_player_added
	_group_membership
	_hass
	_initialized

Detailed Description

Class that manages HEOS groups.

Definition at line 246 of file __init__.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.heos.GroupManager.__init__	(		self,
			hass,
			controller
	)

Init group manager.

Definition at line 249 of file __init__.py.

Member Function Documentation

_get_entity_id_to_player_id_map()

dict homeassistant.components.heos.GroupManager._get_entity_id_to_player_id_map (   self )

private

Return mapping of all HeosMediaPlayer entity_ids to player_ids.

Definition at line 257 of file __init__.py.

async_get_group_membership()

def homeassistant.components.heos.GroupManager.async_get_group_membership

(

self

)

Return all group members for each player as entity_ids.

Definition at line 261 of file __init__.py.

async_join_players()

None homeassistant.components.heos.GroupManager.async_join_players	(		self,
		str	leader_entity_id,
		list[str]	member_entity_ids
	)

Create a group a group leader and member players.

Definition at line 291 of file __init__.py.

async_unjoin_player()

def homeassistant.components.heos.GroupManager.async_unjoin_player	(		self,
		str	player_entity_id
	)

Remove `player_entity_id` from any group.

Definition at line 318 of file __init__.py.

async_update_groups()

def homeassistant.components.heos.GroupManager.async_update_groups	(		self,
			event,
			data = None
	)

Update the group membership from the controller.

Definition at line 335 of file __init__.py.

connect_update()

def homeassistant.components.heos.GroupManager.connect_update

(

self

)

Connect listener for when groups change and signal player update.

Definition at line 350 of file __init__.py.

disconnect_update()

def homeassistant.components.heos.GroupManager.disconnect_update

(

self

)

Disconnect the listeners.

Definition at line 376 of file __init__.py.

group_membership()

def homeassistant.components.heos.GroupManager.group_membership

(

self

)

Provide access to group members for player entities.

Definition at line 383 of file __init__.py.

Member Data Documentation

_disconnect_player_added

homeassistant.components.heos.GroupManager._disconnect_player_added

private

Definition at line 253 of file __init__.py.

_group_membership

homeassistant.components.heos.GroupManager._group_membership

private

Definition at line 252 of file __init__.py.

_hass

homeassistant.components.heos.GroupManager._hass

private

Definition at line 251 of file __init__.py.

_initialized

homeassistant.components.heos.GroupManager._initialized

private

Definition at line 254 of file __init__.py.

controller

homeassistant.components.heos.GroupManager.controller

Definition at line 255 of file __init__.py.

---

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

• core/homeassistant/components/heos/__init__.py