homeassistant.components.plex.server.PlexServer Class Reference

Public Member Functions
def	__init__ (self, hass, server_config, known_server_id=None, options=None, entry_id=None)
def	account (self)
def	accounts (self)
def	async_refresh_entity (self, machine_identifier, device, session, source)
def	async_update_session (self, payload)
def	connect (self)
def	create_playqueue (self, media, **kwargs)
def	create_station_playqueue (self, key)
def	fetch_item (self, item)
def	friendly_name (self)
def	get_playqueue (self, playqueue_id)
def	has_token (self)
def	library (self)
def	lookup_media (self, media_type, **kwargs)
def	machine_identifier (self)
def	option_ignore_new_shared_users (self)
def	option_ignore_plexweb_clients (self)
def	option_monitored_users (self)
def	option_use_episode_art (self)
def	owner (self)
def	playlist (self, title)
def	playlists (self)
def	plex_server (self)
def	plextv_clients (self)
def	sensor_attributes (self)
None	set_plex_server (self, PlexServer plex_server)
PlexServer	switch_user (self, str username)
def	url_in_use (self)
def	version (self)

Public Attributes
	active_sessions
	async_update_platforms
	entry_id
	hass
	options
	server_choice
	thumbnail_cache

Private Member Functions
def	_async_update_platforms (self)
def	_fetch_platform_data (self)

Private Attributes
	_accounts
	_client_device_cache
	_created_clients
	_known_clients
	_known_idle
	_owner_username
	_plex_account
	_plex_server
	_plextv_client_timestamp
	_plextv_clients
	_server_id
	_server_name
	_token
	_url
	_use_plex_tv
	_verify_ssl
	_version

Detailed Description

Manages a single Plex server connection.

Definition at line 66 of file server.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.plex.server.PlexServer.__init__	(		self,
			hass,
			server_config,
			known_server_id = None,
			options = None,
			entry_id = None
	)

Initialize a Plex server instance.

Definition at line 69 of file server.py.

Member Function Documentation

_async_update_platforms()

def homeassistant.components.plex.server.PlexServer._async_update_platforms (   self )

private

Update the platform entities.

Definition at line 321 of file server.py.

_fetch_platform_data()

def homeassistant.components.plex.server.PlexServer._fetch_platform_data (   self )

private

Fetch all data from the Plex server in a single method.

Definition at line 313 of file server.py.

account()

def homeassistant.components.plex.server.PlexServer.account

(

self

)

Return a MyPlexAccount instance.

Definition at line 112 of file server.py.

accounts()

def homeassistant.components.plex.server.PlexServer.accounts

(

self

)

Return accounts associated with the Plex server.

Definition at line 548 of file server.py.

async_refresh_entity()

def homeassistant.components.plex.server.PlexServer.async_refresh_entity	(		self,
			machine_identifier,
			device,
			session,
			source
	)

Forward refresh dispatch to media_player.

Definition at line 249 of file server.py.

async_update_session()

def homeassistant.components.plex.server.PlexServer.async_update_session	(		self,
			payload
	)

Process a session payload received from a websocket callback.

Definition at line 261 of file server.py.

connect()

def homeassistant.components.plex.server.PlexServer.connect

(

self

)

Connect to a Plex server directly, obtaining direct URL if necessary.

Definition at line 141 of file server.py.

create_playqueue()

def homeassistant.components.plex.server.PlexServer.create_playqueue	(		self,
			media,
		**	kwargs
	)

Create playqueue on Plex server.

Definition at line 610 of file server.py.

create_station_playqueue()

def homeassistant.components.plex.server.PlexServer.create_station_playqueue	(		self,
			key
	)

Create playqueue on Plex server using a radio station key.

Definition at line 614 of file server.py.

fetch_item()

def homeassistant.components.plex.server.PlexServer.fetch_item	(		self,
			item
	)

Fetch item from Plex server.

Definition at line 622 of file server.py.

friendly_name()

def homeassistant.components.plex.server.PlexServer.friendly_name

(

self

)

Return name of connected Plex server.

Definition at line 563 of file server.py.

get_playqueue()

def homeassistant.components.plex.server.PlexServer.get_playqueue	(		self,
			playqueue_id
	)

Retrieve existing playqueue from Plex server.

Definition at line 618 of file server.py.

has_token()

def homeassistant.components.plex.server.PlexServer.has_token

(

self

)

Return if a token is used to connect to this Plex server.

Definition at line 543 of file server.py.

library()

def homeassistant.components.plex.server.PlexServer.library

(

self

)

Return library attribute from server object.

Definition at line 598 of file server.py.

lookup_media()

def homeassistant.components.plex.server.PlexServer.lookup_media	(		self,
			media_type,
		**	kwargs
	)

Lookup a piece of media.

Definition at line 626 of file server.py.

machine_identifier()

def homeassistant.components.plex.server.PlexServer.machine_identifier

(

self

)

Return unique identifier of connected Plex server.

Definition at line 568 of file server.py.

option_ignore_new_shared_users()

def homeassistant.components.plex.server.PlexServer.option_ignore_new_shared_users

(

self

)

Return ignore_new_shared_users option.

Definition at line 578 of file server.py.

