- 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
- 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
Serving static (non-image) contents
You can use Image Serving to manage non-image content in catalogs and serve it via a separate /is/content context.
This capability allows for configuring the TTL for each item separately.
Image Serving supports the following commands at /is/content:
| Content type filter. |
|
| req=userdata , req=props , and req=exists only. |
|
| Allows disabling client-side caching. |
Basic syntax
| request |
http:// server /is/content[/catalog/ item ][? modifiers ] |
| server |
server_address [ : port ] |
| catalog |
Catalog identifier. |
| item |
Static content item ID. |
| modifiers |
command *[& command ] |
| command |
cmdName = value |
| cmdName |
One of the supported command names. |
| value |
Command value. |
Static content catalogs
Static content catalogs are similar to image catalogs, but support fewer data fields:
| Attribute/Data |
Notes |
|---|---|
| catalog::Id |
The catalog record identifier for this static content item. |
| catalog::Path |
The file path for this content item. |
| catalog::Expiration |
The TTL for this content item; attribute::Expiration is used if not specified or if empty. |
| catalog::TimeStamp |
File modification time stamp; required when catalog-based validation is enabled with attribute::CacheValidationPolicy . |
| catalog::UserData |
Optional metadata associated with this static content item; available to the client with req=userdata . |
| catalog::UserType |
Optional data type; can be used to filter requests for static content with the type= command . |
Filtering static content
This mechanism can help ensure that clients receive only contents appropriate for their needs. Assuming that the static content is tagged with appropriate catalog::UserType values, the client can add the type= command to the request. Image Serving compares the value provided with the type= command to the value of catalog::UserType and, in case of a mismatch, return an error instead of potentially inappropriate contents.
Video caption files
You can encapsulate video caption files (WebVTT), CSS, or any text file in JSONP format. The JSON response is described below.
- For WebVTT files, the mime type of the response is text/javascript. JSON is not returned; instead, Javascript is returned that calls a method with JSON. Both the ID and handler are optional.
- For CSS files, the mime type of the response is text/javascript. Both the ID and handler are optional.
- By default, UTF-8 encoding is applied to ensure that it is decoded correctly. The default size limit is 2 MB.
You can also use tracks for other kinds of timed metadata. The source data for each track element is a text file made up of a list of timed cues. Cues can include data in formats such as JSON or CSV.
See https://en.wikipedia.org/wiki/JSONP for more information about the JSONP format.
See www.json.org for more information about the JSON format.
See also
type= , req=, Image Catalog Reference
Business.Adobe.com resources
Resources
Adobe Account
