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-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs roon services (#15340)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Greg Dowling 2020-10-27 21:02:24 +00:00 committed by GitHub
parent 783fe31137
commit 111e4d981c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_integrations/roon.markdown
View File

@ -29,6 +29,8 @@ You need the Hostname or IP address of the machine that runs your Roon Core. Thi
4. Roon core will then provide Home Assistant with the details of your media players.
5. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
## Services
#### Service `media_player.play_media`
Roon doesn't use file names or URLs to track media and so the roon integration is currently limited in how it supports this call.
@ -40,4 +42,31 @@ Roon doesn't use file names or URLs to track media and so the roon integration i
| `media_content_type` | no | A media type. Currently supported are `radio`, `playlist` and `genre` |
For example to play BBC Radio 4 you would set `media_content_type` to `radio` and `media_content_id` to `BBC Radio 4`
For example to play BBC Radio 4 you would set `media_content_type` to `radio` and `media_content_id` to `BBC Radio 4`
### Service `roon.join`
Group players together.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ID of the player that will be the master of the group.
| `join_ids` | no | id(s) of the players that will join the master.
### Service `roon.unjoin`
Remove players from a group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ID of the player that is the master of the group.
| `unlink_name` | yes | id(s) of the players that will be unjoined from the group. If not specified, all players will be unjoined from the master.
### Service `roon.transfer`
Transfer playback from one player to another.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | id of the source player.
| `transfer_name` | no | id of the destination player.