homeassistant.components.plex.media_browser Namespace Reference

Classes
class	UnknownMediaType

Functions
def	browse_media (hass, is_internal, media_content_type, media_content_id, *platform=None)
def	generate_plex_uri (server_id, media_id, params=None)
str	get_proxy_image_url (str server_id, str media_content_id)
def	hub_payload (hub)
def	library_section_payload (section)
def	root_payload (hass, is_internal, platform=None)
def	special_library_payload (parent_payload, special_type)
def	station_payload (station)

Variables
list	EXPANDABLES = ["album", "artist", "playlist", "season", "show"]
dictionary	ITEM_TYPE_MEDIA_CLASS

Detailed Description

Support to interface with the Plex API.

Function Documentation

browse_media()

def homeassistant.components.plex.media_browser.browse_media	(		hass,
			is_internal,
			media_content_type,
			media_content_id,
		*	platform = None
	)

Implement the websocket media browsing helper.

Definition at line 35 of file media_browser.py.

generate_plex_uri()

def homeassistant.components.plex.media_browser.generate_plex_uri	(		server_id,
			media_id,
			params = None
	)

Create a media_content_id URL for playable Plex media.

Definition at line 282 of file media_browser.py.

get_proxy_image_url()

str homeassistant.components.plex.media_browser.get_proxy_image_url	(	str	server_id,
		str	media_content_id
	)

Generate an url for a Plex media browser image.

Definition at line 389 of file media_browser.py.

hub_payload()

def homeassistant.components.plex.media_browser.hub_payload

(

hub

)

Create response payload for a hub.

Definition at line 358 of file media_browser.py.

library_section_payload()

def homeassistant.components.plex.media_browser.library_section_payload

(

section

)

Create response payload for a single library section.

Definition at line 325 of file media_browser.py.

root_payload()

def homeassistant.components.plex.media_browser.root_payload	(		hass,
			is_internal,
			platform = None
	)

Return root payload for Plex.

Definition at line 298 of file media_browser.py.

special_library_payload()

def homeassistant.components.plex.media_browser.special_library_payload	(		parent_payload,
			special_type
	)

Create response payload for special library folders.

Definition at line 343 of file media_browser.py.

station_payload()

def homeassistant.components.plex.media_browser.station_payload

(

station

)

Create response payload for a music station.

Definition at line 376 of file media_browser.py.

Variable Documentation

EXPANDABLES

list homeassistant.components.plex.media_browser.EXPANDABLES = ["album", "artist", "playlist", "season", "show"]

Definition at line 18 of file media_browser.py.

ITEM_TYPE_MEDIA_CLASS

dictionary homeassistant.components.plex.media_browser.ITEM_TYPE_MEDIA_CLASS

Initial value:

=  {
    "album": MediaClass.ALBUM,
    "artist": MediaClass.ARTIST,
    "clip": MediaClass.VIDEO,
    "episode": MediaClass.EPISODE,
    "mixed": MediaClass.DIRECTORY,
    "movie": MediaClass.MOVIE,
    "playlist": MediaClass.PLAYLIST,
    "season": MediaClass.SEASON,
    "show": MediaClass.TV_SHOW,
    "station": MediaClass.ARTIST,
    "track": MediaClass.TRACK,
    "video": MediaClass.VIDEO,
}

Definition at line 19 of file media_browser.py.