Home Assistant Unofficial Reference 2024.12.1
Variables
homeassistant.components.plex.const Namespace Reference

Variables

string AUTH_CALLBACK_NAME = "auth:plex:callback"
 
string AUTH_CALLBACK_PATH = "/auth/plex/callback"
 
string AUTOMATIC_SETUP_STRING = "Obtain a new token from plex.tv"
 
 CLIENT_SCAN_INTERVAL = timedelta(minutes=10)
 
list COMMON_PLAYERS = ["Plex Web"]
 
string CONF_IGNORE_NEW_SHARED_USERS = "ignore_new_shared_users"
 
string CONF_IGNORE_PLEX_WEB_CLIENTS = "ignore_plex_web_clients"
 
string CONF_MONITORED_USERS = "monitored_users"
 
string CONF_SERVER = "server"
 
string CONF_SERVER_IDENTIFIER = "server_id"
 
string CONF_USE_EPISODE_ART = "use_episode_art"
 
int DEBOUNCE_TIMEOUT = 1
 
int DEFAULT_PORT = 32400
 
bool DEFAULT_SSL = False
 
bool DEFAULT_VERIFY_SSL = True
 
string DOMAIN = "plex"
 
 Final
 
string INVALID_TOKEN_MESSAGE = "Invalid token"
 
string MANUAL_SETUP_STRING = "Configure Plex server manually"
 
string NAME_FORMAT = "Plex ({})"
 
 PLATFORMS
 
string PLAYER_SOURCE = "player_source"
 
string PLEX_NEW_MP_SIGNAL = "plex_new_mp_signal.{}"
 
string PLEX_SERVER_CONFIG = "server_config"
 
string PLEX_UPDATE_LIBRARY_SIGNAL = "plex_update_libraries_signal.{}"
 
string PLEX_UPDATE_MEDIA_PLAYER_SESSION_SIGNAL = "plex_update_session_signal.{}"
 
string PLEX_UPDATE_MEDIA_PLAYER_SIGNAL = "plex_update_mp_signal.{}"
 
string PLEX_UPDATE_PLATFORMS_SIGNAL = "plex_update_platforms_signal.{}"
 
string PLEX_UPDATE_SENSOR_SIGNAL = "plex_update_sensor_signal.{}"
 
string PLEX_URI_SCHEME = "plex://"
 
int PLEXTV_THROTTLE = 60
 
string SERVICE_REFRESH_LIBRARY = "refresh_library"
 
string SERVICE_SCAN_CLIENTS = "scan_for_clients"
 
list TRANSIENT_DEVICE_MODELS = ["Plex Web", "Plex for Sonos"]
 
string X_PLEX_DEVICE_NAME = "Home Assistant"
 
string X_PLEX_PLATFORM = "Home Assistant"
 
string X_PLEX_PRODUCT = "Home Assistant"
 
 X_PLEX_VERSION = __version__
 

Detailed Description

Constants for the Plex component.

Variable Documentation

◆ AUTH_CALLBACK_NAME

string homeassistant.components.plex.const.AUTH_CALLBACK_NAME = "auth:plex:callback"

Definition at line 48 of file const.py.

◆ AUTH_CALLBACK_PATH

string homeassistant.components.plex.const.AUTH_CALLBACK_PATH = "/auth/plex/callback"

Definition at line 47 of file const.py.

◆ AUTOMATIC_SETUP_STRING

string homeassistant.components.plex.const.AUTOMATIC_SETUP_STRING = "Obtain a new token from plex.tv"

Definition at line 55 of file const.py.

◆ CLIENT_SCAN_INTERVAL

homeassistant.components.plex.const.CLIENT_SCAN_INTERVAL = timedelta(minutes=10)

Definition at line 19 of file const.py.

◆ COMMON_PLAYERS

list homeassistant.components.plex.const.COMMON_PLAYERS = ["Plex Web"]

Definition at line 10 of file const.py.

◆ CONF_IGNORE_NEW_SHARED_USERS

string homeassistant.components.plex.const.CONF_IGNORE_NEW_SHARED_USERS = "ignore_new_shared_users"

Definition at line 43 of file const.py.

◆ CONF_IGNORE_PLEX_WEB_CLIENTS

string homeassistant.components.plex.const.CONF_IGNORE_PLEX_WEB_CLIENTS = "ignore_plex_web_clients"

Definition at line 44 of file const.py.

◆ CONF_MONITORED_USERS

string homeassistant.components.plex.const.CONF_MONITORED_USERS = "monitored_users"

Definition at line 45 of file const.py.

◆ CONF_SERVER

string homeassistant.components.plex.const.CONF_SERVER = "server"

Definition at line 40 of file const.py.

◆ CONF_SERVER_IDENTIFIER

string homeassistant.components.plex.const.CONF_SERVER_IDENTIFIER = "server_id"

Definition at line 41 of file const.py.

◆ CONF_USE_EPISODE_ART

string homeassistant.components.plex.const.CONF_USE_EPISODE_ART = "use_episode_art"

Definition at line 42 of file const.py.

◆ DEBOUNCE_TIMEOUT

