plexjs/docs/sdk/models/operations/createplayqueuerequest.md

CreatePlayQueueRequest

Example Usage

import { CreatePlayQueueRequest, CreatePlayQueueType } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt } from "@lukehagar/plexjs/sdk/models/shared";

let value: CreatePlayQueueRequest = {
  type: CreatePlayQueueType.Audio,
  shuffle: BoolInt.One,
  repeat: BoolInt.One,
  continuous: BoolInt.One,
  recursive: BoolInt.One,
  onDeck: BoolInt.One,
};

Fields

Field	Type	Required	Description	Example
accepts	shared.Accepts	➖	Indicates the client accepts the indicated media types
clientIdentifier	string	➖	An opaque identifier unique to the client	abc123
product	string	➖	The name of the client product	Plex for Roku
version	string	➖	The version of the client application	2.4.1
platform	string	➖	The platform of the client	Roku
platformVersion	string	➖	The version of the platform	4.3 build 1057
device	string	➖	A relatively friendly name for the client device	Roku 3
model	string	➖	A potentially less friendly identifier for the device model	4200X
deviceVendor	string	➖	The device vendor	Roku
deviceName	string	➖	A friendly name for the client	Living Room TV
marketplace	string	➖	The marketplace on which the client application is distributed	googlePlay
uri	string	➖	The content URI for what we're playing.
playlistID	number	➖	the ID of the playlist we're playing.
type	operations.CreatePlayQueueType	✔️	The type of play queue to create
key	string	➖	The key of the first item to play, defaults to the first in the play queue.
shuffle	shared.BoolInt	➖	Whether to shuffle the playlist, defaults to 0.	1
repeat	shared.BoolInt	➖	If the PQ is bigger than the window, fill any empty space with wraparound items, defaults to 0.	1
continuous	shared.BoolInt	➖	Whether to create a continuous play queue (e.g. from an episode), defaults to 0.	1
extrasPrefixCount	number	➖	Number of trailers to prepend a movie with not including the pre-roll. If omitted the pre-roll will not be returned in the play queue. When resuming a movie extrasPrefixCount should be omitted as a parameter instead of passing 0.
recursive	shared.BoolInt	➖	Only applies to queues of type photo, whether to retrieve all descendent photos from an album or section, defaults to 1.	1
onDeck	shared.BoolInt	➖	Only applies to queues of type show or seasons, whether to return a queue that is started on the On Deck episode if one exists. Otherwise begins the play queue on the beginning of the show or season.	1