Inheritance diagram for homeassistant.components.jellyfin.media_source.JellyfinSource:

Collaboration diagram for homeassistant.components.jellyfin.media_source.JellyfinSource:

Public Member Functions
None	__init__ (self, HomeAssistant hass, JellyfinClient client, JellyfinConfigEntry entry)

BrowseMediaSource	async_browse_media (self, MediaSourceItem item)

PlayMedia	async_resolve_media (self, MediaSourceItem item)

Public Attributes
	api

	client

	entry

	hass

	url

Static Public Attributes
	str

Private Member Functions
BrowseMediaSource	_build_album (self, dict[str, Any] album, bool include_children)

list[BrowseMediaSource]	_build_albums (self, str parent_id)

BrowseMediaSource	_build_artist (self, dict[str, Any] artist, bool include_children)

list[BrowseMediaSource]	_build_artists (self, str library_id)

BrowseMediaSource	_build_episode (self, dict[str, Any] episode)

list[BrowseMediaSource]	_build_episodes (self, str season_id)

BrowseMediaSource	_build_libraries (self)

BrowseMediaSource	_build_library (self, dict[str, Any] library, bool include_children)

BrowseMediaSource	_build_movie (self, dict[str, Any] movie)

BrowseMediaSource	_build_movie_library (self, dict[str, Any] library, bool include_children)

list[BrowseMediaSource]	_build_movies (self, str library_id)

BrowseMediaSource	_build_music_library (self, dict[str, Any] library, bool include_children)

BrowseMediaSource	_build_season (self, dict[str, Any] season, bool include_children)

list[BrowseMediaSource]	_build_seasons (self, str series_id)

BrowseMediaSource	_build_series (self, dict[str, Any] series, bool include_children)

BrowseMediaSource	_build_track (self, dict[str, Any] track)

list[BrowseMediaSource]	_build_tracks (self, str album_id)

BrowseMediaSource	_build_tv_library (self, dict[str, Any] library, bool include_children)

list[BrowseMediaSource]	_build_tvshow (self, str library_id)

list[dict[str, Any]]	_get_children (self, str parent_id, str item_type)

list[dict[str, Any]]	_get_libraries (self)

str	_get_stream_url (self, dict[str, Any] media_item)

str\|None	_get_thumbnail_url (self, dict[str, Any] media_item)

Detailed Description

Represents a Jellyfin server.

Definition at line 64 of file media_source.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.jellyfin.media_source.JellyfinSource.__init__	(		self,
		HomeAssistant	hass,
		JellyfinClient	client,
		JellyfinConfigEntry	entry
	)

Initialize the Jellyfin media source.

Definition at line 69 of file media_source.py.

Member Function Documentation

◆ _build_album()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_album	(		self,
		dict[str, Any]	album,
		bool	include_children
	)

private

Return a single album as a browsable media source.

Definition at line 243 of file media_source.py.

◆ _build_albums()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_albums	(		self,
		str	parent_id
	)

private

Return all albums of a single artist as browsable media sources.

Definition at line 229 of file media_source.py.

◆ _build_artist()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_artist	(		self,
		dict[str, Any]	artist,
		bool	include_children
	)

private

Return a single artist as a browsable media source.

Definition at line 204 of file media_source.py.

◆ _build_artists()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_artists	(		self,
		str	library_id
	)

private

Return all artists in the music library.

Definition at line 190 of file media_source.py.

◆ _build_episode()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_episode	(		self,
		dict[str, Any]	episode
	)

private

Return a single episode as a browsable media source.

Definition at line 482 of file media_source.py.

◆ _build_episodes()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_episodes	(		self,
		str	season_id
	)

private

Return all episode in the season.

Definition at line 464 of file media_source.py.

◆ _build_libraries()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_libraries ( self )

private

Return all supported libraries the user has access to as media sources.

Definition at line 119 of file media_source.py.

◆ _build_library()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_library	(		self,
		dict[str, Any]	library,
		bool	include_children
	)

private

Return a single library as a browsable media source.

Definition at line 152 of file media_source.py.

◆ _build_movie()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_movie	(		self,
		dict[str, Any]	movie
	)

private

Return a single movie as a browsable media source.

Definition at line 345 of file media_source.py.

◆ _build_movie_library()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_movie_library	(		self,
		dict[str, Any]	library,
		bool	include_children
	)

private

Return a single movie library as a browsable media source.

Definition at line 304 of file media_source.py.

◆ _build_movies()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_movies	(		self,
		str	library_id
	)

private

Return all movies in the movie library.

Definition at line 327 of file media_source.py.

◆ _build_music_library()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_music_library	(		self,
		dict[str, Any]	library,
		bool	include_children
	)

