- 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
Image catalogs
The features and syntax of image catalogs are described in this section.
Image catalogs offer the following features:
-
Allow persistent association of images with certain metadata and modifier commands.
Entries in image catalogs are referenced using a shortcut notation
*rootId/objId*, where*rootId*identifies the image catalog and*objId*identifies a data record in the catalog. -
Provide defaults for certain request attributes, such as the JPEG quality or whether a watermark is to be applied.
-
Manage fonts, ICC profiles, macro definitions, and request templates
Even if no specific image catalogs are defined, all features of image catalogs are available via the default catalog ( default.ini).
If *rootId* in the request’s URL path matches attribute::RootId of a specific image catalog, that catalog will become the main catalog for this request. The main catalog provides the default attributes and settings for the entire request. If no match is found, the default catalog is used instead.
A catalog identified in a src= or mask= command provides the following catalog attributes and data to the current layer:
| Attribute/Data | Notes |
|---|---|
| attribute::DefaultExt |
the default extension for all image file paths in the current layer |
| attribute::Expiration |
default for catalog::Expiration or expiration of the current layer if no catalog record is involved |
| attribute::Icc* |
the working ICC color profile, render intent, and blackpoint compensation flag for the request and/or the current layer |
| attribute::RootPath |
used for all source file paths of the current layer |
| attribute::Resolution |
default for catalog::Resolution only |
| catalog::Anchor |
default for the anchor= value of the current layer |
| catalog::Expiration |
the smallest expiration value of all layers is used as the time-to-live value of the reply image |
| catalog::IccProfile |
the source image color profile for the current layer |
| catalog::Map |
the image map data for the current layer |
| catalog::MaskPath |
default for mask= for the current layer |
| catalog::Modifier |
prefix commands for the current layer (each command in catalog::Modifier can be overridden by the same command in the URL, if specified for the same layer) |
| catalog::Path |
the source image file for the current layer |
| catalog::PostModifier |
postfix commands for the current layer (similar to catalog::Modifier, but commands in catalog::PostModifier override the same commands specified in the URL or in catalog::Modifier) |
| catalog::Resolution |
the object resolution of the current layer |
Within the same layer, src= and mask= must reference the same image catalog (if any).
A catalog identified in an icc= command is used only to look up an entry from the catalog’s ICC profile table. No other catalog attributes or data are involved.
If, *rootId* resolves to a catalog, and *objId* is matched with a catalog::Id in this catalog, then *rootId/objId* is effectively replaced by the catalog entry somewhat like this:
src=attribute::RootPath/catalog::Path& mask=attribute::RootPath/catalog::MaskPath& anchor=catalog::Anchor& catalog::Modifier& catalog::PostModifier