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-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document HEOS entity service to move queue items (#38387)

Browse Source 
* Document remove_from_queue

* Correct example
This commit is contained in:
Andrew Sayre 2025-04-07 09:57:45 -05:00 committed by GitHub
parent ec7387fc1e
commit 21c5289916
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
source/_integrations/heos.markdown
View File

@ -87,7 +87,7 @@ In addition to the standard [Media Player actions](/integrations/media_player#ac
Group volume actions: `heos.group_volume_set`, `heos.group_volume_down`, and `heos.group_volume_up` for entities joined to a group. Group volume actions: `heos.group_volume_set`, `heos.group_volume_down`, and `heos.group_volume_up` for entities joined to a group.
Queue actions: `heos.get_queue` and `heos.remove_from_queue` to manage a player's queue items. Queue actions: `heos.get_queue`, `heos.move_queue_item`, and `heos.remove_from_queue` to manage a player's queue items.
### Action `heos.group_volume_set` ### Action `heos.group_volume_set`
@ -129,6 +129,27 @@ media_player.office:
album_id: "134788273" album_id: "134788273"
``` ```
### Action `heos.move_queue_item`
Move one or more items in the target player's queue, effectively reordering the play queue. The play queue can be enumerated by using the `heos.get_queue` service.
Example action data payload that moves the second item to the top of the play queue:
```yaml
action: heos.move_queue_item
target:
entity_id: media_player.family_room_receiver
data:
queue_ids:
- 2
destination_position: 1
```
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------- |
| `queue_ids` | no | The IDs (indexes) of the items in the queue to move. |
| `destination_position` | no | The destination position in the queue (starting at 1). |
### Action `heos.remove_from_queue` ### Action `heos.remove_from_queue`
Removes one or more items from the target player(s) queue. The play queue can be enumerated by using the `heos.get_queue` service. Example action data payload: Removes one or more items from the target player(s) queue. The play queue can be enumerated by using the `heos.get_queue` service. Example action data payload: