# TranscodeImageRequest


## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                               | Example                                                                                                                                                                                                                                                                                                                                                                                                   |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts`                                                                                                                                                                                                                                                                                                                                                                                                 | [Optional[components.Accepts]](../../models/components/accepts.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates the client accepts the indicated media types                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `client_identifier`                                                                                                                                                                                                                                                                                                                                                                                       | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | An opaque identifier unique to the client                                                                                                                                                                                                                                                                                                                                                                 | abc123                                                                                                                                                                                                                                                                                                                                                                                                    |
| `product`                                                                                                                                                                                                                                                                                                                                                                                                 | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The name of the client product                                                                                                                                                                                                                                                                                                                                                                            | Plex for Roku                                                                                                                                                                                                                                                                                                                                                                                             |
| `version`                                                                                                                                                                                                                                                                                                                                                                                                 | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The version of the client application                                                                                                                                                                                                                                                                                                                                                                     | 2.4.1                                                                                                                                                                                                                                                                                                                                                                                                     |
| `platform`                                                                                                                                                                                                                                                                                                                                                                                                | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The platform of the client                                                                                                                                                                                                                                                                                                                                                                                | Roku                                                                                                                                                                                                                                                                                                                                                                                                      |
| `platform_version`                                                                                                                                                                                                                                                                                                                                                                                        | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The version of the platform                                                                                                                                                                                                                                                                                                                                                                               | 4.3 build 1057                                                                                                                                                                                                                                                                                                                                                                                            |
| `device`                                                                                                                                                                                                                                                                                                                                                                                                  | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A relatively friendly name for the client device                                                                                                                                                                                                                                                                                                                                                          | Roku 3                                                                                                                                                                                                                                                                                                                                                                                                    |
| `model`                                                                                                                                                                                                                                                                                                                                                                                                   | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A potentially less friendly identifier for the device model                                                                                                                                                                                                                                                                                                                                               | 4200X                                                                                                                                                                                                                                                                                                                                                                                                     |
| `device_vendor`                                                                                                                                                                                                                                                                                                                                                                                           | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The device vendor                                                                                                                                                                                                                                                                                                                                                                                         | Roku                                                                                                                                                                                                                                                                                                                                                                                                      |
| `device_name`                                                                                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A friendly name for the client                                                                                                                                                                                                                                                                                                                                                                            | Living Room TV                                                                                                                                                                                                                                                                                                                                                                                            |
| `marketplace`                                                                                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The marketplace on which the client application is distributed                                                                                                                                                                                                                                                                                                                                            | googlePlay                                                                                                                                                                                                                                                                                                                                                                                                |
| `url`                                                                                                                                                                                                                                                                                                                                                                                                     | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :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_`                                                                                                                                                                                                                                                                                                                                                                                                 | [Optional[operations.Format]](../../models/operations/format_.md)                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The output format for the image; defaults to jpg                                                                                                                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `width`                                                                                                                                                                                                                                                                                                                                                                                                   | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The desired width of the output image                                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `height`                                                                                                                                                                                                                                                                                                                                                                                                  | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The desired height of the output image                                                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `quality`                                                                                                                                                                                                                                                                                                                                                                                                 | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The desired quality of the output.  -1 means the highest quality.  Defaults to -1                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `background`                                                                                                                                                                                                                                                                                                                                                                                              | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The background color to apply before painting the image.  Only really applicable if image has transparency.  Defaults to none                                                                                                                                                                                                                                                                             | #ff5522                                                                                                                                                                                                                                                                                                                                                                                                   |
| `upscale`                                                                                                                                                                                                                                                                                                                                                                                                 | [Optional[components.BoolInt]](../../models/components/boolint.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates if image should be upscaled to the desired width/height.  Defaults to false                                                                                                                                                                                                                                                                                                                     | 1                                                                                                                                                                                                                                                                                                                                                                                                         |
| `min_size`                                                                                                                                                                                                                                                                                                                                                                                                | [Optional[components.BoolInt]](../../models/components/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`                                                                                                                                                                                                                                                                                                                                                                                                  | [Optional[components.BoolInt]](../../models/components/boolint.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Obey the rotation values specified in EXIF data.  Defaults to true.                                                                                                                                                                                                                                                                                                                                       | 1                                                                                                                                                                                                                                                                                                                                                                                                         |
| `blur`                                                                                                                                                                                                                                                                                                                                                                                                    | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Apply a blur to the image, Defaults to 0 (none)                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `saturation`                                                                                                                                                                                                                                                                                                                                                                                              | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Scale the image saturation by the specified percentage.  Defaults to 100                                                                                                                                                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `opacity`                                                                                                                                                                                                                                                                                                                                                                                                 | *Optional[int]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Render the image at the specified opacity percentage.  Defaults to 100                                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `chroma_subsampling`                                                                                                                                                                                                                                                                                                                                                                                      | [Optional[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)                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `blend_color`                                                                                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The color to blend with the image.  Defaults to none                                                                                                                                                                                                                                                                                                                                                      | #ff5522                                                                                                                                                                                                                                                                                                                                                                                                   |