mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
47 lines
53 KiB
Markdown
47 lines
53 KiB
Markdown
# TranscodeImageRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { TranscodeImageRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: TranscodeImageRequest = {
|
|
url: "/library/metadata/265/thumb/1715112705",
|
|
background: "#ff5522",
|
|
upscale: BoolInt.True,
|
|
minSize: BoolInt.True,
|
|
rotate: BoolInt.True,
|
|
blendColor: "#ff5522",
|
|
};
|
|
```
|
|
|
|
## 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 |
|
|
| `url` | *string* | :heavy_minus_sign: | The source URL for the image to transcode. Note, if this URL requires a token such as `X-Plex-Token`, it should be given as a query parameter to this url. | /library/metadata/265/thumb/1715112705 |
|
|
| `format` | [operations.Format](../../models/operations/format.md) | :heavy_minus_sign: | The output format for the image; defaults to jpg | |
|
|
| `width` | *number* | :heavy_minus_sign: | The desired width of the output image | |
|
|
| `height` | *number* | :heavy_minus_sign: | The desired height of the output image | |
|
|
| `quality` | *number* | :heavy_minus_sign: | The desired quality of the output. -1 means the highest quality. Defaults to -1 | |
|
|
| `background` | *string* | :heavy_minus_sign: | The background color to apply before painting the image. Only really applicable if image has transparency. Defaults to none | #ff5522 |
|
|
| `upscale` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if image should be upscaled to the desired width/height. Defaults to false | 1 |
|
|
| `minSize` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Indicates if image should be scaled to fit the smaller dimension. By default (false) the image is scaled to fit within the width/height specified but if this parameter is true, it will allow overflowing one dimension to fit the other. Essentially it is making the width/height minimum sizes of the image or sizing the image to fill the entire width/height even if it overflows one dimension. | 1 |
|
|
| `rotate` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Obey the rotation values specified in EXIF data. Defaults to true. | 1 |
|
|
| `blur` | *number* | :heavy_minus_sign: | Apply a blur to the image, Defaults to 0 (none) | |
|
|
| `saturation` | *number* | :heavy_minus_sign: | Scale the image saturation by the specified percentage. Defaults to 100 | |
|
|
| `opacity` | *number* | :heavy_minus_sign: | Render the image at the specified opacity percentage. Defaults to 100 | |
|
|
| `chromaSubsampling` | [operations.ChromaSubsampling](../../models/operations/chromasubsampling.md) | :heavy_minus_sign: | Use the specified chroma subsambling.<br/> - 0: 411<br/> - 1: 420<br/> - 2: 422<br/> - 3: 444<br/>Defaults to 3 (444) | |
|
|
| `blendColor` | *string* | :heavy_minus_sign: | The color to blend with the image. Defaults to none | #ff5522 | |