Snapcast
The Snapcast integration allows you to control Snapcast from Home Assistant.
Configuration
To add the Snapcast integration to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select Snapcast.
-
Follow the instructions on screen to complete the setup.
Services
The snapcast integration provides a few services registered under the media_player integration.
Service 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 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_ids that should have their snapshot restored. |
Service 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_ids to join to the master. |
Service 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_ids to separate from their coordinator speaker. |
Service snapcast.set_latency
Set the latency of a speaker.
| Service data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | String or list of entity_ids for which latency will be adjusted. |
latency |
no | Latency in ms. |