Expose media_player async_browse_media as service

[PeteRager]

Proposed change

Expose the existing media_player.async_browse_media method as a service call with a return value.

Approved architecture discussion: home-assistant/architecture#1079

The purpose is to allow automations to access the service to browse for media (just as you can do from the UI) and then use the return values to do other actions. As an example, here is an automation that gets a list of the albums by the Beatles and randomly plays one. This is using a Sonos music library.

alias: play_beatles
description: ""
trigger: []
condition: []
action:
  - service: media_player.browse_media
    metadata: {}
    data:
      media_content_id: A:ALBUMARTIST/Beatles
      media_content_type: album
    response_variable: albums
    target:
      entity_id: media_player.master_bedroom_2
  - variables:
      num_children: "{{ albums['media_player.master_bedroom_2']['children'] | length }}"
      random_album_index: "{{ range(1, num_children - 1) | random }}"
      random_album_media_id: >-
        {{
        albums['media_player.master_bedroom_2']['children'][random_album_index]['media_content_id']
        }}
  - service: media_player.play_media
    target:
      entity_id: media_player.master_bedroom_2
    data:
      media_content_id: "{{ random_album_media_id }}"
      media_content_type: album
    metadata: {}
mode: single

Here is a sample of the YAML returned when running the browse_media service from developer tools / services

media_player.master_bedroom_2:
  title: Beatles
  media_class: album
  media_content_type: album
  media_content_id: A:ALBUMARTIST/Beatles
  children_media_class: directory
  can_play: false
  can_expand: false
  thumbnail: null
  not_shown: 0
  children:
    - title: All
      media_class: artist
      media_content_type: artist
      media_content_id: A:ALBUMARTIST/Beatles/
      children_media_class: null
      can_play: true
      can_expand: true
      thumbnail: null
    - title: A Hard Day's Night
      media_class: album
      media_content_type: album
      media_content_id: A:ALBUMARTIST/Beatles/A%20Hard%20Day's%20Night
      children_media_class: null
      can_play: true
      can_expand: true
      thumbnail: >-
        http://192.168.50.40:1400/getaa?u=x-file-cifs://192.168.50.70/music/iTunes/iTunes%20Media/Music/The%20Beatles/A%20Hard%20Day's%20Night/01%20A%20Hard%20Day's%20Night%201.m4a&v=53
    - title: Abbey Road
      media_class: album
      media_content_type: album
      media_content_id: A:ALBUMARTIST/Beatles/Abbey%20Road
      children_media_class: null
      can_play: true
      can_expand: true
      thumbnail: >-
        http://192.168.50.40:1400/getaa?u=x-file-cifs://192.168.50.70/music/iTunes%20Music/The%20Beatles/Abbey%20Road/01%20Come%20Together.mp3&v=53

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request: Media player browse media action documentation home-assistant.io#37096

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (media_player) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of media_player can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign media_player Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[joostlek]

This PR is changing our entity model. Before we can review this PR there needs to be approval in a discussion in our architecture repository.

https://github.com/home-assistant/architecture/discussions

https://developers.home-assistant.io/docs/core/entity#changing-the-entity-model

[PeteRager]

Architecture discussion is here

home-assistant/architecture#1079

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

[PeteRager]

Can this be merged?

[MartinHjelmare]

Thanks!

[MartinHjelmare]

Are we ready to merge? Please press the ready for review button when ready.