private

Return a single music library as a browsable media source.

Definition at line 164 of file media_source.py.

◆ _build_season()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_season	(		self,
		dict[str, Any]	season,
		bool	include_children
	)

private

Return a single series as a browsable media source.

Definition at line 439 of file media_source.py.

◆ _build_seasons()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_seasons	(		self,
		str	series_id
	)

private

Return all seasons in the series.

Definition at line 425 of file media_source.py.

◆ _build_series()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_series	(		self,
		dict[str, Any]	series,
		bool	include_children
	)

private

Return a single series as a browsable media source.

Definition at line 400 of file media_source.py.

◆ _build_track()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_track	(		self,
		dict[str, Any]	track
	)

private

Return a single track as a browsable media source.

Definition at line 286 of file media_source.py.

◆ _build_tracks()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_tracks	(		self,
		str	album_id
	)

private

Return all tracks of a single album as browsable media sources.

Definition at line 268 of file media_source.py.

◆ _build_tv_library()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource._build_tv_library	(		self,
		dict[str, Any]	library,
		bool	include_children
	)

private

Return a single tv show library as a browsable media source.

Definition at line 363 of file media_source.py.

◆ _build_tvshow()

list[BrowseMediaSource] homeassistant.components.jellyfin.media_source.JellyfinSource._build_tvshow	(		self,
		str	library_id
	)

private

Return all series in the tv library.

Definition at line 386 of file media_source.py.

◆ _get_children()

list[dict[str, Any]] homeassistant.components.jellyfin.media_source.JellyfinSource._get_children	(		self,
		str	parent_id,
		str	item_type
	)

private

Return all children for the parent_id whose item type is item_type.

Definition at line 500 of file media_source.py.

◆ _get_libraries()

list[dict[str, Any]] homeassistant.components.jellyfin.media_source.JellyfinSource._get_libraries ( self )

private

Return all supported libraries a user has access to.

Definition at line 141 of file media_source.py.

◆ _get_stream_url()

str homeassistant.components.jellyfin.media_source.JellyfinSource._get_stream_url	(		self,
		dict[str, Any]	media_item
	)

private

Return the stream URL for a media item.

Definition at line 525 of file media_source.py.

◆ _get_thumbnail_url()

str \| None homeassistant.components.jellyfin.media_source.JellyfinSource._get_thumbnail_url	(		self,
		dict[str, Any]	media_item
	)

private

Return the URL for the primary image of a media item if available.

Definition at line 515 of file media_source.py.

◆ async_browse_media()

BrowseMediaSource homeassistant.components.jellyfin.media_source.JellyfinSource.async_browse_media	(		self,
		MediaSourceItem	item
	)

Return a browsable Jellyfin media source.

Definition at line 96 of file media_source.py.

◆ async_resolve_media()

PlayMedia homeassistant.components.jellyfin.media_source.JellyfinSource.async_resolve_media	(		self,
		MediaSourceItem	item
	)

Return a streamable URL and associated mime type.

Definition at line 82 of file media_source.py.

Member Data Documentation

◆ api

homeassistant.components.jellyfin.media_source.JellyfinSource.api

Definition at line 79 of file media_source.py.

◆ client

homeassistant.components.jellyfin.media_source.JellyfinSource.client

Definition at line 78 of file media_source.py.

◆ entry

homeassistant.components.jellyfin.media_source.JellyfinSource.entry

Definition at line 76 of file media_source.py.

◆ hass

homeassistant.components.jellyfin.media_source.JellyfinSource.hass

Definition at line 75 of file media_source.py.

◆ str

homeassistant.components.jellyfin.media_source.JellyfinSource.str

static

Definition at line 67 of file media_source.py.

◆ url

homeassistant.components.jellyfin.media_source.JellyfinSource.url

Definition at line 80 of file media_source.py.

The documentation for this class was generated from the following file:

core/homeassistant/components/jellyfin/media_source.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _build_album()

◆ _build_albums()

◆ _build_artist()

◆ _build_artists()

◆ _build_episode()

◆ _build_episodes()

◆ _build_libraries()

◆ _build_library()

◆ _build_movie()

◆ _build_movie_library()

◆ _build_movies()

◆ _build_music_library()

◆ _build_season()

◆ _build_seasons()

◆ _build_series()

◆ _build_track()

◆ _build_tracks()

◆ _build_tv_library()

◆ _build_tvshow()

◆ _get_children()

◆ _get_libraries()

◆ _get_stream_url()

◆ _get_thumbnail_url()

◆ async_browse_media()

◆ async_resolve_media()

Member Data Documentation

◆ api

◆ client

◆ entry

◆ hass

◆ str

◆ url

◆ init()