From e7644eb5b8a9bf15e70ef5cc3a9fe36df200513e Mon Sep 17 00:00:00 2001 From: lyghtnox <33329184+lyghtnox@users.noreply.github.com> Date: Sat, 20 Jul 2019 12:18:33 +0200 Subject: [PATCH] Updating snapcast documentation (#9505) * Update snapcast.markdown * :pencil2: Removes linkable_title --- source/_components/snapcast.markdown | 37 ++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/source/_components/snapcast.markdown b/source/_components/snapcast.markdown index 14eec149b0d..a272fdd5ca8 100644 --- a/source/_components/snapcast.markdown +++ b/source/_components/snapcast.markdown @@ -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.