mirror of https://github.com/home-assistant/core
157 lines
4.2 KiB
Python
157 lines
4.2 KiB
Python
"""Support to interface with the Roon API."""
|
|
|
|
import logging
|
|
|
|
from homeassistant.components.media_player import BrowseError, BrowseMedia, MediaClass
|
|
|
|
|
|
class UnknownMediaType(BrowseError):
|
|
"""Unknown media type."""
|
|
|
|
|
|
EXCLUDE_ITEMS = {
|
|
"Play Album",
|
|
"Play Artist",
|
|
"Play Playlist",
|
|
"Play Composer",
|
|
"Play Now",
|
|
"Play From Here",
|
|
"Queue",
|
|
"Start Radio",
|
|
"Add Next",
|
|
"Play Radio",
|
|
"Play Work",
|
|
"Settings",
|
|
"Search",
|
|
"Search Tidal",
|
|
"Search Qobuz",
|
|
}
|
|
|
|
# Maximum number of items to pull back from the API
|
|
ITEM_LIMIT = 3000
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def browse_media(zone_id, roon_server, media_content_type=None, media_content_id=None):
|
|
"""Implement the websocket media browsing helper."""
|
|
try:
|
|
_LOGGER.debug("browse_media: %s: %s", media_content_type, media_content_id)
|
|
if media_content_type in [None, "library"]:
|
|
return library_payload(roon_server, zone_id, media_content_id)
|
|
|
|
except UnknownMediaType as err:
|
|
raise BrowseError(
|
|
f"Media not found: {media_content_type} / {media_content_id}"
|
|
) from err
|
|
|
|
|
|
def item_payload(roon_server, item, list_image_id):
|
|
"""Create response payload for a single media item."""
|
|
|
|
title = item["title"]
|
|
if (subtitle := item.get("subtitle")) is None:
|
|
display_title = title
|
|
else:
|
|
display_title = f"{title} ({subtitle})"
|
|
|
|
image_id = item.get("image_key") or list_image_id
|
|
|
|
image = None
|
|
if image_id:
|
|
image = roon_server.roonapi.get_image(image_id)
|
|
|
|
media_content_id = item["item_key"]
|
|
media_content_type = "library"
|
|
|
|
hint = item.get("hint")
|
|
if hint == "list":
|
|
media_class = MediaClass.DIRECTORY
|
|
can_expand = True
|
|
elif hint == "action_list":
|
|
media_class = MediaClass.PLAYLIST
|
|
can_expand = False
|
|
elif hint == "action":
|
|
media_content_type = "track"
|
|
media_class = MediaClass.TRACK
|
|
can_expand = False
|
|
else:
|
|
# Roon API says to treat unknown as a list
|
|
media_class = MediaClass.DIRECTORY
|
|
can_expand = True
|
|
_LOGGER.warning("Unknown hint %s - %s", title, hint)
|
|
|
|
payload = {
|
|
"title": display_title,
|
|
"media_class": media_class,
|
|
"media_content_id": media_content_id,
|
|
"media_content_type": media_content_type,
|
|
"can_play": True,
|
|
"can_expand": can_expand,
|
|
"thumbnail": image,
|
|
}
|
|
|
|
return BrowseMedia(**payload)
|
|
|
|
|
|
def library_payload(roon_server, zone_id, media_content_id):
|
|
"""Create response payload for the library."""
|
|
|
|
opts = {
|
|
"hierarchy": "browse",
|
|
"zone_or_output_id": zone_id,
|
|
"count": ITEM_LIMIT,
|
|
}
|
|
|
|
# Roon starts browsing for a zone where it left off - so start from the top unless otherwise specified
|
|
if media_content_id is None or media_content_id == "Explore":
|
|
opts["pop_all"] = True
|
|
content_id = "Explore"
|
|
else:
|
|
opts["item_key"] = media_content_id
|
|
content_id = media_content_id
|
|
|
|
result_header = roon_server.roonapi.browse_browse(opts)
|
|
_LOGGER.debug("Result header %s", result_header)
|
|
|
|
header = result_header["list"]
|
|
title = header.get("title")
|
|
|
|
if (subtitle := header.get("subtitle")) is None:
|
|
list_title = title
|
|
else:
|
|
list_title = f"{title} ({subtitle})"
|
|
|
|
total_count = header["count"]
|
|
|
|
library_image_id = header.get("image_key")
|
|
|
|
library_info = BrowseMedia(
|
|
title=list_title,
|
|
media_content_id=content_id,
|
|
media_content_type="library",
|
|
media_class=MediaClass.DIRECTORY,
|
|
can_play=False,
|
|
can_expand=True,
|
|
children=[],
|
|
)
|
|
|
|
result_detail = roon_server.roonapi.browse_load(opts)
|
|
_LOGGER.debug("Result detail %s", result_detail)
|
|
|
|
items = result_detail["items"]
|
|
count = len(items)
|
|
|
|
if count < total_count:
|
|
_LOGGER.debug(
|
|
"Exceeded limit of %d, loaded %d/%d", ITEM_LIMIT, count, total_count
|
|
)
|
|
|
|
for item in items:
|
|
if item.get("title") in EXCLUDE_ITEMS:
|
|
continue
|
|
entry = item_payload(roon_server, item, library_image_id)
|
|
library_info.children.append(entry)
|
|
|
|
return library_info
|