- Dynamic Media Developer Resources Home
- Dynamic Media Image Serving and Image Rendering API Home
- About this release
- System requirements and prerequisites
- Disk space requirements and recommendations
- Restrictions and known issues
- Technical support
- Document conventions
- Installation
- Image Serving API
- Image Serving API
- Intended audience
- Image Serving components
- Configuration and administration
- Serving static (non-image) contents
- Troubleshooting
- HTTP protocol reference
- HTTP protocol reference overview
- HTTP protocol introduction
- Syntax and features
- Syntax and features
- Image Serving HTTP protocol basic syntax
- Image Serving HTTP protocol command
- Layering
- Layer effects
- Request nesting and embedding
- Substitution variables
- Command macros
- Image catalogs
- Object ID translation
- Text string localization
- SVG support
- Request preprocessing
- Image maps
- Image Serving color management
- Image Serving HTTP encoding
- Request locking
- Request obfuscation
- Watermarks
- Serving static (non-image) content
- Media set requests
- Text formatting
- Data types
- Command reference
- Command reference overview
- align
- anchor
- bfc
- bgc
- bgColor
- blendMode
- cache
- clipPath
- clipXPath
- color
- crop
- cropPathE
- defaultImage
- effect
- effectMask
- extend
- fit
- flip
- fmt
- hei
- hide
- icc
- iccEmbed
- id
- imageSet
- jpegSize
- layer
- locale
- map
- mask
- maskUse
- op_blur
- op_brightness
- op_colorbalance
- op_colorize
- op_contrast
- op_grow
- op_growMask
- op_growMaskR
- op_hue
- op_invert
- op_noise
- op_saturation
- op_sharpen
- op_usm
- op_usmR
- opac
- origin
- pathAttr
- pathEmbed
- perspective
- pos
- printRes
- pscan
- qlt
- quantize
- rect
- req
- res
- resMode
- rgn
- rotate
- scale
- scl
- size
- src
- template
- text
- textAngle
- textAttr
- textFlowPath
- textFlowXPath
- textPath
- textPs
- type
- wid
- xmpEmbed
- Response data
- Server behavior
- Templates
- FXG server protocol reference
- Image catalog reference
- Attributes
- Attributes reference
- AllowDirectAccess
- AllowDirectUrls
- ApplyEffectMask
- AudioBitRate
- Bfc
- BkgColor
- CacheValidationPolicy
- ClientAddressFilter
- CatalogFile
- DefaultExpiration
- DefaultExt
- DefaultFont
- DefaultImage
- DefaultImageMode
- DefaultLocale
- DefaultPix
- DefaultThumbPix
- DigimarcId
- DigimarcInfo
- ErrorImage
- ErrorDetail
- Expiration
- FontMapFile
- FullMatch
- HttpAppleStreamingContext
- HttpFlashStreamingContext
- IccBlackPointCompensation
- IccDither
- IccProfileCmyk
- IccProfileGray
- IccProfileMapFile
- IccProfileRgb
- IccProfileSrcCmyk
- IccProfileSrcGray
- IccProfileSrcRgb
- IccRenderIntent
- JpegQuality
- LocaleMap
- LocaleStrMap
- MacroFile
- MaxPix
- NonImgExpiration
- PublishInfo
- PrintResolution
- RequestLock
- RequestObfuscation
- ResMode
- Resolution
- RootId
- RootPath
- RootUrl
- RuleSetFile
- SavePath
- StaticContentCatalogFile
- StaticContentRootPath
- SvgCatalogFile
- SynthesizeFontStyles
- ThumbBkgColor
- ThumbHorizAlign
- ThumbRes
- ThumbType
- ThumbVertAlign
- TimeStamp
- TotalStreamBitRate
- TrustedDomains
- UseLastModified
- VideoBitRate
- VideoSize
- Watermark
- Image/SVG data reference
- Macro definition
- Font map
- ICC profile map reference
- Rule set reference
- Image server proxy
- Image Server examples
- Responsive Static Image Library
- Image Rendering API
- Image Rendering API
- Configuration
- Server administration
- Server administration
- Server administration preface
- Server administration overview
- Configuring and managing the server
- Configuration settings reference
- HTTP protocol reference
- HTTP protocol reference
- Introduction
- HTTP protocol syntax and features
- HTTP protocol syntax and features
- Image Rendering HTTP protocol basic syntax
- Image Rendering HTTP protocol command overview
- Vignettes
- Materials
- Advanced Render effects
- Request nesting and embedding
- Material catalogs
- Request pre-processing *
- Custom variables
- Command macros *
- Image Rendering color management *
- Color values
- Image Rendering HTTP encoding
- HTTP protocol command reference
- HTTP protocol response data
- Material catalog
- Material catalog
- Introduction
- Material catalog overview
- Attributes reference
- Attributes reference
- AllowDirectURLs
- CacheValidationPolicy
- CatalogFile
- ClientAddressFilter
- DefaultPix
- ErrorDetail
- ErrorImage
- Expiration
- Format
- IccBlackPointCompensation
- IccDither
- IccProfileCmyk
- IccProfileGray
- IccProfileMapFile
- IccProfileRgb
- IccProfileSrcCmyk
- IccProfileSrcGray
- IccProfileSrcRgb
- IccRenderIntent
- JpegQuality
- MacroFile
- MaxPix
- OnFailObj
- OnFailSel
- RenderSettings
- ResMode
- Resolution
- RootId
- RootPath *
- RootUrl *
- RuleSetFile
- Sharp
- Sharpen
- ShowOverlapObjs
- TiffEncoding
- TimeStamp
- TrustedDomains *
- UseLastModified
- VignetteMapFile
- Material data reference
- Vignette map reference
- Macro definition reference
- ICC profile map reference
- Rule set reference
- Utilities
fmt
Reply image format. Specifies the image encoding format for image data sent to the client and the corresponding response MIME type for the HTTP response header.
fmt= *format*[,[ *pixelType*][, *tiffCompression*]]
| format |
jpeg |
Lossy JPEG. |
|
|
jpg |
Lossy JPG. |
|
|
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 a Macromedia swf file. |
|
|
swf-alpha |
Lossy JPEG and a deflate-compressed Mask embedded into a Macromedia swf file. |
|
|
|
Image embedded in PDF. |
|
|
eps |
Uncompressed binary Encapsulated PostScript. |
|
|
gif |
GIF with 256 colors. |
|
|
gif-alpha |
GIF with 255 colors plus key-color transparency. |
| pixelType |
rgb |
Return RGB image data. |
|
|
gray |
Return gray-scale image data. |
|
|
cmyk |
Return CMYK image data. |
| tiffCompression | none |
Uncompressed. |
|
|
lzw |
LZW (Lempel-Ziv-Welch) compression (lossless). |
|
|
zip |
"Deflate" compression (lossless). |
|
|
jpeg |
JPEG compression (lossy). |
pixelType effects 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, or PDF is specified as the format. Refer to the table below for the compression options supported for these image formats.
qlt- sets the JPEG encoding options for these formats: JPEG, TIFF with JPEG compression, PDF with JPEG compression, and SWF file. 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 pixel types.
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 option commands can be applied.
| format |
pixelType |
Response MIME Type |
Embed ICC Profile |
Options |
|---|---|---|---|---|
| jpeg, jpg |
rgb, gray, cmyk |
<image/jpeg> |
Yes |
qlt= |
| png, png-alpha |
rgb, gray |
<image/png> |
Yes |
|
| png8, png8-alpha |
rgb |
<image/png> |
yes |
|
| tif, tif-alpha |
rgb, gray, cmyk |
<image/tiff> |
Yes |
tiffCompression (none|lzw|zip|jpeg), pathEmbed=, qlt ( qlt= is ignored unless tiffCompression is set to 'jpeg'.) |
| swf, swf-alpha |
rgb, gray |
<application/x-shockwave-flash> |
No (The Flash Player ignores embedded ICC profiles.) |
qlt= , attribute::TrustedDomains |
| |
rgb, gray, cmyk |
<application/pdf> |
Yes |
tiffCompression (none|zip|jpeg),qlt= ( qlt= is ignored unless tiffCompression is set to 'jpeg'.) |
| eps |
rgb, gray, cmyk |
<image/eps> |
Yes |
pathEmbed= |
| gif, gif-alpha |
rgb, gray (Data is converted to palette after conversion to gray or rgb.) |
<image/gif> |
No |
|
Specifies encoding format for reply image data sent to the client and the corresponding response MIME type for the HTTP reply header.
png-alpha returns unassociated alpha (that is, alpha does not pre-multiply the pixel values), while tif-alpha, and swf-alpha return associated alpha (that is, the alpha values are pre-multiplied with the alpha values). The alpha channel corresponds to the inverse of the vignette’s background mask for req=img, and to the group or object mask in case of req=object. To apply alpha when using a nested IR request, add fmt= with the appropriate alpha file format to the embedded IR request and the main request. No alpha data is returned if a CMYK or grayscale ICC profile is specified with icc=.
Properties
May occur anywhere in the request.
Default
format defaults to attribute::Formatand tiffCompression defaults to attribute::TiffEncoding. pixelType defaults to rgb if icc= is not specified, otherwise it corresponds to the pixel type of the specified ICC profile.
See also
attribute::Format , attribute::JpegQuality, attribute::TiffEncoding, qlt=, iccEmbed=, pathEmbed=, req=, quantize=