mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
37 lines
9.9 KiB
Markdown
37 lines
9.9 KiB
Markdown
# GetPlayQueueRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetPlayQueueRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: GetPlayQueueRequest = {
|
|
playQueueId: 868034,
|
|
own: BoolInt.True,
|
|
includeBefore: BoolInt.True,
|
|
includeAfter: 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 |
|
|
| `playQueueId` | *number* | :heavy_check_mark: | The ID of the play queue. | |
|
|
| `own` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | If the server should transfer ownership to the requesting client (used in remote control scenarios). | 1 |
|
|
| `center` | *string* | :heavy_minus_sign: | The play queue item ID for the center of the window - this doesn't change the current selected item. | |
|
|
| `window` | *number* | :heavy_minus_sign: | How many items on each side of the center of the window | |
|
|
| `includeBefore` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether to include the items before the center (if 0, center is not included either), defaults to 1. | 1 |
|
|
| `includeAfter` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether to include the items after the center (if 0, center is not included either), defaults to 1. | 1 | |