list_photo_transcode
Transcodes an image from a source URL to your chosen format, dimensions, and quality. Adjust rotation, blur, saturation, opacity, and more for customized output.
Instructions
Transcode an image.
GET /photo/:/transcode
Args:
url: 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.
format: The output format for the image; defaults to jpg
width: The desired width of the output image
height: The desired height of the output image
quality: The desired quality of the output. -1 means the highest quality. Defaults to -1
background: The background color to apply before painting the image. Only really applicable if image has transparency. Defaults to none
upscale: Indicates if image should be upscaled to the desired width/height. Defaults to false
min_size: 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.
rotate: Obey the rotation values specified in EXIF data. Defaults to true.
blur: Apply a blur to the image, Defaults to 0 (none)
saturation: Scale the image saturation by the specified percentage. Defaults to 100
opacity: Render the image at the specified opacity percentage. Defaults to 100
chroma_subsampling: Use the specified chroma subsambling.
0: 411
1: 420
2: 422
3: 444 Defaults to 3 (444) blend_color: The color to blend with the image. Defaults to none
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| blur | No | ||
| width | No | ||
| format | No | ||
| height | No | ||
| rotate | No | ||
| opacity | No | ||
| quality | No | ||
| upscale | No | ||
| min_size | No | ||
| background | No | ||
| saturation | No | ||
| blend_color | No | ||
| chroma_subsampling | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |