mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
43 lines
27 KiB
Markdown
43 lines
27 KiB
Markdown
# CreatePlayQueueRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { CreatePlayQueueRequest, CreatePlayQueueType } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: CreatePlayQueueRequest = {
|
|
type: CreatePlayQueueType.Audio,
|
|
shuffle: BoolInt.True,
|
|
repeat: BoolInt.True,
|
|
continuous: BoolInt.True,
|
|
recursive: BoolInt.True,
|
|
onDeck: BoolInt.True,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
|
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
|
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
|
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
|
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
|
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
|
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
|
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
|
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
|
| `uri` | *string* | :heavy_minus_sign: | The content URI for what we're playing. | |
|
|
| `playlistID` | *number* | :heavy_minus_sign: | the ID of the playlist we're playing. | |
|
|
| `type` | [operations.CreatePlayQueueType](../../models/operations/createplayqueuetype.md) | :heavy_check_mark: | The type of play queue to create | |
|
|
| `key` | *string* | :heavy_minus_sign: | The key of the first item to play, defaults to the first in the play queue. | |
|
|
| `shuffle` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether to shuffle the playlist, defaults to 0. | 1 |
|
|
| `repeat` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If the PQ is bigger than the window, fill any empty space with wraparound items, defaults to 0. | 1 |
|
|
| `continuous` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether to create a continuous play queue (e.g. from an episode), defaults to 0. | 1 |
|
|
| `extrasPrefixCount` | *number* | :heavy_minus_sign: | 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](../../models/shared/boolint.md) | :heavy_minus_sign: | 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](../../models/shared/boolint.md) | :heavy_minus_sign: | 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 | |