Class PlexClient

Main class for interacting with a Plex client. This class can connect directly to the client and control it or proxy commands through your Plex Server. To better understand the Plex client API's read this page: https://github.com/plexinc/plex-media-player/wiki/Remote-control-API Attributes: TAG (str): 'Player' key (str): '/resources' device (str): Best guess on the type of device this is (PS, iPhone, Linux, etc). deviceClass (str): Device class (pc, phone, etc). machineIdentifier (str): Unique ID for this device. model (str): Unknown platform (str): Unknown platformVersion (str): Description product (str): Client Product (Plex for iOS, etc). protocol (str): Always seems ot be 'plex'. protocolCapabilities (list): List of client capabilities (navigation, playback, timeline, mirror, playqueues). protocolVersion (str): Protocol version (1, future proofing?) server (:class:~plexapi.server.PlexServer): Server this client is connected to. session (:class:~requests.Session): Session object used for connection. state (str): Unknown title (str): Name of this client (Johns iPhone, etc). token (str): X-Plex-Token used for authenication vendor (str): Unknown version (str): Device version (4.6.1, etc). _session (obj): Requests session object used to access this client. _proxyThroughServer (bool): Set to True after calling :func:~plexapi.client.PlexClient.proxyThroughServer() (default False).

Constructors

constructor

new PlexClient(options?: PlexOptions): PlexClient
Parameters
- options: PlexOptions = {}
Returns PlexClient
- Defined in src/client.ts:139

Properties

_baseurl

_baseurl: string = null

HTTP address of the client

_proxyThroughServer

_proxyThroughServer: boolean = false

_server

_server: PlexServer = null

_token

_token: string = null

Token used to access this client

`Optional`deviceClass

deviceClass?: string

key

key: string = '/resources'

`Optional`machineIdentifier

machineIdentifier?: string

`Optional`platform

platform?: string

`Optional`platformVersion

platformVersion?: string

`Optional`product

product?: string

`Optional`protocol

protocol?: string

`Optional`protocolCapabilities

protocolCapabilities?: string[]

`Optional`protocolVersion

protocolVersion?: string

TAG

TAG: string = 'Player'

timeout

timeout: number

`Optional`title

title?: string

Methods

connect

connect(): Promise<void>
Alias of reload as any subsequent requests to this client will be made directly to the device even if the object attributes were initially populated from a PlexServer.

Returns Promise<void>
- Defined in src/client.ts:160

contextMenu

contextMenu(): Promise<any>
Open the context menu on the client.

Returns Promise<any>
- Defined in src/client.ts:281

goBack

goBack(): Promise<any>
Navigate back on the client.

Returns Promise<any>
- Defined in src/client.ts:286

goToHome

goToHome(): Promise<any>
Navigate to home on the client.

Returns Promise<any>
- Defined in src/client.ts:291

goToMusic

goToMusic(): Promise<any>
Navigate to music on the client.

Returns Promise<any>
- Defined in src/client.ts:296

isPlayingMedia

isPlayingMedia(includePaused?: boolean): Promise<boolean>
Returns true if the client is currently playing media.
Parameters
- includePaused: boolean = false
  If true, paused media counts as playing.
Returns Promise<boolean>
- Defined in src/client.ts:669

moveDown

moveDown(): Promise<any>
Move selection down.

Returns Promise<any>
- Defined in src/client.ts:301

moveLeft

moveLeft(): Promise<any>
Move selection left.

Returns Promise<any>
- Defined in src/client.ts:306

moveRight

moveRight(): Promise<any>
Move selection right.

Returns Promise<any>
- Defined in src/client.ts:311

moveUp

moveUp(): Promise<any>
Move selection up.

Returns Promise<any>
- Defined in src/client.ts:316

nextLetter

nextLetter(): Promise<any>
Jump to next letter in lists.

Returns Promise<any>
- Defined in src/client.ts:321

pageDown

pageDown(): Promise<any>
Page down in lists.

Returns Promise<any>
- Defined in src/client.ts:326

pageUp

pageUp(): Promise<any>
Page up in lists.

Returns Promise<any>
- Defined in src/client.ts:331

pause

pause(mtype?: string): Promise<any>
Pause playback.
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:369

play

play(mtype?: string): Promise<any>
Start or resume playback.
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:356

playMedia

playMedia(media: any, options?: PlayMediaOptions): Promise<any>
Start playback of media using a play queue.
Parameters
- media: any
  A Playable media item with a playlistItemID or ratingKey.
- options: PlayMediaOptions = {}
  Playback options.
Returns Promise<any>
- Defined in src/client.ts:596

previousLetter

previousLetter(): Promise<any>
Jump to previous letter in lists.

Returns Promise<any>
- Defined in src/client.ts:336

proxyThroughServer

proxyThroughServer(value?: boolean, server?: PlexServer): void
Toggle or set proxy-through-server mode. When enabled, commands are sent through the Plex server rather than directly to the client.
Parameters
- Optionalvalue: boolean
  Enable or disable proxy mode. If omitted, toggles current state.
- Optionalserver: PlexServer
  The PlexServer to proxy through. Required if not already set.
Returns void
- Defined in src/client.ts:229

query

query<T>(
    path: string,
    method?: "put" | "get" | "post" | "patch" | "head" | "delete",
    headers?: Record<string, string>,
): Promise<T>
Main method used to handle HTTPS requests to the Plex client. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. TODO: use headers
Type Parameters
- T
Parameters
- path: string
- method: "put" | "get" | "post" | "patch" | "head" | "delete" = 'get'
- Optionalheaders: Record<string, string>
Returns Promise<T>
- Defined in src/client.ts:182

