Start a playlist with a script

[heinzma]

As ask by @Bachigaloupe in #820 (comment).

I can start playlists with a script just fine.

alias: TEST playlist TEST
sequence:
  - service: media_player.play_media
    target:
      entity_id: media_player.mass_muse_luxe
    data:
      media_content_id: media-source://mass/database://playlist/1
      media_content_type: playlist
    metadata:
      title: test
      thumbnail: null
      media_class: playlist
      children_media_class: track
      navigateIds:
        - {}
        - media_content_type: app
          media_content_id: media-source://mass
        - media_content_type: music
          media_content_id: media-source://mass/playlists
        - media_content_type: audio/flac
          media_content_id: media-source://mass/database://playlist/1
mode: single

When using the UI, to create the script, use Action type: "Play media" and make sure to choose "Music Assistant" -> "Playlist" when picking the media. NOT "Local Media" -> "...".

You can also use Action type: "Call Service", Service: "Media player: Play media". Content ID: media-source://mass/database://playlist/X. X is a number 1, 2, 3, ... the number seems to corresponds to the order in which the playlists were created.

[Bachigaloupe]

@heinzma Thanks for this. This is helpful to see other examples and I see this showed up under discussions in GitHub.

I think the most helpful is to see your script and then hope I can find my paths to the said playlist.

The script step I looked at late yesterday asked for a URI and I assumed it was a "pathname,playlistname"

This was helpful to set me off trying things on my own.

Very much appreciate your taking the time.

Rich

[rjgrandy]

Is this really the easiest way to programmatically call a playlist? How is it even possible to know what playlist corresponds to which number without using the automation ui? Music Assistant has a lot of promise but the documentation is a bit lacking making it hard to figure out how to do things programmatically.

[OzGav]

Let me start by saying the tone of your last sentence isn’t great. Having said that, isn’t the answer to your question about what number to use answered in the last paragraph of the first post?

[marcelveldt]

@rjgrandy feel free to contribute to the documentation, thanks!

[rjgrandy]

I am happy to contribute to the documentation as I learn, is there a format that you are trying to use? My personal opinion feedback is that the linking to posts isn't the best method of documentation since it can be old information and from users who are also just learning. I also think I am still trying to figure out how to do things for the first time, but I can offer examples of how I use it in my setup.

@OzGav I'm sorry if I came off a bit harsh, that wasnt my intent. The first post says the number seems to correspond to the add order. That didn't sound very definative or official. I was also trying to understand the other Metadata structure and keywords and was having difficulty understanding what all belongs there.

[OzGav]

Thanks @rjgrandy. There is quite a lot of coding work going on with associated changes so at this point linking to posts we feel is appropriate as it is the latest information available. If it becomes out of date we will remove or adjust the links. As MA is leveraging the HA capabilities (and in some cases in an advanced manner) then documentation shortfalls are possibly not due to us. In the example at the top of this discussion all of it appears to be in https://www.home-assistant.io/integrations/media_player/ (including the links to the Google Dev Documentation) or https://www.home-assistant.io/docs/blueprint/selectors/#media-selector

Having said that @marcelveldt has written a dedicated service call for MA (see below) that we are yet to properly document.

[marcelveldt]

Maybe we should better document the "mass.queue_command" service as it is way more easier to use than the builtin services. For example you can simply start a playlist by name instead dof having to lookup the id.

BTW: Next version will also accept the filepath as item_id

[OzGav]

We only have a tiny bit in the FAQ currently which steers people away from using it so that will be a change that will need some examples I would suggest.

[OzGav]

Examples for how to use mass.queue_command have been added to the FAQ

[Buster14]

Hi, I wasnt able to get this to work, So i created playlist and i'm able to play it through MA.
Then I created script just like instruction above like this :

alias: Alan_Playlist
sequence:
  - service: media_player.play_media
    target:
      entity_id: media_player.ad4507f6_88ce9ee6
    data:
      media_content_id: media-source://mass/database://playlist/1
      media_content_type: playlist
    metadata:
      title: Alan
      thumbnail: null
      media_class: playlist
      children_media_class: track
      navigateIds:
        - {}
        - media_content_type: app
          media_content_id: media-source://mass
        - media_content_type: music
          media_content_id: media-source://mass/playlists
        - media_content_type: audio/flac
          media_content_id: media-source://mass/database://playlist/1
mode: single

But the script does nothing, it only says "playlist name triggered"

This is the trace :

params:
  domain: media_player
  service: play_media
  service_data:
    media_content_id: media-source://media_source/local/music/Alan.m3u
    media_content_type: audio/x-mpegurl
    entity_id:
      - media_player.ad4507f6_88ce9ee6
  target:
    entity_id:
      - media_player.ad4507f6_88ce9ee6
running_script: false
limit: 10

[OzGav]

Are you saying you can play the playlist to the exact same player directly in MA that you are trying to use in the script? I notice you aren’t targeting a MA player…you don’t have to but I am wondering if this player is compatible with MA?

[Buster14]

Yes, I can play playlist through MA using that same player. It's just the script that's stuck.

[OzGav]

