homeassistant.components.jellyfin.browse_media Namespace Reference

Functions
BrowseMedia	build_item_response (HomeAssistant hass, JellyfinClient client, str user_id, str|None media_content_type, str media_content_id)
BrowseMedia	build_root_response (HomeAssistant hass, JellyfinClient client, str user_id)
dict[str, Any]|None	fetch_item (JellyfinClient client, str item_id)
list[dict[str, Any]]|None	fetch_items (JellyfinClient client, dict[str, Any] params)
tuple[str|None, list[dict[str, Any]]|None, str|None]	get_media_info (HomeAssistant hass, JellyfinClient client, str user_id, str|None media_content_type, str media_content_id)
BrowseMedia	item_payload (HomeAssistant hass, JellyfinClient client, str user_id, dict[str, Any] item)

Variables
list	PLAYABLE_MEDIA_TYPES

Detailed Description

Support for media browsing.

Function Documentation

build_item_response()

BrowseMedia homeassistant.components.jellyfin.browse_media.build_item_response	(	HomeAssistant	hass,
		JellyfinClient	client,
		str	user_id,
		str | None	media_content_type,
		str	media_content_id
	)

Create response payload for the provided media query.

Definition at line 91 of file browse_media.py.

build_root_response()

BrowseMedia homeassistant.components.jellyfin.browse_media.build_root_response	(	HomeAssistant	hass,
		JellyfinClient	client,
		str	user_id
	)

Create response payload for root folder.

Definition at line 67 of file browse_media.py.

fetch_item()

dict[str, Any] | None homeassistant.components.jellyfin.browse_media.fetch_item	(	JellyfinClient	client,
		str	item_id
	)

Fetch item from Jellyfin server.

Definition at line 128 of file browse_media.py.

fetch_items()

list[dict[str, Any]] | None homeassistant.components.jellyfin.browse_media.fetch_items	(	JellyfinClient	client,
		dict[str, Any]	params
	)

Fetch items from Jellyfin server.

Definition at line 139 of file browse_media.py.

get_media_info()

tuple[str | None, list[dict[str, Any]] | None, str | None] homeassistant.components.jellyfin.browse_media.get_media_info	(	HomeAssistant	hass,
		JellyfinClient	client,
		str	user_id,
		str | None	media_content_type,
		str	media_content_id
	)

Fetch media info.

Definition at line 159 of file browse_media.py.

item_payload()

BrowseMedia homeassistant.components.jellyfin.browse_media.item_payload	(	HomeAssistant	hass,
		JellyfinClient	client,
		str	user_id,
		dict[str, Any]	item
	)

Create response payload for a single media item.

Definition at line 42 of file browse_media.py.

Variable Documentation

PLAYABLE_MEDIA_TYPES

list homeassistant.components.jellyfin.browse_media.PLAYABLE_MEDIA_TYPES

Initial value:

=  [
    MediaType.EPISODE,
    MediaType.MOVIE,
    MediaType.MUSIC,
]

Definition at line 35 of file browse_media.py.