Class PlexClient

constructor

• new PlexClient(__namedParameters?: PlexClientOptions): PlexClient

  Parameters

  • __namedParameters: PlexClientOptions = {}

  Returns PlexClient

Optionaladdress

Readonlybaseurl

Optionaldevice

OptionaldeviceClass

Readonlykey

Optionallocal

OptionalmachineIdentifier

Optionalmodel

Optionalplatform

OptionalplatformVersion

Optionalproduct

Optionalprofile

Optionalprotocol

protocolCapabilities

OptionalprotocolVersion

Optionalrelayed

OptionalremotePublicAddress

Optionalsecure

Optionalserver

Optionalstate

timeout

Optionaltitle

OptionaluserID

Optionalvendor

Optionalversion

isProxied

• get isProxied(): boolean

  True when commands are sent through PlexClient.server instead of the client.

  Returns boolean

connect

• connect(): Promise<PlexClient>

  Load attributes directly from the client. Later commands go straight to the device even if this object was first populated from a server's client list.

  Returns Promise<PlexClient>

contextMenu

• contextMenu(): Promise<void>

  Open the context menu on the client.

  Returns Promise<void>

createPlayQueue

• createPlayQueue(
      items: PlayQueueSource,
      __namedParameters?: CreateClientPlayQueueOptions,
  ): Promise<void>

  Create a play queue on the client and start playing it. Preferred over playMedia.

  Parameters

  • items: PlayQueueSource
  • __namedParameters: CreateClientPlayQueueOptions = {}

  Returns Promise<void>

goBack

• goBack(): Promise<void>

  Navigate back on the client.

  Returns Promise<void>

goToHome

• goToHome(): Promise<void>

  Navigate to home on the client.

  Returns Promise<void>

goToMedia

• goToMedia(
      media: { key: string; server: PlexServer },
      params?: SendCommandParams,
  ): Promise<void>

  Show the details page for a media item on the client.

  Parameters

  • media: { key: string; server: PlexServer }
  • params: SendCommandParams = {}

  Returns Promise<void>

goToMusic

• goToMusic(): Promise<void>

  Navigate to music on the client.

  Returns Promise<void>

isPlayingMedia

• isPlayingMedia(__namedParameters?: IsPlayingMediaOptions): Promise<boolean>

  Returns true if any of the client's players (video, music, photo) is playing.

  Parameters

  • __namedParameters: IsPlayingMediaOptions = {}

  Returns Promise<boolean>

moveDown

• moveDown(): Promise<void>

  Move selection down.

  Returns Promise<void>

moveLeft

• moveLeft(): Promise<void>

  Move selection left.

  Returns Promise<void>

moveRight

• moveRight(): Promise<void>

  Move selection right.

  Returns Promise<void>

moveUp

• moveUp(): Promise<void>

  Move selection up.

  Returns Promise<void>

nextLetter

• nextLetter(): Promise<void>

  Jump to next letter in lists.

  Returns Promise<void>

pageDown

• pageDown(): Promise<void>

  Page down in lists.

  Returns Promise<void>

pageUp

• pageUp(): Promise<void>

  Page up in lists.

  Returns Promise<void>

pause

• pause(__namedParameters?: ClientCommandOptions): Promise<void>

  Pause playback.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

play

• play(__namedParameters?: ClientCommandOptions): Promise<void>

  Start or resume playback.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

playMedia

• playMedia(
      media: PlayableMedia,
      __namedParameters?: PlayMediaOptions,
  ): Promise<void>

  Play a media item, playlist, or play queue on the client. This is the legacy command; prefer PlexClient.createPlayQueue for modern players.

  Parameters

  • media: PlayableMedia
  • __namedParameters: PlayMediaOptions = {}

  Returns Promise<void>

previousLetter

• previousLetter(): Promise<void>

  Jump to previous letter in lists.

  Returns Promise<void>

proxyThroughServer

• proxyThroughServer(__namedParameters?: ProxyThroughServerOptions): this

  Send future commands through the Plex server instead of directly to the client. Useful when the client is not reachable from this machine.

  Parameters

  • __namedParameters: ProxyThroughServerOptions = {}

  Returns this

query

• query<T = unknown>(__namedParameters: PlexClientQueryOptions): Promise<T>

  Send a request to the client. Players answer in JSON, XML, or plain text depending on the product, so XML is converted to the same shape as Plex JSON responses.

  Type Parameters

  • T = unknown

  Parameters

  • __namedParameters: PlexClientQueryOptions

  Returns Promise<T>

refreshPlayQueue

• refreshPlayQueue(
      playQueue: number | PlayQueue,
      __namedParameters?: ClientCommandOptions,
  ): Promise<void>

  Ask the client to reload a play queue after it changed on the server.

  Parameters

  • playQueue: number | PlayQueue
  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