Might have to wait and see what @marcelveldt thinks…

[Buster14]

Update : might be a browser-mod issue, I tested several times and it's disconnected twice. I'll try testing it on DLNA speaker then

[OzGav]

The tab will likely be suspended if it is not in focus…

[gieljnssns]

Can someone help me to convert this service call to use with MA?
I use this with sonos and the sources are a mix of spotify playlists, tunein stations and sonos radio stations(will they be supported in the future?)

action:
  - service: media_player.volume_set
    data_template:
      entity_id: media_player.keuken
      volume_level: 0.12
  - service: media_player.select_source
    data_template:
      entity_id: media_player.keuken
      source: >
        {{ [
          'Willy',
          'Arrow Classic Rock',
          'Black Label Extreme Metal Radio',
          'VRT Studio Brussel Bruut',
          'Hard Rock Hell Radio',
          'New Lords of Metal',
          'Punk Riot',
          'Brutale Belgen 🇧🇪💪🏻☠️',
          'MetalRock.FM',
          'VRT Studio Brussel Bruut',
          'Hand of Doom Radio',
          'Real Punk Radio',
          'Het betere genre',
          'Brutale Belgen 🇧🇪💪🏻☠️',
          'Het betere genre +',
          'Punk In Drublic',
          'VRT Studio Brussel Bruut',
          'Pinguin Aardschok',
          'Pinguin On The Rocks',
          'Belgische gitaren�',
          'GARAGE BANGERS!',
          "PUNK!!! Let's go!!",
          'VAN EIGEN BODEM! (Belgische Gitaren)'
        ] | random }}

[OzGav]

Probably a cut and paste error as there is something in the action section that isn’t correctly formatted. Try removing blocks (e.g. the default section) until the error goes away to isolate the issue.

[jdekoven]

Does anyone know how to play a Your Tube Playlist, especially with the mass.queue command? What I really need is to know how to figure out the URI. With Spotify I can just spell out the name of the playlist and it works great for example "John's Playlist". This doesn't work for You Tube, nor does the URL. Any ideas are appreciated.

[OzGav]

@MarvinSchenkel is it not possible to specify a YouTube playlist?

[MarvinSchenkel]

That should definitely be possible. Here's a snippet of my automation where I do exactly that:

variables:
  just_awake_music: ["Classical Meditation", "Tranquil spa day"]
  early_morning_music: ["Chill", "Chill step", "Reflections"]
  morning_music: ["Chill step", "Ambient / Relax"]
  day_music: ["Ambient / Relax", "deepchill"]
  evening_music: ["Ambient / Relax"]
  christmas_music: ["Christmas Hits"]
  active_schedule: '{{ states("input_select.current_music_schedule") }}'
  music_to_play: >-
    {% if active_schedule == "just_awake" %}
      {{ just_awake_music }}
    {% elif active_schedule == "early_morning" %}
      {{ early_morning_music }}
    {% elif active_schedule == "morning" %}
      {{ morning_music }}
    {% elif active_schedule == "day" %}
      {{ day_music }}
    {% elif active_schedule == "evening" %}
      {{ evening_music }}
    {% endif %}
  radio_mode: >-
    {% if active_schedule == "just_awake" %}
      {{ false }}
    {% else %}
      {{ true }}
    {% endif %}
......
- service: mass.queue_command
  data:
    command: play_media
    uri: "{{ music_to_play }}"
    enqueue_mode: replace_next
    radio_mode: "{{ radio_mode }}"
  target:
    entity_id: media_player.mass_sonos_livingroom

[tikeyknax]

I was looking for a way to get the album numbers for many different albums from music-assistant that I need for my automation and this answer lead me on the right way. So I thought I share my work - maybe it is useful for someone else as well.

To get the required ids of my albums, I first made a copy of music_assistant.db and then wrote a small python script to get the needed information. The script prints the album id (item_id) with the album name, the artists and the source (spotify, file, ...). In this list, it's easy to find the right albums (or extent the python script accordingly) and it can then be used in an automation with media-source://mass/database://album/{item_id}. The same can easily be done for playlists instead of albums.

import sqlite3
import json

con = sqlite3.connect("data/music_assistant.db")
cur = con.cursor()

for row in cur.execute("SELECT item_id,name,artists,provider_ids FROM albums"):
    item_id, name, artists_txt, provider_txt = row
    artists_json = json.loads(artists_txt)
    artists = [aj["name"] for aj in artists_json]

    providers_json = json.loads(provider_txt)
    providers = [pj["prov_type"] for pj in providers_json]

    print(f"{item_id}: {name} ({artists}) -    {providers}")

[pungkula1337anka]

Is this still somehow possible with music assistant v2?

Thanks for your hard work guys, its much appreciated!

[OzGav]

Yes just have to wait until the HA integration is written. Will be in a few weeks

[pungkula1337anka]

Wow thats one quick response, I cant wait! you rock.

[pjdreger3]

I'm using v2023.1

I copied the script from Buster14 in the comments above and changed it for my instance. (code below). When I run this script from an automation I get an unknown media source error. I have only 1 playlist and the playlist and all mp3 files are in the local media folder. I can however play the playlist from the web interface on the selected device. Any help greatly appreciated. Great product

