Get queue

Use this action to read the play queue of a HEOS media player. It returns the items currently queued, which you can use to inspect what’s lined up or to find the queue IDs needed by the Move queue item and Remove from queue actions.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the queue from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the HEOS media player you want to read.
6. From the actions shown for that target, select Get queue.
7. Select Save.

Options in the UI

This action has no additional options in the UI.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as heos.get_queue. Store the result in a response variable so you can use it in later steps:

action: heos.get_queue
target:
  entity_id: media_player.office
response_variable: queue

This stores the play queue of media_player.office in queue.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching media_player entity behind that target.

• Entity: one specific media_player entity, such as media_player.living_room.
• Device: every media_player entity that belongs to a device.
• Area: every media_player entity in a room or area.
• Floor: every media_player entity on a floor.
• Label: every media_player entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Response data

The response is keyed by the entity ID of each targeted player. For every player, a queue list holds the queued items, each with the following fields:

• queue_id: The position of the item in the queue, starting at 1.
• song: The title of the track.
• album: The album the track belongs to.
• artist: The artist of the track.
• image_url: A link to the cover art.
• media_id: The HEOS identifier of the track.
• album_id: The HEOS identifier of the album.

media_player.office:
  queue:
    - queue_id: 1
      song: Alone Again
      album: After Hours
      artist: The Weeknd
      image_url: >-
        http://resources.example.com/images/640x640.jpg
      media_id: "134788274"
      album_id: "134788273"
    - queue_id: 2
      song: Too Late
      album: After Hours
      artist: The Weeknd
      image_url: >-
        http://resources.example.com/images/640x640.jpg
      media_id: "134788275"
      album_id: "134788273"

Good to know

• Use this action first to find the queue_id values, then pass them to Move queue item or Remove from queue.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Move queue item: Reorders one or more items within a HEOS media player’s play queue.

• Remove from queue: Removes one or more items from a HEOS media player’s play queue.