object
- Topics:
- Dynamic Media Classic,SDK/API
CREATED FOR:
- Developer
- User
Source Object Specifier. Image, SVG, and ICC profile objects may be specified as image catalog entries or relative file paths
*
object*[/]{[ *
rootId*/] *
objId*}| *
path*
rootId | name of the image catalog ( attribute::RootId ) |
objtId | id of the image, SVG, template, or ICC profile record in the specified, main, or default image catalog |
path | relative image, mask, or ICC profile file path and name |
object | may occur either in the main URL path, or in a src= , mask= , or icc= command |
rootId
identifies an image catalog. (See Image Catalog for details.) If rootId
is specified in the URL path, that catalog becomes the main catalog for this request. Otherwise the default catalog is used as the main catalog. Multiple different image catalogs can be used in the same request.
The server initially assumes that rootId
is omitted in src=
, mask=
, and icc=
commands and attempts to find a catalog entry in the main catalog. Effectively, the server tries to use the entire object
string as objId.
If a catalog entry is found, it is used; otherwise, the server next attempts to match the rootId
of an image catalog. If a catalog is identified, it is searched for objId
. If and entry is found, it is used.
Otherwise, object
is assumed to be an explicit file path. In this case, if attribute::FullMatch
is set in the main catalog, then the catalog is ignored for this object, and the default catalog used instead. If attribute::FullMatch
is not set, then the main catalog is used for further processing.
Both rootId
and objId
are case-sensitive. path
is case-sensitive on UNIX only.
If a leading /
is specified, the default catalog is searched instead of the main catalog. This is primarily useful when an explicit path requires default::RootPath
rather than the main catalog’s attribute::RootPath
, but can also be used to gain access to entries in the default catalog which would otherwise be overridden by entries in the main catalog.
Refer to Managing Content in the Server Configuration Guide for details on how path
is translated to a physical file path.
object.
Supported image file formats
Refer to the description of the IC (Image Converter) utility for a complete list of supported file formats.
Applications that require image data in multiple different resolutions perform best when using the Dynamic Media pyramid TIFF (PTIF) multi-resolution format. The IC utility is used to create PTIF images from any supported image format.
Examples
Accessing an image and an ICC profile in two different image catalogs
Retrieve the image ’ myImage’ in the image catalog identified as ’ myCatalog’ and attach the ICC profile ’ sRGB’ located in the image catalog named ’ myProfiles’:
http:// *
server*/myCatalog/myImage?icc=myProfiles/sRGB&iccEmbed=true
Using a single image catalog with layering
Build a simple composite image consisting of three layers, all retrieved from ’ myCatalog’:
http:// *
server*/myCatalog?layer=0&src=img0&layer=1&src=img1&layer=2&src=img2&wid=200
Accessing image files directly while still using a catalog to provide attributes
Access my/image/path/myImage.tif, using the default jpg attributes configured in myImageCatalog
:
http://server/myImageCatalog/my/image/path/myImage.tif?wid=200
See also
Experience Manager
- 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
- dpr
- effect
- effectMask
- extend
- fit
- flip
- fmt
- hei
- hide
- icc
- iccEmbed
- id
- imageSet
- jpegSize
- layer
- locale
- map
- mask
- maskUse
- network
- 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
- 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