int homeassistant.components.plex.const.DEBOUNCE_TIMEOUT = 1

Definition at line 20 of file const.py.

◆ DEFAULT_PORT

int homeassistant.components.plex.const.DEFAULT_PORT = 32400

Definition at line 13 of file const.py.

◆ DEFAULT_SSL

bool homeassistant.components.plex.const.DEFAULT_SSL = False

Definition at line 14 of file const.py.

◆ DEFAULT_VERIFY_SSL

bool homeassistant.components.plex.const.DEFAULT_VERIFY_SSL = True

Definition at line 15 of file const.py.

◆ DOMAIN

string homeassistant.components.plex.const.DOMAIN = "plex"

Definition at line 8 of file const.py.

◆ Final

homeassistant.components.plex.const.Final

Definition at line 21 of file const.py.

◆ INVALID_TOKEN_MESSAGE

string homeassistant.components.plex.const.INVALID_TOKEN_MESSAGE = "Invalid token"

Definition at line 63 of file const.py.

◆ MANUAL_SETUP_STRING

string homeassistant.components.plex.const.MANUAL_SETUP_STRING = "Configure Plex server manually"

Definition at line 56 of file const.py.

◆ NAME_FORMAT

string homeassistant.components.plex.const.NAME_FORMAT = "Plex ({})"

Definition at line 9 of file const.py.

◆ PLATFORMS

homeassistant.components.plex.const.PLATFORMS
Initial value:
1 = frozenset(
2  [Platform.BUTTON, Platform.MEDIA_PLAYER, Platform.SENSOR, Platform.UPDATE]
3 )

Definition at line 24 of file const.py.

◆ PLAYER_SOURCE

string homeassistant.components.plex.const.PLAYER_SOURCE = "player_source"

Definition at line 27 of file const.py.

◆ PLEX_NEW_MP_SIGNAL

string homeassistant.components.plex.const.PLEX_NEW_MP_SIGNAL = "plex_new_mp_signal.{}"

Definition at line 33 of file const.py.

◆ PLEX_SERVER_CONFIG

string homeassistant.components.plex.const.PLEX_SERVER_CONFIG = "server_config"

Definition at line 31 of file const.py.

◆ PLEX_UPDATE_LIBRARY_SIGNAL

string homeassistant.components.plex.const.PLEX_UPDATE_LIBRARY_SIGNAL = "plex_update_libraries_signal.{}"

Definition at line 36 of file const.py.

◆ PLEX_UPDATE_MEDIA_PLAYER_SESSION_SIGNAL

string homeassistant.components.plex.const.PLEX_UPDATE_MEDIA_PLAYER_SESSION_SIGNAL = "plex_update_session_signal.{}"

Definition at line 34 of file const.py.

◆ PLEX_UPDATE_MEDIA_PLAYER_SIGNAL

string homeassistant.components.plex.const.PLEX_UPDATE_MEDIA_PLAYER_SIGNAL = "plex_update_mp_signal.{}"

Definition at line 35 of file const.py.

◆ PLEX_UPDATE_PLATFORMS_SIGNAL

string homeassistant.components.plex.const.PLEX_UPDATE_PLATFORMS_SIGNAL = "plex_update_platforms_signal.{}"

Definition at line 37 of file const.py.

◆ PLEX_UPDATE_SENSOR_SIGNAL

string homeassistant.components.plex.const.PLEX_UPDATE_SENSOR_SIGNAL = "plex_update_sensor_signal.{}"

Definition at line 38 of file const.py.

◆ PLEX_URI_SCHEME

string homeassistant.components.plex.const.PLEX_URI_SCHEME = "plex://"

Definition at line 61 of file const.py.

◆ PLEXTV_THROTTLE

int homeassistant.components.plex.const.PLEXTV_THROTTLE = 60

Definition at line 17 of file const.py.

◆ SERVICE_REFRESH_LIBRARY

string homeassistant.components.plex.const.SERVICE_REFRESH_LIBRARY = "refresh_library"

Definition at line 58 of file const.py.

◆ SERVICE_SCAN_CLIENTS

string homeassistant.components.plex.const.SERVICE_SCAN_CLIENTS = "scan_for_clients"

Definition at line 59 of file const.py.

◆ TRANSIENT_DEVICE_MODELS

list homeassistant.components.plex.const.TRANSIENT_DEVICE_MODELS = ["Plex Web", "Plex for Sonos"]

Definition at line 11 of file const.py.

◆ X_PLEX_DEVICE_NAME

string homeassistant.components.plex.const.X_PLEX_DEVICE_NAME = "Home Assistant"

Definition at line 50 of file const.py.

◆ X_PLEX_PLATFORM

string homeassistant.components.plex.const.X_PLEX_PLATFORM = "Home Assistant"

Definition at line 51 of file const.py.

◆ X_PLEX_PRODUCT

string homeassistant.components.plex.const.X_PLEX_PRODUCT = "Home Assistant"

Definition at line 52 of file const.py.

◆ X_PLEX_VERSION

homeassistant.components.plex.const.X_PLEX_VERSION = __version__

Definition at line 53 of file const.py.