Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.roon.media_browser Namespace Reference

Classes

class  UnknownMediaType
 

Functions

def browse_media (zone_id, roon_server, media_content_type=None, media_content_id=None)
 
def item_payload (roon_server, item, list_image_id)
 
def library_payload (roon_server, zone_id, media_content_id)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary EXCLUDE_ITEMS
 
int ITEM_LIMIT = 3000
 

Detailed Description

Support to interface with the Roon API.

Function Documentation

◆ browse_media()

def homeassistant.components.roon.media_browser.browse_media (   zone_id,
  roon_server,
  media_content_type = None,
  media_content_id = None 
)
Implement the websocket media browsing helper.

Definition at line 36 of file media_browser.py.

◆ item_payload()

def homeassistant.components.roon.media_browser.item_payload (   roon_server,
  item,
  list_image_id 
)
Create response payload for a single media item.

Definition at line 49 of file media_browser.py.

◆ library_payload()

def homeassistant.components.roon.media_browser.library_payload (   roon_server,
  zone_id,
  media_content_id 
)
Create response payload for the library.

Definition at line 97 of file media_browser.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.roon.media_browser._LOGGER = logging.getLogger(__name__)
private

Definition at line 33 of file media_browser.py.

◆ EXCLUDE_ITEMS

dictionary homeassistant.components.roon.media_browser.EXCLUDE_ITEMS
Initial value:
1 = {
2  "Play Album",
3  "Play Artist",
4  "Play Playlist",
5  "Play Composer",
6  "Play Now",
7  "Play From Here",
8  "Queue",
9  "Start Radio",
10  "Add Next",
11  "Play Radio",
12  "Play Work",
13  "Settings",
14  "Search",
15  "Search Tidal",
16  "Search Qobuz",
17 }

Definition at line 12 of file media_browser.py.

◆ ITEM_LIMIT

int homeassistant.components.roon.media_browser.ITEM_LIMIT = 3000

Definition at line 31 of file media_browser.py.