Skip to content

Document HEOS entity service to move queue items #38387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 7, 2025
Merged

Document HEOS entity service to move queue items #38387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e06d5ad
Document remove_from_queue
andrewsayre Apr 4, 2025
ae224aa
Correct example
andrewsayre Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion source/_integrations/heos.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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`

Expand Down Expand Up @@ -129,6 +129,27 @@ media_player.office:
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`

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:
Expand Down