reload

• reload(): Promise<PlexClient>

  Alias for PlexClient.connect.

  Returns Promise<PlexClient>

seekTo

• seekTo(offset: number, __namedParameters?: ClientCommandOptions): Promise<void>

  Seek to a position in the current item.

  Parameters

  • offset: number

    Position in milliseconds.

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

select

• select(): Promise<void>

  Select the current item.

  Returns Promise<void>

sendCommand

• sendCommand(
      command: string,
      params?: SendCommandParams,
      __namedParameters?: SendCommandOptions,
  ): Promise<unknown>

  Send a remote-control command such as playback/play to the client.

  Parameters

  • command: string

    Command in the form <controller>/<command>.

  • params: SendCommandParams = {}
  • __namedParameters: SendCommandOptions = {}

  Returns Promise<unknown>

setAudioStream

• setAudioStream(
      audioStreamID: number,
      options?: ClientCommandOptions,
  ): Promise<void>

  Set the active audio stream.

  Parameters

  • audioStreamID: number
  • options: ClientCommandOptions = {}

  Returns Promise<void>

setParameters

• setParameters(__namedParameters: SetParametersOptions): Promise<void>

  Set several playback parameters at once.

  Parameters

  • __namedParameters: SetParametersOptions

  Returns Promise<void>

setRepeat

• setRepeat(
      repeat: ClientRepeatMode,
      options?: ClientCommandOptions,
  ): Promise<void>

  Set the repeat mode.

  Parameters

  • repeat: ClientRepeatMode
  • options: ClientCommandOptions = {}

  Returns Promise<void>

setShuffle

• setShuffle(shuffle: boolean, options?: ClientCommandOptions): Promise<void>

  Turn shuffle on or off.

  Parameters

  • shuffle: boolean
  • options: ClientCommandOptions = {}

  Returns Promise<void>

setStreams

• setStreams(__namedParameters: SetStreamsOptions): Promise<void>

  Set the active audio, subtitle, or video stream.

  Parameters

  • __namedParameters: SetStreamsOptions

  Returns Promise<void>

setSubtitleStream

• setSubtitleStream(
      subtitleStreamID: number,
      options?: ClientCommandOptions,
  ): Promise<void>

  Set the active subtitle stream.

  Parameters

  • subtitleStreamID: number

    Subtitle stream id, or 0 to disable subtitles.

  • options: ClientCommandOptions = {}

  Returns Promise<void>

setVideoStream

• setVideoStream(
      videoStreamID: number,
      options?: ClientCommandOptions,
  ): Promise<void>

  Set the active video stream.

  Parameters

  • videoStreamID: number
  • options: ClientCommandOptions = {}

  Returns Promise<void>

setVolume

• setVolume(volume: number, options?: ClientCommandOptions): Promise<void>

  Set the volume.

  Parameters

  • volume: number

    Volume level from 0 to 100.

  • options: ClientCommandOptions = {}

  Returns Promise<void>

skipNext

• skipNext(__namedParameters?: ClientCommandOptions): Promise<void>

  Skip to the next item.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

skipPrevious

• skipPrevious(__namedParameters?: ClientCommandOptions): Promise<void>

  Skip to the previous item.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

skipTo

• skipTo(key: string, __namedParameters?: ClientCommandOptions): Promise<void>

  Skip to an item in the current play queue.

  Parameters

  • key: string

    Key of the item to play.

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

stepBack

• stepBack(__namedParameters?: ClientCommandOptions): Promise<void>

  Step back a few seconds.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

stepForward

• stepForward(__namedParameters?: ClientCommandOptions): Promise<void>

  Step forward a few seconds.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

stop

• stop(__namedParameters?: ClientCommandOptions): Promise<void>

  Stop playback.

  Parameters

  • __namedParameters: ClientCommandOptions = {}

  Returns Promise<void>

timeline

• timeline(): Promise<ClientTimeline | undefined>

  Returns the active (non-stopped) timeline, or undefined if nothing is playing.

  Returns Promise<ClientTimeline | undefined>

timelines

• timelines(__namedParameters?: TimelinesOptions): Promise<ClientTimeline[]>

  Poll the client for what it is currently playing.

  Parameters

  • __namedParameters: TimelinesOptions = {}

  Returns Promise<ClientTimeline[]>

toggleOSD

• toggleOSD(): Promise<void>

  Toggle the on-screen display.

  Returns Promise<void>

url

• url(key: string, __namedParameters?: { includeToken?: boolean }): URL

  Build a URL for this client, optionally including its token.

  Parameters

  • key: string
  • __namedParameters: { includeToken?: boolean } = {}

  Returns URL