Class PlayQueue

constructor

• new PlayQueue(
      server: PlexServer,
      data: unknown,
      initpath?: string,
      parent?: PlexObject,
  ): PlayQueue

  Parameters

  • server: PlexServer
  • data: unknown
  • Optionalinitpath: string
  • Optionalparent: PlexObject

  Returns PlayQueue

identifier

mediaTagPrefix

mediaTagVersion

playQueueID

OptionalplayQueueLastAddedItemID

playQueueSelectedItemID

playQueueSelectedItemOffset

OptionalplayQueueSelectedMetadataItemID

playQueueShuffled

playQueueSourceURI

playQueueTotalCount

playQueueVersion

size

StaticTAG

StaticTYPE

items

• get items(): QueueItem[]

  Get items in the PlayQueue.

  Returns QueueItem[]

length

• get length(): number

  Get the length of the PlayQueue.

  Returns number

selectedItem

• get selectedItem(): QueueItem | undefined

  The currently selected item, when it is inside the loaded window of the PlayQueue.

  Returns QueueItem | undefined

addItem

• addItem(
      item: Playlist | Playable,
      options?: AddPlayQueueItemOptions,
  ): Promise<PlayQueue>

  Append an item to the "Up Next" section of the PlayQueue.

  Parameters

  • item: Playlist | Playable
  • options: AddPlayQueueItemOptions = {}

  Returns Promise<PlayQueue>

clear

• clear(): Promise<PlayQueue>

  Remove every item except the currently selected one from the PlayQueue.

  Returns Promise<PlayQueue>

contains

• contains(media: Playable): boolean

  Check if the PlayQueue contains the provided media item.

  Parameters

  • media: Playable

  Returns boolean

getItem

• getItem(index: number): Playable | null

  Get item at specific index.

  Parameters

  • index: number

  Returns Playable | null

getQueueItem

• getQueueItem(item: Playable): Playable

  Get a similar object from this PlayQueue. Useful for looking up playQueueItemIDs using items from the Library.

  Parameters

  • item: Playable

  Returns Playable

moveItem

• moveItem(item: Playable, options?: MovePlayQueueItemOptions): Promise<PlayQueue>

  Move an item to the beginning of the PlayQueue. If 'after' is provided, the item will be placed immediately after the specified item.

  Parameters

  • item: Playable
  • options: MovePlayQueueItemOptions = {}

  Returns Promise<PlayQueue>

refresh

• refresh(): Promise<void>

  Refresh the PlayQueue from the Plex server.

  Returns Promise<void>

reload

• reload(): Promise<void>

  Alias for PlayQueue.refresh.

  Returns Promise<void>

removeItem

• removeItem(
      item: Playable,
      __namedParameters?: RemovePlayQueueItemOptions,
  ): Promise<PlayQueue>

  Remove an item from the PlayQueue.

  Parameters

  • item: Playable
  • __namedParameters: RemovePlayQueueItemOptions = {}

  Returns Promise<PlayQueue>

Staticcreate

• create(
      server: PlexServer,
      items: PlayQueueSource,
      options?: CreatePlayQueueOptions,
  ): Promise<PlayQueue>

  Create and return a new PlayQueue.

  Parameters

  • server: PlexServer
  • items: PlayQueueSource
  • options: CreatePlayQueueOptions = {}

  Returns Promise<PlayQueue>

StaticcreateArgs

• createArgs(
      server: PlexServer,
      items: PlayQueueSource,
      options?: CreatePlayQueueOptions,
  ): Promise<Record<string, string | number | boolean>>

  Build the parameters used by server and client play queue creation commands.

  Parameters

  • server: PlexServer
  • items: PlayQueueSource
  • options: CreatePlayQueueOptions = {}

  Returns Promise<Record<string, string | number | boolean>>

StaticfromStationKey

• fromStationKey(server: PlexServer, key: string): Promise<PlayQueue>

  Create and return a new PlayQueue from a station key. This is a convenience method for radio stations.

  Parameters

  • server: PlexServer
  • key: string

  Returns Promise<PlayQueue>

Staticget

• get(
      server: PlexServer,
      playQueueID: number,
      options?: GetPlayQueueOptions,
  ): Promise<PlayQueue>

  Retrieve an existing PlayQueue by identifier.

  Parameters

  • server: PlexServer
  • playQueueID: number
  • options: GetPlayQueueOptions = {}

  Returns Promise<PlayQueue>