mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 20:47:46 +00:00
41 lines
13 KiB
Markdown
41 lines
13 KiB
Markdown
# GetImageRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetImageRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: GetImageRequest = {
|
|
topLeft: "3f280a",
|
|
topRight: "6b4713",
|
|
bottomRight: "0f2a43",
|
|
bottomLeft: "1c425d",
|
|
width: 1920,
|
|
height: 1080,
|
|
noise: 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 |
|
|
| `topLeft` | *string* | :heavy_minus_sign: | The base color (hex) for the top left quadrant. | 3f280a |
|
|
| `topRight` | *string* | :heavy_minus_sign: | The base color (hex) for the top right quadrant. | 6b4713 |
|
|
| `bottomRight` | *string* | :heavy_minus_sign: | The base color (hex) for the bottom right quadrant. | 0f2a43 |
|
|
| `bottomLeft` | *string* | :heavy_minus_sign: | The base color (hex) for the bottom left quadrant. | 1c425d |
|
|
| `width` | *number* | :heavy_minus_sign: | Width in pixels for the image. | 1920 |
|
|
| `height` | *number* | :heavy_minus_sign: | Height in pixels for the image. | 1080 |
|
|
| `noise` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether to add noise to the ouput image. Noise can reduce color banding with the gradients. Image sizes with noise will be larger. | 1 | |