| Field | Type | Required | Description | Example |
|---|---|---|---|---|
accepts |
Optional<Accepts> | ➖ | Indicates the client accepts the indicated media types | |
clientIdentifier |
Optional<String> | ➖ | An opaque identifier unique to the client | abc123 |
product |
Optional<String> | ➖ | The name of the client product | Plex for Roku |
version |
Optional<String> | ➖ | The version of the client application | 2.4.1 |
platform |
Optional<String> | ➖ | The platform of the client | Roku |
platformVersion |
Optional<String> | ➖ | The version of the platform | 4.3 build 1057 |
device |
Optional<String> | ➖ | A relatively friendly name for the client device | Roku 3 |
model |
Optional<String> | ➖ | A potentially less friendly identifier for the device model | 4200X |
deviceVendor |
Optional<String> | ➖ | The device vendor | Roku |
deviceName |
Optional<String> | ➖ | A friendly name for the client | Living Room TV |
marketplace |
Optional<String> | ➖ | The marketplace on which the client application is distributed | googlePlay |
url |
Optional<String> | ➖ | 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<Format> | ➖ | The output format for the image; defaults to jpg | |
width |
Optional<Long> | ➖ | The desired width of the output image | |
height |
Optional<Long> | ➖ | The desired height of the output image | |
quality |
Optional<Long> | ➖ | The desired quality of the output. -1 means the highest quality. Defaults to -1 | |
background |
Optional<String> | ➖ | The background color to apply before painting the image. Only really applicable if image has transparency. Defaults to none | #ff5522 |
upscale |
Optional<BoolInt> | ➖ | Indicates if image should be upscaled to the desired width/height. Defaults to false | 1 |
minSize |
Optional<BoolInt> | ➖ | 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<BoolInt> | ➖ | Obey the rotation values specified in EXIF data. Defaults to true. | 1 |
blur |
Optional<Long> | ➖ | Apply a blur to the image, Defaults to 0 (none) | |
saturation |
Optional<Long> | ➖ | Scale the image saturation by the specified percentage. Defaults to 100 | |
opacity |
Optional<Long> | ➖ | Render the image at the specified opacity percentage. Defaults to 100 | |
chromaSubsampling |
Optional<ChromaSubsampling> | ➖ | Use the specified chroma subsambling. - 0: 411 - 1: 420 - 2: 422 - 3: 444 Defaults to 3 (444) |
|
blendColor |
Optional<String> | ➖ | The color to blend with the image. Defaults to none | #ff5522 |