Documentation Dynamic Media Image Serving and Rendering API

fmt

Last update: July 31, 2024

Topics:
Dynamic Media Classic,SDK/API

CREATED FOR:

Developer
User

Response Image Format.

fmt=format[, [pixelType],[compression]]

`format`	Description
`avif-alpha`	Lossy and lossless AVIF with alpha channel.
`avif`	Lossy and lossless AVIF.
`eps`	Uncompressed binary Encapsulated PostScript.
`f4m`	Flash Streaming Server manifest format.
`gif-alpha`	GIF with 2 to 255 colors plus key-color transparency.
`gif`	GIF with 2 to 256 colors.
`heic`	Lossless HEIC. This format is downloaded by default from the browser if it is not supported.
`jpeg`	Lossy JPEG.
`jpeg2000-alpha`	Lossy and lossless JPEG 2000 with alpha channel.
`jpeg2000`	Lossy and lossless JPEG 2000.
`jpegxr-alpha`	Lossy and lossless JPEG XR with alpha channel.
`jpegxr`	Lossy and lossless JPEG XR.
`jpg`	Lossy JPG.
`m3u8`	Apple Streaming Server manifest format.
`pdf`	Image embedded in PDF.
`pjpeg`	Progressive JPEG.
`png-alpha`	24-bit lossless PNG with alpha channel.
`png`	24-bit lossless PNG.
`png8-alpha`	8-bit lossless PNG with alpha channel.
`png8`	8-bit lossless PNG.
`swf-alpha`	Lossy JPEG and a deflate-compressed mask embedded into an Adobe AS2 swf file.
`swf`	Lossy JPEG embedded into an Adobe AS2 swf file.
`swf3-alpha`	Lossy JPEG and a deflate-compressed mask embedded into an Adobe AS3 swf file. Note: swf and swf-alpha formats are best used for ActionScript 2 applications (Flash Player 8 and earlier). The formats swf3 and swf3-alpha are recommended for use for ActionScript3 applications (Flash Player 9 and later).
`swf3`	Lossy JPEG embedded into an Adobe AS3 swf file.
`tif-alpha`	TIFF with alpha channel.
`tif`	TIFF.
`webp-alpha`	Lossy and lossless WebP with alpha channel.
`webp`	Lossy and lossless WebP.

pixelType – rgb | gray | cmyk

`pixelType`	Description
`cmyk`	Return CMYK image data.
`gray`	Return gray-scale image data.
`rgb`	Return RGB image data.

`compression`	Description
`jpeg`	JPEG compression (lossy).
`lossy`	JPEG 2000, and JPEG XR compression (lossy), and WebP.
`lossless`	HEIC, JPEG 2000, and JPEG XR compression (lossless), and WebP.
`lzw`	LZW (Lempel-Ziv-Welch) compression (lossless).
`none`	Uncompressed.
`zip`	“Deflate” compression (lossless).

format specifies the image encoding format for image data sent to the client and the corresponding response MIME type for the HTTP response header.
pixelType can be used to effect output color space conversion when icc= is not specified.

The default color profile corresponding to pixelType is applied. If color management is disabled, naïve conversion is applied. pixelType is ignored when icc= is specified, which determines the output pixel type.
compression is permitted only if tif, tif-alpha, pdf, webp, webp-alpha, jpeg2000, jpeg2000-alpha, jpegxr, or jpegxr-alpha is specified as the format. Refer to the table below for the compression options supported for these image formats.

You can use qlt= to set the JPEG encoding options for these formats: JPEG, TIFF with JPEG compression, PDF with JPEG compression, and SWF. WebP, JPEG 2000, and JPEG XR also use qlt= but the values result in different qualities for the different formats. Use quantize= if fmt=gif or fmt=gif-alpha. Refer to the command descriptions for details. The other formats do not have settable options.

8 bits per pixel component are returned for all formats and pixelTypes (8 bits per pixel for GIF).

The following table lists the valid combinations of *format*and pixelType, the corresponding HTTP response MIME types, whether ICC profiles can be embedded (see iccEmbed=), and what format-specific options you can apply.

format

pixelType

Response MIME type

Embed ICC profile

Options

avif, avif-alpha

rgb

No

compression ( lossy , lossless )

qlt= is ignored for lossless .

Because there is no concept of chrominance downsampling with the WebP format, if you use a second value with qlt (for example, qlt=80,1 ) the second value ( 1 ) is ignored.

eps

rgb, gray, cmyk

Yes

pathEmbed=

gif, gif-alpha

rgb, gray

Data is converted to palette after conversion to gray or rgb.

No

quantize=

heic

rgb

No

jpeg2000, jpeg2000-alpha

rgb, gray

No

compression ( lossy , lossless )

qlt= is ignored for lossless .

Because there is no concept of chrominance downsampling with the WebP format, if you use a second value with qlt (for example, qlt=80,1 ) the second value ( 1 ) is ignored.

jpeg, jpg, pjpeg

rgb, gray, cmyk

Yes

pathEmbed= , pscan= , qlt= , xmpEmbed=

The pscan= parameter applies only to pjpeg format.

jpegxr, jpegxr-alpha

rgb

No

compression ( lossy , lossless )

qlt= is ignored for lossless .

Because there is no concept of chrominance downsampling with the WebP format, if you use a second value with qlt (for example, qlt=80,1 ) the second value ( 1 ) is ignored.

pdf

rgb, gray, cmyk

Yes

compression

( none|zip|jpeg ), qlt=

qlt= is ignored unless compression is set to jpeg .

png8, png8-alpha

rgb

Yes

png, png-alpha

rgb, gray

Yes

swf,swf3, swf-alpha, swf-alpha3

rgb, gray

No

Note: The Adobe Flash Player ignores embedded ICC profiles.

qlt= , attribute::TrustedDomains

tif, tif-alpha

rgb, gray, cmyk

Yes

compression

( none|lzw|zip|jpeg )

'tiff' only; 'tiff-alpha' does not support jpeg compression.

qlt=

qlt= is ignored unless compression is set to jpeg .

, pathEmbed=, xmpEmbed=

webp, webp-alpha

rgb

No

compression ( lossy , lossless )

qlt= is ignored for lossless .

Because there is no concept of chrominance downsampling with the WebP format, if you use a second value with qlt (for example, qlt=80,1 ) the second value ( 1 ) is ignored.

Properties

Request attribute. Applies regardless of current layer setting if req=img (default) or req=mask; ignored otherwise.

type is ignored if iccProfile= is specified.

Default

fmt=jpeg, *defaultType*,none, where the defaultType is handled as follows: If icc= is specified, defaultType corresponds to the pixel type of the specified ICC profile. If icc= is not specified, defaultType is gray if req=mask, otherwise it is rgb.

Examples

Request a small, low-quality preview image in JPEG format (default):

http:// *server*/myRootId/myImageId?qlt=60&wid=200

Request the same image converted to gray-scale:

http:// *server*/myRootId/myImageId?fmt=jpeg,gray&qlt=60&wid=200

Request the same image in a loss-less format with alpha channel and at high resolution:

http:// *server*/myRootId/myImageId?fmt=png-alpha&wid=300

Request the alpha channel for the same image as a gray-scale TIFF image:

http:// *server*/myRootId/myImageId?req=mask&fmt=tif,gray&wid=300

Convert the same image to cmyk using the default ICC profiles:

http:// *server*/myRootId/myImageId?fmt=tif,cmyk&wid=300

Convert the same image to cmyk using a different ICC profile and embed the profile in the TIFF image:

http:// *server*/myRootId/myImageId?fmt=tif&wid=300&icc=myPrinterProfile&iccEmbed=1

Deliver this image as a TIF file with JPEG compression without pixel type conversion:

http:// *server*/myRootId/myImageId?fmt=tif,,jpeg&qlt=95&wid=300

Convert image to a bi-tonal GIF with key-color transparency and force colors to black and white:

http:// *server*/myRootId/myImageId?fmt=gif-alpha&wid=100&quantize=adaptive,off,2,000000,ffffff

Lossy with a quality setting of 80:

http:// *server*/myRootId/myImageId?wid=300&fmt=webp&qlt=80

Lossless with alpha:

http:// *server*/myRootId/myImageId?wid=300&fmt=webp-alpha,,lossless

Lossy with a quality setting of 80:

http://server/myRootId/myImageId?wid=300&fmt=jpeg2000&qlt=80

Lossless with alpha:

http://server/myRootId/myImageId?wid=300&fmt=jpeg2000-alpha,,lossless

Lossy with a quality setting of 80:

http://server/myRootId/myImageId?wid=300&fmt=jpegxr&qlt=80

Lossless with alpha:

http://server/myRootId/myImageId?wid=300&fmt=jpegxr-alpha,,lossless

fmt

Properties

Default

Examples

See also