option_ignore_plexweb_clients()

def homeassistant.components.plex.server.PlexServer.option_ignore_plexweb_clients

(

self

)

Return ignore_plex_web_clients option.

Definition at line 593 of file server.py.

option_monitored_users()

def homeassistant.components.plex.server.PlexServer.option_monitored_users

(

self

)

Return dict of monitored users option.

Definition at line 588 of file server.py.

option_use_episode_art()

def homeassistant.components.plex.server.PlexServer.option_use_episode_art

(

self

)

Return use_episode_art option.

Definition at line 583 of file server.py.

owner()

def homeassistant.components.plex.server.PlexServer.owner

(

self

)

Return the Plex server owner username.

Definition at line 553 of file server.py.

playlist()

def homeassistant.components.plex.server.PlexServer.playlist	(		self,
			title
	)

Return playlist from server object.

Definition at line 602 of file server.py.

playlists()

def homeassistant.components.plex.server.PlexServer.playlists

(

self

)

Return available playlists from server object.

Definition at line 606 of file server.py.

plex_server()

def homeassistant.components.plex.server.PlexServer.plex_server

(

self

)

Return the plexapi PlexServer instance.

Definition at line 538 of file server.py.

plextv_clients()

def homeassistant.components.plex.server.PlexServer.plextv_clients

(

self

)

Return available clients linked to Plex account.

Definition at line 123 of file server.py.

sensor_attributes()

def homeassistant.components.plex.server.PlexServer.sensor_attributes

(

self

)

Return active session information for use in activity sensor.

Definition at line 665 of file server.py.

set_plex_server()

None homeassistant.components.plex.server.PlexServer.set_plex_server	(		self,
		PlexServer	plex_server
	)

Set the PlexServer instance.

Definition at line 669 of file server.py.

switch_user()

PlexServer homeassistant.components.plex.server.PlexServer.switch_user	(		self,
		str	username
	)

Return a shallow copy of a PlexServer as the provided user.

Definition at line 673 of file server.py.

url_in_use()

def homeassistant.components.plex.server.PlexServer.url_in_use

(

self

)

Return URL used for connected Plex server.

Definition at line 573 of file server.py.

version()

def homeassistant.components.plex.server.PlexServer.version

(

self

)

Return the version of the Plex server.

Definition at line 558 of file server.py.

Member Data Documentation

_accounts

homeassistant.components.plex.server.PlexServer._accounts

private

Definition at line 88 of file server.py.

_client_device_cache

homeassistant.components.plex.server.PlexServer._client_device_cache

private

Definition at line 92 of file server.py.

_created_clients

homeassistant.components.plex.server.PlexServer._created_clients

private

Definition at line 78 of file server.py.

_known_clients

homeassistant.components.plex.server.PlexServer._known_clients

private

Definition at line 79 of file server.py.

_known_idle

homeassistant.components.plex.server.PlexServer._known_idle

private

Definition at line 80 of file server.py.

_owner_username

homeassistant.components.plex.server.PlexServer._owner_username

private

Definition at line 89 of file server.py.

_plex_account

homeassistant.components.plex.server.PlexServer._plex_account

private

Definition at line 76 of file server.py.

_plex_server

homeassistant.components.plex.server.PlexServer._plex_server

private

Definition at line 77 of file server.py.

_plextv_client_timestamp

homeassistant.components.plex.server.PlexServer._plextv_client_timestamp

private

Definition at line 91 of file server.py.

_plextv_clients

homeassistant.components.plex.server.PlexServer._plextv_clients

private

Definition at line 90 of file server.py.

_server_id

homeassistant.components.plex.server.PlexServer._server_id

private

Definition at line 85 of file server.py.

_server_name

homeassistant.components.plex.server.PlexServer._server_name

private

Definition at line 83 of file server.py.

_token

homeassistant.components.plex.server.PlexServer._token

private

Definition at line 82 of file server.py.

_url

homeassistant.components.plex.server.PlexServer._url

private

Definition at line 81 of file server.py.

_use_plex_tv

homeassistant.components.plex.server.PlexServer._use_plex_tv

private

Definition at line 93 of file server.py.

_verify_ssl

homeassistant.components.plex.server.PlexServer._verify_ssl

private

Definition at line 84 of file server.py.

_version

homeassistant.components.plex.server.PlexServer._version

private

Definition at line 94 of file server.py.

active_sessions

homeassistant.components.plex.server.PlexServer.active_sessions

Definition at line 75 of file server.py.

async_update_platforms

homeassistant.components.plex.server.PlexServer.async_update_platforms

Definition at line 95 of file server.py.

entry_id

homeassistant.components.plex.server.PlexServer.entry_id

Definition at line 74 of file server.py.

hass

homeassistant.components.plex.server.PlexServer.hass

Definition at line 73 of file server.py.

options

homeassistant.components.plex.server.PlexServer.options

Definition at line 86 of file server.py.

server_choice

homeassistant.components.plex.server.PlexServer.server_choice

Definition at line 87 of file server.py.

thumbnail_cache

homeassistant.components.plex.server.PlexServer.thumbnail_cache

Definition at line 103 of file server.py.

---

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

• core/homeassistant/components/plex/server.py