Functions
PlexObject\|list[PlexObject]	search_media (str media_type, LibrarySection library_section, bool allow_multiple=False, **kwargs)

Variables
	_LOGGER = logging.getLogger(__name__)

dictionary	LEGACY_PARAM_MAPPING

tuple	PREFERRED_LIBTYPE_ORDER

Detailed Description

Helper methods to search for Plex media.

Function Documentation

◆ search_media()

PlexObject \| list[PlexObject] homeassistant.components.plex.media_search.search_media	(	str	media_type,
		LibrarySection	library_section,
		bool	allow_multiple = `False`,
		**	kwargs
	)

Search for specified Plex media in the provided library section.

Returns a media item or a list of items if `allow_multiple` is set.

Raises MediaNotFound if the search was unsuccessful.

Definition at line 38 of file media_search.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.plex.media_search._LOGGER = logging.getLogger(__name__)

private

Definition at line 35 of file media_search.py.

◆ LEGACY_PARAM_MAPPING

dictionary homeassistant.components.plex.media_search.LEGACY_PARAM_MAPPING

Initial value:

 =  {
     "show_name": "show.title",
     "season_number": "season.index",
     "episode_name": "episode.title",
     "episode_number": "episode.index",
     "artist_name": "artist.title",
     "album_name": "album.title",
     "track_name": "track.title",
     "track_number": "track.index",
     "video_name": "movie.title",
 }

Definition at line 13 of file media_search.py.

◆ PREFERRED_LIBTYPE_ORDER

tuple homeassistant.components.plex.media_search.PREFERRED_LIBTYPE_ORDER