Feature - media_player - expose async_browse_media as service

homeassistant/components/media_player/__init__.py

@@ -50,7 +50,7 @@
  STATE_PLAYING,
  STATE_STANDBY,
 )
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, SupportsResponse
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 import homeassistant.helpers.config_validation as cv
 from homeassistant.helpers.config_validation import ( # noqa: F401
@@ -101,6 +101,7 @@
  DOMAIN,
  MEDIA_CLASS_DIRECTORY,
  REPEAT_MODES,
+ SERVICE_BROWSE_MEDIA,
  SERVICE_CLEAR_PLAYLIST,
  SERVICE_JOIN,
  SERVICE_PLAY_MEDIA,
@@ -189,6 +190,12 @@ class MediaPlayerDeviceClass(StrEnum):
  vol.Optional(ATTR_MEDIA_EXTRA, default={}): dict,
 }
 
+MEDIA_PLAYER_BROWSE_MEDIA_SCHEMA = {
+ vol.Optional(ATTR_MEDIA_CONTENT_TYPE): cv.string,
+ vol.Optional(ATTR_MEDIA_CONTENT_ID): cv.string,
+}
+
+
 ATTR_TO_PROPERTY = [
  ATTR_MEDIA_VOLUME_LEVEL,
  ATTR_MEDIA_VOLUME_MUTED,
@@ -419,6 +426,14 @@ def _rewrite_enqueue(value: dict[str, Any]) -> dict[str, Any]:
  "async_play_media",
  [MediaPlayerEntityFeature.PLAY_MEDIA],
  )
+ component.async_register_entity_service(
+ SERVICE_BROWSE_MEDIA,
+ vol.All(
+ cv.make_entity_service_schema(MEDIA_PLAYER_BROWSE_MEDIA_SCHEMA),
+ ),
+ "async_browse_media",
+ supports_response=SupportsResponse.ONLY,
+ )
  component.async_register_entity_service(
  SERVICE_SHUFFLE_SET,
  {vol.Required(ATTR_MEDIA_SHUFFLE): cv.boolean},

homeassistant/components/media_player/const.py

@@ -154,6 +154,7 @@ class MediaType(StrEnum):
 SERVICE_CLEAR_PLAYLIST = "clear_playlist"
 SERVICE_JOIN = "join"
 SERVICE_PLAY_MEDIA = "play_media"
+SERVICE_BROWSE_MEDIA = "browse_media"
 SERVICE_SELECT_SOUND_MODE = "select_sound_mode"
 SERVICE_SELECT_SOURCE = "select_source"
 SERVICE_UNJOIN = "unjoin"

homeassistant/components/media_player/icons.json

@@ -32,6 +32,7 @@
  }
  },
  "services": {
+ "browse_media": "mdi:folder-search",
  "clear_playlist": "mdi:playlist-remove",
  "join": "mdi:group",
  "media_next_track": "mdi:skip-next",

homeassistant/components/media_player/services.yaml

@@ -165,6 +165,23 @@ play_media:
  selector:
  boolean:
 
+browse_media:
+ target:
+ entity:
+ domain: media_player
+ fields:
+ media_content_type:
+ required: false
+ example: "music"
+ selector:
+ text:
+
+ media_content_id:
+ required: false
+ example: "https://home-assistant.io/images/cast/splash.png"
+ selector:
+ text:
+
 select_source:
  target:
  entity:

homeassistant/components/media_player/strings.json

@@ -257,6 +257,20 @@
  }
  }
  },
+ "browse_media": {
+ "name": "Browse media",
+ "description": "Browse Media.",
+ "fields": {
+ "media_content_id": {
+ "name": "Content ID",
+ "description": "The ID of the content to browse. Platform dependent."
+ },
+ "media_content_type": {
+ "name": "Content type",
+ "description": "The type of the content to browse. Such as image, music, tv show, video, episode, channel, or playlist."
+ }
+ }
+ },
  "select_source": {
  "name": "Select source",
  "description": "Sends the media player the command to change input source.",

tests/components/media_player/test_init.py

@@ -13,6 +13,7 @@
  MediaPlayerEntity,
  MediaPlayerEntityFeature,
 )
+from homeassistant.components.media_player.const import SERVICE_BROWSE_MEDIA
 from homeassistant.components.websocket_api.const import TYPE_RESULT
 from homeassistant.const import ATTR_ENTITY_ID, STATE_OFF
 from homeassistant.core import HomeAssistant
@@ -219,6 +220,70 @@ async def test_media_browse(
  assert msg["result"] == {"bla": "yo"}
 
 
+async def test_media_browse_service(hass: HomeAssistant) -> None:
+ """Test browsing media using service call."""
+ await async_setup_component(
+ hass, "media_player", {"media_player": {"platform": "demo"}}
+ )
+ await hass.async_block_till_done()
+
+ with patch(
+ "homeassistant.components.media_player.MediaPlayerEntity.async_browse_media",
+ return_value=BrowseMedia(
+ media_class=MediaClass.DIRECTORY,
+ media_content_id="mock-id",
+ media_content_type="mock-type",
+ title="Mock Title",
+ can_play=False,
+ can_expand=True,
+ children=[
+ BrowseMedia(
+ media_class=MediaClass.ALBUM,
+ media_content_id="album1 content id",
+ media_content_type="album",
+ title="Album 1",
+ can_play=True,
+ can_expand=True,
+ ),
+ BrowseMedia(
+ media_class=MediaClass.ALBUM,
+ media_content_id="album2 content id",
+ media_content_type="album",
+ title="Album 2",
+ can_play=True,
+ can_expand=True,
+ ),
+ ],
+ ),
+ ):
+ result = await hass.services.async_call(
+ "media_player",
+ SERVICE_BROWSE_MEDIA,
+ {
+ "entity_id": "media_player.browse",
+ "media_content_type": "album",
+ "media_content_id": "abcd",
+ },
+ blocking=True,
+ return_response=True,
+ )
+
+ browse_res: BrowseMedia = result["media_player.browse"]
+
+ assert browse_res.title == "Mock Title"
+ assert browse_res.media_class == "directory"
+ assert browse_res.media_content_type == "mock-type"
+ assert browse_res.media_content_id == "mock-id"
+ assert browse_res.can_play is False
+ assert browse_res.can_expand is True
+ assert len(browse_res.children) == 2
+ assert browse_res.children[0].title == "Album 1"
+ assert browse_res.children[0].media_class == "album"
+ assert browse_res.children[0].media_content_id == "album1 content id"
+ assert browse_res.children[0].media_content_type == "album"
+ assert browse_res.children[1].title == "Album 2"
+
+
 async def test_group_members_available_when_off(hass: HomeAssistant) -> None:
  """Test that group_members are still available when media_player is off."""
  await async_setup_component(