Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.squeezebox.browse_media Namespace Reference

Functions

BrowseMedia build_item_response (MediaPlayerEntity entity, Player player, dict[str, str|None] payload)
 
list|None generate_playlist (Player player, dict[str, str] payload)
 
BrowseMedia library_payload (HomeAssistant hass, Player player)
 
bool media_source_content_filter (BrowseMedia item)
 

Variables

int BROWSE_LIMIT = 1000
 
dictionary CONTENT_TYPE_TO_CHILD_TYPE
 
list LIBRARY
 
dictionary MEDIA_TYPE_TO_SQUEEZEBOX
 
dictionary SQUEEZEBOX_ID_BY_TYPE
 

Detailed Description

Support for media browsing.

Function Documentation

◆ build_item_response()

BrowseMedia homeassistant.components.squeezebox.browse_media.build_item_response ( MediaPlayerEntity  entity,
Player  player,
dict[str, str | None]   payload 
)
Create response payload for search described by payload.

Definition at line 87 of file browse_media.py.

◆ generate_playlist()

list | None homeassistant.components.squeezebox.browse_media.generate_playlist ( Player  player,
dict[str, str]  payload 
)
Generate playlist from browsing payload.

Definition at line 238 of file browse_media.py.

◆ library_payload()

BrowseMedia homeassistant.components.squeezebox.browse_media.library_payload ( HomeAssistant  hass,
Player  player 
)
Create response payload to describe contents of library.

Definition at line 188 of file browse_media.py.

◆ media_source_content_filter()

bool homeassistant.components.squeezebox.browse_media.media_source_content_filter ( BrowseMedia  item)
Content filter for media sources.

Definition at line 233 of file browse_media.py.

Variable Documentation

◆ BROWSE_LIMIT

int homeassistant.components.squeezebox.browse_media.BROWSE_LIMIT = 1000

Definition at line 84 of file browse_media.py.

◆ CONTENT_TYPE_TO_CHILD_TYPE

dictionary homeassistant.components.squeezebox.browse_media.CONTENT_TYPE_TO_CHILD_TYPE
Initial value:
1 = {
2  MediaType.ALBUM: MediaType.TRACK,
3  MediaType.PLAYLIST: MediaType.PLAYLIST,
4  MediaType.ARTIST: MediaType.ALBUM,
5  MediaType.GENRE: MediaType.ARTIST,
6  "Artists": MediaType.ARTIST,
7  "Albums": MediaType.ALBUM,
8  "Tracks": MediaType.TRACK,
9  "Playlists": MediaType.PLAYLIST,
10  "Genres": MediaType.GENRE,
11  "Favorites": None, # can only be determined after inspecting the item
12  "New Music": MediaType.ALBUM,
13 }

Definition at line 70 of file browse_media.py.

◆ LIBRARY

list homeassistant.components.squeezebox.browse_media.LIBRARY
Initial value:
1 = [
2  "Favorites",
3  "Artists",
4  "Albums",
5  "Tracks",
6  "Playlists",
7  "Genres",
8  "New Music",
9 ]

Definition at line 21 of file browse_media.py.

◆ MEDIA_TYPE_TO_SQUEEZEBOX

dictionary homeassistant.components.squeezebox.browse_media.MEDIA_TYPE_TO_SQUEEZEBOX
Initial value:
1 = {
2  "Favorites": "favorites",
3  "Artists": "artists",
4  "Albums": "albums",
5  "Tracks": "titles",
6  "Playlists": "playlists",
7  "Genres": "genres",
8  "New Music": "new music",
9  MediaType.ALBUM: "album",
10  MediaType.ARTIST: "artist",
11  MediaType.TRACK: "title",
12  MediaType.PLAYLIST: "playlist",
13  MediaType.GENRE: "genre",
14 }

Definition at line 31 of file browse_media.py.

◆ SQUEEZEBOX_ID_BY_TYPE

dictionary homeassistant.components.squeezebox.browse_media.SQUEEZEBOX_ID_BY_TYPE
Initial value:
1 = {
2  MediaType.ALBUM: "album_id",
3  MediaType.ARTIST: "artist_id",
4  MediaType.TRACK: "track_id",
5  MediaType.PLAYLIST: "playlist_id",
6  MediaType.GENRE: "genre_id",
7  "Favorites": "item_id",
8 }

Definition at line 46 of file browse_media.py.