https://github.com/s-knibbs/snapcast-ha-player
Home Assistant custom integration to enable TTS playback through a snapcast server
https://github.com/s-knibbs/snapcast-ha-player
custom-integration homeassistant snapcast
Last synced: 6 months ago
JSON representation
Home Assistant custom integration to enable TTS playback through a snapcast server
- Host: GitHub
- URL: https://github.com/s-knibbs/snapcast-ha-player
- Owner: s-knibbs
- License: mit
- Created: 2023-01-02T12:51:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-11T14:11:56.000Z (about 2 years ago)
- Last Synced: 2024-10-19T10:28:02.799Z (12 months ago)
- Topics: custom-integration, homeassistant, snapcast
- Language: Python
- Homepage:
- Size: 27.3 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Snapcast Player Home Assistant Integration
⚠️ **Unfortunately, due to health issues I will not be able to maintain this integration in future, so your YMMV** ⚠️
Simple integration designed to allow playback through a [snapcast](https://mjaggard.github.io/snapcast/) server (the built in [snapcast integration](https://www.home-assistant.io/integrations/snapcast/) doesn't support audio playback).
Audio is streamed to snapcast using ffmpeg, which is preinstalled on HassOS.
## Installation
Install via HACS or copy `./custom_components/snapcast_player/` to `/config/custom_components/`
## Configuration Variables
| key | required | example | description |
|-------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| platform | yes | `snapcast_player` | Platform name |
| host | yes | `127.0.0.1` | Hostname, IP address of the snapcast server. If snapcast is running on the same machine, this can also be the path to a [pipe](https://github.com/badaix/snapcast/blob/develop/doc/configuration.md#pipe) |
| name | no | `multiroom_player` | Entity name |
| port | no | `4953` | Port to stream audio to, default is `4953` |
| start_delay | no | `1s` | Insert a delay at the stream start. This can prevent the start of TTS announcements being cut off |
## Example Config
```yaml
media_player:
- platform: snapcast_player
host: 127.0.0.1
start_delay: 1s
```
# TODO
- Support modifying the play queue via the `media_player.play_media` service.