reload

reload(): Promise<void>
Returns Promise<void>
Alias
PlexClient.connect
- Defined in src/client.ts:168

seekTo

seekTo(offset: number, mtype?: string): Promise<any>
Seek to the specified offset in milliseconds.
Parameters
- offset: number
  Position in milliseconds.
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:396

select

select(): Promise<any>
Select the current item.

Returns Promise<any>
- Defined in src/client.ts:341

sendCommand

sendCommand(command: string, params?: SendCommandParams): Promise<any>
Send a command to the client, either directly or via the server proxy.
Parameters
- command: string
  The player command path (e.g. 'playback/play').
- params: SendCommandParams = {}
  Additional parameters for the command.
Returns Promise<any>
- Defined in src/client.ts:252

setAudioStream

setAudioStream(audioStreamID: number, mtype?: string): Promise<any>
Set the active audio stream.
Parameters
- audioStreamID: number
  ID of the audio stream.
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:569

setParameters

setParameters(options: SetParametersOptions): Promise<any>
Set multiple playback parameters at once.
Parameters
- options: SetParametersOptions
  Parameters to set.
Returns Promise<any>
- Defined in src/client.ts:517

setRepeat

setRepeat(repeat: number, mtype?: string): Promise<any>
Set repeat mode.
Parameters
- repeat: number
  Repeat mode (0=off, 1=repeat one, 2=repeat all).
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:476

setShuffle

setShuffle(shuffle: number, mtype?: string): Promise<any>
Set shuffle mode.
Parameters
- shuffle: number
  Shuffle mode (0=off, 1=on).
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:490

setStreams

setStreams(options: SetStreamsOptions): Promise<any>
Set the active audio, subtitle, or video stream.
Parameters
- options: SetStreamsOptions
  Stream selection options.
Returns Promise<any>
- Defined in src/client.ts:543

setSubtitleStream

setSubtitleStream(subtitleStreamID: number, mtype?: string): Promise<any>
Set the active subtitle stream.
Parameters
- subtitleStreamID: number
  ID of the subtitle stream. Use 0 to disable subtitles.
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:578

setVideoStream

setVideoStream(videoStreamID: number, mtype?: string): Promise<any>
Set the active video stream.
Parameters
- videoStreamID: number
  ID of the video stream.
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:587

setVolume

setVolume(volume: number, mtype?: string): Promise<any>
Set volume level.
Parameters
- volume: number
  Volume level (0-100).
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:504

skipNext

skipNext(mtype?: string): Promise<any>
Skip to the next item.
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:409

skipPrevious

skipPrevious(mtype?: string): Promise<any>
Skip to the previous item.
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:422

stepBack

stepBack(mtype?: string): Promise<any>
Step back (small rewind).
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:449

stepForward

stepForward(mtype?: string): Promise<any>
Step forward (small fast-forward).
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:462

stop

stop(mtype?: string): Promise<any>
Stop playback.
Parameters
- Optionalmtype: string
  Media type filter (video, music, photo).
Returns Promise<any>
- Defined in src/client.ts:382

timeline

timeline(): Promise<ClientTimeline>
Returns the active (non-stopped) timeline, or undefined if nothing is playing.

Returns Promise<ClientTimeline>
- Defined in src/client.ts:660

timelines

timelines(wait?: number): Promise<ClientTimeline[]>
Poll the client for timeline data (what is currently playing).
Parameters
- Optionalwait: number
  Time in seconds to wait for a response.
Returns Promise<ClientTimeline[]>
- Defined in src/client.ts:623

toggleOSD

toggleOSD(): Promise<any>
Toggle the on-screen display.

Returns Promise<any>
- Defined in src/client.ts:346

url

url(key: string, options?: { includeToken?: boolean }): URL
Build a URL string with proper token argument. Token will be appended to the URL if either includeToken is True or TODO: CONFIG.log.show_secrets is 'true'.
Parameters
- key: string
- options: { includeToken?: boolean } = {}
Returns URL
- Defined in src/client.ts:205

Class PlexClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlexClient

Properties

_baseurl

_proxyThroughServer

_server

_token

OptionaldeviceClass

key

OptionalmachineIdentifier

Optionalplatform

OptionalplatformVersion

Optionalproduct

Optionalprotocol

OptionalprotocolCapabilities

OptionalprotocolVersion

TAG

timeout

Optionaltitle

Methods

connect

Returns Promise<void>

contextMenu

Returns Promise<any>

goBack

Returns Promise<any>

goToHome

Returns Promise<any>

goToMusic

Returns Promise<any>

isPlayingMedia

Parameters

Returns Promise<boolean>

moveDown

Returns Promise<any>

moveLeft

Returns Promise<any>

moveRight

Returns Promise<any>

moveUp

Returns Promise<any>

nextLetter

Returns Promise<any>

pageDown

Returns Promise<any>

pageUp

Returns Promise<any>

pause

Parameters

Returns Promise<any>

play

Parameters

Returns Promise<any>

playMedia

Parameters

Returns Promise<any>

previousLetter

Returns Promise<any>

proxyThroughServer

Parameters

Returns void

query

Type Parameters

Parameters

Returns Promise<T>

reload

Returns Promise<void>

Alias

seekTo

Parameters

Returns Promise<any>

select

Returns Promise<any>

`Optional`deviceClass

`Optional`machineIdentifier

`Optional`platform

`Optional`platformVersion

`Optional`product

`Optional`protocol

`Optional`protocolCapabilities

`Optional`protocolVersion

`Optional`title