jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-06-02 16:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating snapcast documentation (#9505)

Browse Source 
* Update snapcast.markdown

* ✏️ Removes linkable_title
This commit is contained in:
lyghtnox 2019-07-20 12:18:33 +02:00 committed by Franck Nijhof
parent 08d0a52b7a
commit e7644eb5b8
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/_components/snapcast.markdown
View File

@ -32,3 +32,40 @@ port:
default: 1705
type: integer
{% endconfiguration %}
## Services
The snapcast components provides a few services registered under the media_player component.
### Service `media_player.snapcast_snapshot`
Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | The speakers to snapshot.
### Service `media_player.snapcast_restore`
Restore a previously taken snapshot of one or more speakers.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that should have their snapshot restored.
### Service `media_player.snapcast_join`
Group players together under a single group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | Entity ID of the player to synchronize to.
| `entity_id` | yes | String or list of `entity_id`s to join to the master.
### Service `media_player.snapcast_unjoin`
Remove one or more speakers from their group of speakers.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker.