Skip to content

Commit 21c5289

Browse files
authored
Document HEOS entity service to move queue items (#38387)
* Document remove_from_queue * Correct example
1 parent ec7387f commit 21c5289

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

source/_integrations/heos.markdown

+22-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ In addition to the standard [Media Player actions](/integrations/media_player#ac
8787

8888
Group volume actions: `heos.group_volume_set`, `heos.group_volume_down`, and `heos.group_volume_up` for entities joined to a group.
8989

90-
Queue actions: `heos.get_queue` and `heos.remove_from_queue` to manage a player's queue items.
90+
Queue actions: `heos.get_queue`, `heos.move_queue_item`, and `heos.remove_from_queue` to manage a player's queue items.
9191

9292
### Action `heos.group_volume_set`
9393

@@ -129,6 +129,27 @@ media_player.office:
129129
album_id: "134788273"
130130
```
131131
132+
### Action `heos.move_queue_item`
133+
134+
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.
135+
136+
Example action data payload that moves the second item to the top of the play queue:
137+
138+
```yaml
139+
action: heos.move_queue_item
140+
target:
141+
entity_id: media_player.family_room_receiver
142+
data:
143+
queue_ids:
144+
- 2
145+
destination_position: 1
146+
```
147+
148+
| Data attribute | Optional | Description |
149+
| ---------------------- | -------- | ------------------------------------------------------- |
150+
| `queue_ids` | no | The IDs (indexes) of the items in the queue to move. |
151+
| `destination_position` | no | The destination position in the queue (starting at 1). |
152+
132153
### Action `heos.remove_from_queue`
133154

134155
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:

0 commit comments

Comments
 (0)