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

Classes

class  UnknownMediaType
 

Functions

def build_item_response (media_library, payload, get_thumbnail_url=None)
 
def get_media_info (media_library, search_id, search_type)
 
def item_payload (item, get_thumbnail_url=None)
 
def library_payload (hass)
 
bool media_source_content_filter (BrowseMedia item)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary CHILD_TYPE_MEDIA_CLASS
 
dictionary CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS
 
list PLAYABLE_MEDIA_TYPES
 

Detailed Description

Support for media browsing.

Function Documentation

◆ build_item_response()

def homeassistant.components.kodi.browse_media.build_item_response (   media_library,
  payload,
  get_thumbnail_url = None 
)
Create response payload for the provided media query.

Definition at line 48 of file browse_media.py.

◆ get_media_info()

def homeassistant.components.kodi.browse_media.get_media_info (   media_library,
  search_id,
  search_type 
)
Fetch media/album.

Definition at line 234 of file browse_media.py.

◆ item_payload()

def homeassistant.components.kodi.browse_media.item_payload (   item,
  get_thumbnail_url = None 
)
Create response payload for a single media item.

Used by async_browse_media.

Definition at line 87 of file browse_media.py.

◆ library_payload()

def homeassistant.components.kodi.browse_media.library_payload (   hass)
Create response payload to describe contents of a specific library.

Used by async_browse_media.

Definition at line 181 of file browse_media.py.

◆ media_source_content_filter()

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

Definition at line 172 of file browse_media.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.kodi.browse_media._LOGGER = logging.getLogger(__name__)
private

Definition at line 41 of file browse_media.py.

◆ CHILD_TYPE_MEDIA_CLASS

dictionary homeassistant.components.kodi.browse_media.CHILD_TYPE_MEDIA_CLASS
Initial value:
1 = {
2  MediaType.SEASON: MediaClass.SEASON,
3  MediaType.ALBUM: MediaClass.ALBUM,
4  MediaType.ARTIST: MediaClass.ARTIST,
5  MediaType.MOVIE: MediaClass.MOVIE,
6  MediaType.PLAYLIST: MediaClass.PLAYLIST,
7  MediaType.TRACK: MediaClass.TRACK,
8  MediaType.TVSHOW: MediaClass.TV_SHOW,
9  MediaType.CHANNEL: MediaClass.CHANNEL,
10  MediaType.EPISODE: MediaClass.EPISODE,
11 }

Definition at line 29 of file browse_media.py.

◆ CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS

dictionary homeassistant.components.kodi.browse_media.CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS
Initial value:
1 = {
2  MediaType.ALBUM: MediaClass.ALBUM,
3  MediaType.ARTIST: MediaClass.ARTIST,
4  MediaType.PLAYLIST: MediaClass.PLAYLIST,
5  MediaType.SEASON: MediaClass.SEASON,
6  MediaType.TVSHOW: MediaClass.TV_SHOW,
7 }

Definition at line 21 of file browse_media.py.

◆ PLAYABLE_MEDIA_TYPES

list homeassistant.components.kodi.browse_media.PLAYABLE_MEDIA_TYPES
Initial value:
1 = [
2  MediaType.ALBUM,
3  MediaType.ARTIST,
4  MediaType.TRACK,
5 ]

Definition at line 15 of file browse_media.py.