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

Functions

BrowseMedia async_browse_media (HomeAssistant hass, MusicAssistantClient mass, str|None media_content_id, str|None media_content_type)
 
BrowseMedia build_album_items_listing (MusicAssistantClient mass, str identifier)
 
BrowseMedia build_albums_listing (MusicAssistantClient mass)
 
BrowseMedia build_artist_items_listing (MusicAssistantClient mass, str identifier)
 
BrowseMedia build_artists_listing (MusicAssistantClient mass)
 
BrowseMedia build_item (MusicAssistantClient mass, MediaItemType item, bool can_expand=True, Any media_class=None)
 
BrowseMedia build_main_listing (HomeAssistant hass)
 
BrowseMedia build_playlist_items_listing (MusicAssistantClient mass, str identifier)
 
BrowseMedia build_playlists_listing (MusicAssistantClient mass)
 
BrowseMedia build_radio_listing (MusicAssistantClient mass)
 
BrowseMedia build_tracks_listing (MusicAssistantClient mass)
 
bool media_source_filter (BrowseMedia item)
 

Variables

string LIBRARY_ALBUMS = "albums"
 
string LIBRARY_ARTISTS = "artists"
 
dictionary LIBRARY_MEDIA_CLASS_MAP
 
string LIBRARY_PLAYLISTS = "playlists"
 
string LIBRARY_RADIO = "radio"
 
dictionary LIBRARY_TITLE_MAP
 
string LIBRARY_TRACKS = "tracks"
 
string MEDIA_CONTENT_TYPE_FLAC = "audio/flac"
 
string MEDIA_TYPE_RADIO = "radio"
 
list PLAYABLE_MEDIA_TYPES
 
int THUMB_SIZE = 200
 

Detailed Description

Media Source Implementation.

Function Documentation

◆ async_browse_media()

BrowseMedia homeassistant.components.music_assistant.media_browser.async_browse_media ( HomeAssistant  hass,
MusicAssistantClient  mass,
str | None  media_content_id,
str | None  media_content_type 
)
Browse media.

Definition at line 65 of file media_browser.py.

◆ build_album_items_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_album_items_listing ( MusicAssistantClient  mass,
str   identifier 
)
Build Album items browse listing.

Definition at line 263 of file media_browser.py.

◆ build_albums_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_albums_listing ( MusicAssistantClient  mass)
Build Albums browse listing.

Definition at line 238 of file media_browser.py.

◆ build_artist_items_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_artist_items_listing ( MusicAssistantClient  mass,
str   identifier 
)
Build Artist items browse listing.

Definition at line 215 of file media_browser.py.

◆ build_artists_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_artists_listing ( MusicAssistantClient  mass)
Build Albums browse listing.

Definition at line 190 of file media_browser.py.

◆ build_item()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_item ( MusicAssistantClient  mass,
MediaItemType  item,
bool   can_expand = True,
Any   media_class = None 
)
Return BrowseMedia for MediaItem.

Definition at line 330 of file media_browser.py.

◆ build_main_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_main_listing ( HomeAssistant  hass)
Build main browse listing.

Definition at line 102 of file media_browser.py.

◆ build_playlist_items_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_playlist_items_listing ( MusicAssistantClient  mass,
str   identifier 
)
Build Playlist items browse listing.

Definition at line 164 of file media_browser.py.

◆ build_playlists_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_playlists_listing ( MusicAssistantClient  mass)
Build Playlists browse listing.

Definition at line 140 of file media_browser.py.

◆ build_radio_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_radio_listing ( MusicAssistantClient  mass)
Build Radio browse listing.

Definition at line 309 of file media_browser.py.

◆ build_tracks_listing()

BrowseMedia homeassistant.components.music_assistant.media_browser.build_tracks_listing ( MusicAssistantClient  mass)
Build Tracks browse listing.

Definition at line 284 of file media_browser.py.

◆ media_source_filter()

bool homeassistant.components.music_assistant.media_browser.media_source_filter ( BrowseMedia  item)
Filter media sources.

Definition at line 60 of file media_browser.py.

Variable Documentation

◆ LIBRARY_ALBUMS

string homeassistant.components.music_assistant.media_browser.LIBRARY_ALBUMS = "albums"

Definition at line 34 of file media_browser.py.

◆ LIBRARY_ARTISTS

string homeassistant.components.music_assistant.media_browser.LIBRARY_ARTISTS = "artists"

Definition at line 33 of file media_browser.py.

◆ LIBRARY_MEDIA_CLASS_MAP

dictionary homeassistant.components.music_assistant.media_browser.LIBRARY_MEDIA_CLASS_MAP
Initial value:
1 = {
2  LIBRARY_ARTISTS: MediaClass.ARTIST,
3  LIBRARY_ALBUMS: MediaClass.ALBUM,
4  LIBRARY_TRACKS: MediaClass.TRACK,
5  LIBRARY_PLAYLISTS: MediaClass.PLAYLIST,
6  LIBRARY_RADIO: MediaClass.MUSIC, # radio is not accepted by HA
7 }

Definition at line 48 of file media_browser.py.

◆ LIBRARY_PLAYLISTS

string homeassistant.components.music_assistant.media_browser.LIBRARY_PLAYLISTS = "playlists"

Definition at line 36 of file media_browser.py.

◆ LIBRARY_RADIO

string homeassistant.components.music_assistant.media_browser.LIBRARY_RADIO = "radio"

Definition at line 37 of file media_browser.py.

◆ LIBRARY_TITLE_MAP

dictionary homeassistant.components.music_assistant.media_browser.LIBRARY_TITLE_MAP
Initial value:
1 = {
2  LIBRARY_ARTISTS: "Artists",
3  LIBRARY_ALBUMS: "Albums",
4  LIBRARY_TRACKS: "Tracks",
5  LIBRARY_PLAYLISTS: "Playlists",
6  LIBRARY_RADIO: "Radio stations",
7 }

Definition at line 40 of file media_browser.py.

◆ LIBRARY_TRACKS

string homeassistant.components.music_assistant.media_browser.LIBRARY_TRACKS = "tracks"

Definition at line 35 of file media_browser.py.

◆ MEDIA_CONTENT_TYPE_FLAC

string homeassistant.components.music_assistant.media_browser.MEDIA_CONTENT_TYPE_FLAC = "audio/flac"

Definition at line 56 of file media_browser.py.

◆ MEDIA_TYPE_RADIO

string homeassistant.components.music_assistant.media_browser.MEDIA_TYPE_RADIO = "radio"

Definition at line 23 of file media_browser.py.

◆ PLAYABLE_MEDIA_TYPES

list homeassistant.components.music_assistant.media_browser.PLAYABLE_MEDIA_TYPES
Initial value:
1 = [
2  MediaType.PLAYLIST,
3  MediaType.ALBUM,
4  MediaType.ARTIST,
5  MEDIA_TYPE_RADIO,
6  MediaType.TRACK,
7 ]

Definition at line 25 of file media_browser.py.

◆ THUMB_SIZE

int homeassistant.components.music_assistant.media_browser.THUMB_SIZE = 200

Definition at line 57 of file media_browser.py.