Get queue details

Use this action to retrieve the details of the currently active queue of a Music Assistant player. It returns information about the current and next items in the queue, which you can use to build a custom media dashboard.

This action returns its result in a response variable, which you can use in later steps of the same automation or script. It does not change anything on the player.

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 queue details 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 Music Assistant media player whose queue you want to retrieve.
6. From the actions shown for that target, select Get queue details.
7. In the Response variable field, enter a name to store the data in, such as queue_info.
8. Select Save.

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 music_assistant.get_queue. A basic example looks like this:

action: music_assistant.get_queue
target:
  entity_id: media_player.kitchen_speaker
response_variable: queue_info

This action has no additional options in YAML.

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 action returns the queue details for the targeted player, keyed by entity ID. Each entry includes the current and next items in the queue along with their metadata.

This example stores the name of the currently playing track in an input text helper, which you can then show on a dashboard:

sequence:
  - action: music_assistant.get_queue
    target:
      entity_id: media_player.kitchen_speaker
    response_variable: queue_info
  - action: input_text.set_value
    target:
      entity_id: input_text.now_playing
    data:
      value: "{{ queue_info['media_player.kitchen_speaker'].current_item.name }}"

Good to know

• Some metadata, such as favorite status, explicit status, last played, played count, and disc art URL, is only available for items that are in the Music Assistant library.

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:

• Transfer queue: Transfers a player’s queue to another Music Assistant player.

• Get library items: Retrieves items from a Music Assistant library.