Music Assistant Queue Actions

Adds new actions to control player queues for Music Assistant

Designed to work with Music Assistant Player Card

New actions:

---

mass_queue.get_queue_items: Returns the items (songs, podcast episods, etc.) within a queue

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
limit	int	No	500	Number of items in queue to return
offset	int	No	n/a	Location in queue to start where zero equals the first item in queue, not the current item. By default, will start with five items before actively playing item.
limit_before	int	No	5	Number of items to pull before current active item in queue.
limit_after	int	No	100	Number of items to pull after current active item in queue.

Example Output:

media_player.music_assistant_speaker:
  - queue_item_id: f62a98bb794447e28e8400367cf0b68a
    media_title: Summer Friends (feat. Jeremih & Francis & The Lights)
    media_album_name: Coloring Book
    media_artist: Chance the Rapper, Jeremih, Francis and the Lights
    media_content_id: tidal://track/60920018
    media_image: https://resources.tidal.com/images/1d765014/8be5/4f60/a657/bce7eee1ef8b/750x750.jpg
  - queue_item_id: a6272438f57843808d891c59fec4c8bf
    media_title: Fireflies
    media_album_name: Ocean Eyes
    media_artist: Owl City
    media_content_id: tidal://track/3140991
    media_image: https://resources.tidal.com/images/76b92beb/399c/4983/9b91/0eef89c796e1/750x750.jpg
  ...

mass_queue.remove_queue_item: Removes an item out of the queue

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
queue_item_id	str	Yes	n/a	The queue_item_id of the corresponding item.

mass_queue.play_queue_item: Plays the given item for the queue

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
queue_item_id	str	Yes	n/a	The queue_item_id of the corresponding item.

mass_queue.move_queue_item_up: Move an item in the queue up one position

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
queue_item_id	str	Yes	n/a	The queue_item_id of the corresponding item.

mass_queue.move_queue_item_down: Move an item in the queue down one position

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
queue_item_id	str	Yes	n/a	The queue_item_id of the corresponding item.

mass_queue.move_queue_item_next: Move an item to the next slot in the queue

Parameter	Type	Required	Default	Description
entity	str	Yes	n/a	Music assistant player entity
queue_item_id	str	Yes	n/a	The queue_item_id of the corresponding item.

mass_queue.send_command: Sends a command to the Music Assistant API and returns the response. You may find the various commands by searching for @api_command in the music_assistant/server repository.

Parameter	Type	Required	Default	Description
command	str	Yes	n/a	The command to send to Music Assistant
data	dict	No	None	Any data to send with the command
config_entry_id	dict	No	None	The ID of the used mass_queue integration

Installation

1. Download and install the integration by using the button above.

Configuration

The integration should automatically detect the active Music Assistant instance and integration. If it does not, add as you normally would from the "Devices & Services" section in the Home Assistant Settings.

FAQs

I use a local provider (eg, Filesystem, Plex, Jellyfin, etc) and my images aren't showing up! What gives?!

Local music providers are a bit different than cloud. When you are using Plex or Jellyfin, the image returned is an HTTP URL for their local IP address. This is problematic - most users access Home Assistant via HTTPS and modern browsers prohibit mixed content (insecure content on secure sites). For filesystem providers, it's even more difficult as Music Assistant returns their path on the filesystem instead of a URL.

However, there is a workaround!

You may enable the download_local option by navigating to the integration's listing in Home Assistant and selecting the cog next to the entry. When this is enabled, the integration will attempt to download and encode the image for any item which does not have any images marked as remotely_accessible.

This option will then return a new attribute for these queue items labeled local_image_encoded. Custom cards can then utilize this in their code in place of the image URL.

WARNINGS

• This is not a cure-all and should not be enabled unless you need it.
• This will not have any effect unless any frontend card supports it.
• Loading the integration and updating the queue WILL take much longer. Each item must be downloaded and converted. This is NOT a quick process. Depending on your server, this may take between 2-20 seconds per item.
• This requires that Home Assistant can directly access the Music Assistant server along with the local provider.