DocumentationDynamic Media Image Serving and Rendering API

fmt fmt

Last update: Mon Jul 12 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Response image format.

fmt=format [,pixelType ]

format
jpeg | png | png-alpha | tif | tif-alpha | swf | pdf | gif | gif-alpha | fxg | fxgraw

Specifies the image encoding format for image data sent to the client and the corresponding response MIME type for the HTTP reply header.

jpeg : lossy JPEG

png : loss-less PNG

png-alpha : loss-less PNG with alpha channel

tif : TIFF

tif-alpha : TIFF with alpha channel

swf : lossy JPEG embedded into an Adobe swf file

pdf : image embedded in PDF

gif : GIF with 2 to 256 colors

gif-alpha : GIF with 2 to 255 colors plus key-color transparency

fxg : FXG with variables and DOM manipulation applied

fxgraw : original FXG stored on server

pixelType
rgb | gray | cmyk

Can be used to effect output color space.

rgb : return RGB image data

gray : return gray-scale image data

cmyk : return CMYK image data

tiffCompression is permitted only if tif, tif-alpha is specified as the format. Refer to the table below for the compression options supported for these image formats.

qlt= can be used to set the JPEG encoding options for these formats: JPEG, TIFF with JPEG compression. quantize= can be used 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[7].

The following table lists the valid combinations of format and pixelType, the corresponding HTTP response MIME types.

format
pixelType
Response MIME type
Embed ICC profile
Options
jpeg
rgb, gray, cmyk
<image/jpeg>
yes
qlt=
png, png-alpha
rgb, gray
<image/png>
yes
tif, tif-alpha
rgb, gray, cmyk
<image/tiff>
yes
tiffCompression ( none | lzw | zip | jpeg), qlt=
swf, swf-alpha
rgb
<application/x-shockwave-flash>
no
qlt=
pdf
rgb, gray, cmyk
<application/pdf>
yes
gif, gif-alpha
rgb, gray
<image/gif>
no
quantize=

Example section-2135175ab3ec453f9f5388d5690b0da4

http://server/is/agm/myRootId/myImageId?fmt=swf

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49