Script

alias: TEST playlist TEST
sequence:
  - service: media_player.play_media
    target:
      entity_id: media_player.office_speaker
    data:
      media_content_id: media-source://mass/database://playlist/1
      media_content_type: playlist
    metadata:
      title: test
      thumbnail: null
      media_class: playlist
      children_media_class: track
      navigateIds:
        - {}
        - media_content_type: app
          media_content_id: media-source://mass
        - media_content_type: music
          media_content_id: media-source://mass/playlists
        - media_content_type: audio/flac
          media_content_id: media-source://mass/database://playlist/1
mode: single

this is the automation

alias: MusicPlayScript
description: ""
trigger:
  - platform: tag
    tag_id: 627d6968-11e2-434f-983b-433c909ba618
condition: []
action:
  - service: script.TEST_playlist_TEST
    data: {}
mode: single

and this is the script

alias: TEST_playlist_TEST
sequence:
  - service: media_player.play_media
    target:
      entity_id: media_player.office_speaker
    data:
      media_content_id: media-source://mass/database://playlist/1
      media_content_type: playlist
    metadata:
      title: test
      thumbnail: null
      media_class: playlist
      children_media_class: track
      navigateIds:
        - {}
        - media_content_type: app
          media_content_id: media-source://mass
        - media_content_type: music
          media_content_id: media-source://mass/playlists
        - media_content_type: audio/flac
          media_content_id: media-source://mass/database://playlist/1
mode: single

I've also tried running the script directly without the automation and I
get a unknown media source error.

looking in the mass folder under custom components I'm not seeing anything
like mass/playlist or /mass/database

one other thing - I'm not seeing the mass.queue_command in the list of services

[OzGav]

Yes I was but your issue is that MA v1 which is currently on HACS is not compatible with HA >= 2023.3.x #1143

[pjdreger3]

Thanks for your patience. I thought the version I had installed was the beta.

[OzGav]

#1143 (comment) how to install the beta is here

[pjdreger3]

Thanks for the pointer. Turns out I had both the HACS version and the better installed. Deleted the HACS version now I have just the beta.

[OzGav]

Great. A couple of weeks and the HA integration will be written and these automations will work again

[fliespl]

So what is currently supported way to do it in v2?

I am getting unknown media source using following in b32.

      - service: media_player.play_media
        target:
          entity_id: media_player.nest_salon
        data:
          media_content_id: media-source://mass/database://playlist/1
          media_content_type: playlist
          enqueue: replace
        metadata:
          title: kolysanki
          thumbnail: null
          media_class: playlist
          children_media_class: track
          navigateIds:
            - {}
            - media_content_type: app
              media_content_id: media-source://mass
            - media_content_type: music
              media_content_id: media-source://mass/playlists
            - media_content_type: audio/flac
              media_content_id: media-source://mass/database://playlist/1

[MarvinSchenkel]

Make sure to install the integration via HACS and add the integration to your Home Assistant.

[fliespl]

@marcelveldt are you sure? One of the steps for update was to delete it from HACS and use only addons page... I am talking about v2 BETA.

[MarvinSchenkel]

The beta version of the HA integration for MA2 has been released. Make sure to enable 'beta releases' in HACS and select 2023.6.0.

[fliespl]

Thanks @MarvinSchenkel. I am curious - there are no mass_ speakers now. Anything changed on this subject? I can see some with _2 prefix - are those to be used for automations with MASS?

[MarvinSchenkel]

Probably yes. To view which devices are related to MA, just go to integrations and see which entities are related to MA

(Typo edited by Gav)

[PatrikPatrik2]

I have installed the latest beta through Hacs.
I want to have a script that start a playlist in Tidal:

service: mass.queue_command
data:
command: play_media
uri: Chill i solen
enqueue_mode: play
radio_mode: false
player_id: media_player.shield_2

I get this error when I run the script:
'Music' object has no attribute 'get_playlists'

What have I made wrong?

[OzGav]

Can you please format your yaml properly using the <> button. Also please read the FAQ and try using the normal HA service calls. This might be a bug but let’s try this first

[PatrikPatrik2]

alias: New Script
sequence:
  - service: mass.queue_command
    data:
      command: play_media
      uri: Chill i solen
      enqueue_mode: play
      radio_mode: false
      player_id: media_player.shield_2`

Which resulted in:
'Music' object has no attribute 'get_playlists'

I tried this, which I hope is a normal HA service call

service: media_player.play_media
target:
  entity_id: media_player.shield_2
data:
  media_content_id: Chill i solen
  media_content_type: music

then I got the same error code:
'Music' object has no attribute 'get_playlists'

However, if I cut the power to my media player, then HA state that the script was sucessfully run.

[OzGav]

Is “Chili I solen” in your library? If so, from what provider?

[MarvinSchenkel]

Are you on the latest home assistant integration beta? So not the addon, but the integration via HACS. Should be version 2023.6.b3

[OzGav]

This is mostly outdated info. See the docs https://music-assistant.io/faq/how-to/