jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 00:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for grouping media players (#855)

Browse Source
This commit is contained in:
Dan Klaffenbach 2021-04-23 19:23:28 +02:00 committed by GitHub
parent 20b46c7d4a
commit 01f0246787
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/core/entity/media-player.md
View File

@ -24,12 +24,14 @@ Properties should always only return information from memory and not do I/O (lik
| media_image_url | string | None | URL that represents the current image.
| media_image_remotely_accessible | boolean | False | Return `True` if property `media_image_url` is accessible outside of the home network.
| device_class | string | `None` | Type of media player.
| group_members | list | `None` | A dynamic list of player entities which are currently grouped together for synchronous playback. If the platform has a concept of defining a group leader, the leader should be the first element in that list.
## Supported Features
| Constant | Description
| -------- | -----------
| `SUPPORT_CLEAR_PLAYLIST` | Entity allows clearing the active playlist.
| `SUPPORT_GROUPING` | Entity can be grouped with other players for synchronous playback.
| `SUPPORT_NEXT_TRACK` | Entity allows skipping to the next media track.
| `SUPPORT_PAUSE` | Entity allows pausing the playback of media.
| `SUPPORT_PLAY` | Entity allows playing/resuming playback of media.
@ -144,3 +146,26 @@ class MyMediaPlayer(MediaPlayerEntity):
image_url = ...
return await self._async_fetch_image(image_url)
```
### Grouping player entities together
Optional. If your player has support for grouping player entities together for synchronous playback (indicated by `SUPPORT_GROUPING`) one join and one unjoin method needs to be defined.
```python
class MyMediaPlayer(MediaPlayerEntity):
# Implement one of these join methods:
def join_players(self, group_members):
"""Join `group_members` as a player group with the current player."""
async def async_join_players(self, group_members):
"""Join `group_members` as a player group with the current player."""
# Implement one of these unjoin methods:
def unjoin_player(self):
"""Remove this player from any group."""
async def async_unjoin_player(self):
"""Remove this player from any group."""
```