| Field | Type | Required | Description | Example |
|---|---|---|---|---|
accepts |
Optional<Accepts> | ➖ | Indicates the client accepts the indicated media types | |
clientIdentifier |
Optional<String> | ➖ | An opaque identifier unique to the client | abc123 |
product |
Optional<String> | ➖ | The name of the client product | Plex for Roku |
version |
Optional<String> | ➖ | The version of the client application | 2.4.1 |
platform |
Optional<String> | ➖ | The platform of the client | Roku |
platformVersion |
Optional<String> | ➖ | The version of the platform | 4.3 build 1057 |
device |
Optional<String> | ➖ | A relatively friendly name for the client device | Roku 3 |
model |
Optional<String> | ➖ | A potentially less friendly identifier for the device model | 4200X |
deviceVendor |
Optional<String> | ➖ | The device vendor | Roku |
deviceName |
Optional<String> | ➖ | A friendly name for the client | Living Room TV |
marketplace |
Optional<String> | ➖ | The marketplace on which the client application is distributed | googlePlay |
uri |
Optional<String> | ➖ | The content URI for what we're playing. | |
playlistID |
Optional<Long> | ➖ | the ID of the playlist we're playing. | |
mediaType |
Type | ✔️ | The type of play queue to create | |
key |
Optional<String> | ➖ | The key of the first item to play, defaults to the first in the play queue. | |
shuffle |
Optional<BoolInt> | ➖ | Whether to shuffle the playlist, defaults to 0. | 1 |
repeat |
Optional<BoolInt> | ➖ | If the PQ is bigger than the window, fill any empty space with wraparound items, defaults to 0. | 1 |
continuous |
Optional<BoolInt> | ➖ | Whether to create a continuous play queue (e.g. from an episode), defaults to 0. | 1 |
extrasPrefixCount |
Optional<Long> | ➖ | 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 |
Optional<BoolInt> | ➖ | Only applies to queues of type photo, whether to retrieve all descendent photos from an album or section, defaults to 1. | 1 |
onDeck |
Optional<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 |