Skip to content

Commit 4aa11fc

Browse files
authored
Document HEOS play queue feature (#38210)
2 parents 12f9ff2 + faea288 commit 4aa11fc

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

source/_integrations/heos.markdown

+18
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,24 @@ data:
211211
| `media_content_type` | no | Set to the value `url` |
212212
| `media_content_id` | no | The full URL to the stream (max 255 characters) |
213213

214+
#### Play a queue item
215+
216+
You can play/move to an item within the player's queue by using the `media_player.play_media` action. Set `media_content_type` to `queue` and `media_content_id` to the index (starting from 1) of an item in the play queue. The play queue can be enumerated by using the `heos.get_queue` action. Example action data payload:
217+
218+
```yaml
219+
action: media_player.play_media
220+
data:
221+
entity_id: media_player.office
222+
media_content_type: "queue"
223+
media_content_id: "1"
224+
```
225+
226+
| Data attribute | Optional | Description |
227+
| ---------------------- | -------- | ----------------------------- |
228+
| `entity_id` | yes | `entity_id` of the player(s) |
229+
| `media_content_type` | no | Set to the value `queue` |
230+
| `media_content_id` | no | The queue index (e.g. `1`) |
231+
214232
### Grouping players
215233

216234
#### Join

0 commit comments

Comments
 (0)