src
- Topics:
- Dynamic Media Classic,SDK/API
CREATED FOR:
- Developer
- User
Material file. Specifies material data, either in form of a single material catalog reference, or as one or two image or material data files, separated with a comma.
src = *
catalogEntry*|{{ *
materialFile*| *
embeddedReq*}[, *
materialFile*]
srcE= *
name*
srcN= *
index*
catalogEntry | [/][ catId/] recId |
materialFile | styleFile| imageFile |
embeddedReq | {'is{' isReq'}'}|{'ir{' irReq'}'|{'{' foreignReq'}' |
catId | Material catalog ID ( attribute::RootId). |
recId | Material catalog entry ( catalog::Id). |
styleFile | Material style file ( .vnc or .vnw). |
imageFile | Image data file. |
isReq | Request to Image Serving. |
irReq | Request to Image Rendering. |
foreignReq | Request to a foreign server. |
name | Name of an embedded material. |
index | 0-based index number for an embedded material. |
Repeatable Texture, Decal, and Wallpaper materials require a single image, which may be specified as a file or an embedded request.
Cabinet materials require a cabinet style file ( .vnc), which cannot be specified as a nested request. A texture image file is optional for cabinets, and, if specified, it may be either a file or an embedded request.
Window coverings materials require a window coverings style file ( .vnw), which cannot be specified as a nested request. A texture file is optional and, if specified, it may be either a file or an embedded request.
Image Rendering uses the same rules as Image Serving for looking up material catalogs, catalog entries, and data files. Refer to the description of the object
Data Type in the Image Serving documentation for details.
materialFile
Is a path relative to attribute::RootPath
.
foreignReq
Can either be a URL relative to attribute::RootUrl
, or an absolute URL if attribute::AllowDirectUrls
is set.
If catId
is not specified, the session catalog is used.
srcE=
and srcN=
provide access to materials embedded in the vignette.
Supported file formats
Image Rendering supports the same source image formats as Dynamic Media Image Serving.
Applications which require image data in multiple different resolutions perform best when using the Scene7 pyramid TIFF (PTIFF) multi-resolution format. Image Serving includes the Image Converter (IC) utility which creates PTIFF images from any supported format.
Refer to the description of the IC utility in the Image Serving documentation for a complete list of supported file formats.
Properties
Material attribute. Required for all materials except solid color (not permitted for solid color materials). All strings are case-sensitive. index
Must be 0 or larger.
Default
None.
Example
An MSS for a colorized cabinet with a separate repeatable texture:
…&obj=cabinets&src=cabs/maple02.vnc,cabs/maple.jpg&res=40&color=185,105,35&…
The same material could be in a material catalog 'cat
’ in record ’ 12-3-2
’:
…&obj=cabinets&src=cat/12-3-2&…
A nested request to Image Serving to obtain a texture image:
…&obj=main&src=is{texCatalog/texture123?res=30}&res=30&…
See also
Material Catalogs, attribute::RootUrl, attribute::AllowDirectUrls
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