home-assistant.io/source/_integrations/snapcast.markdown

title, description, logo, ha_category, ha_release, ha_iot_class, ha_domain

title	description	logo	ha_category	ha_release	ha_iot_class	ha_domain
Snapcast	Instructions on how to integrate Snapcast into Home Assistant.	snapcast.png	Media Player	0.13	Local Polling	snapcast

The snapcast platform allows you to control Snapcast from Home Assistant.

To add Snapcast to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
media_player:
  - platform: snapcast
    host: YOUR_IP_ADDRESS

{% configuration %} host: description: The IP address of the device, e.g., 192.168.0.10. required: true type: string port: description: The port number. required: false default: 1705 type: integer {% endconfiguration %}

Services

The snapcast components provides a few services registered under the media_player component.

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.