mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
35 lines
11 KiB
Markdown
35 lines
11 KiB
Markdown
# GetMediaPartRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetMediaPartRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: GetMediaPartRequest = {
|
|
partId: 488589,
|
|
changestamp: 145976,
|
|
filename: "example.file",
|
|
download: 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 |
|
|
| `partId` | *number* | :heavy_check_mark: | The part id who's index is to be fetched | |
|
|
| `changestamp` | *number* | :heavy_check_mark: | The changestamp of the part; used for busting potential caches. Provided in the `key` for the part | |
|
|
| `filename` | *string* | :heavy_check_mark: | A generic filename used for a client media stack which relies on the extension in the request. Provided in the `key` for the part | |
|
|
| `download` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether this is a file download | 1 | |