DocumentationDynamic Media Image Production System API

createVignettePublishFormat

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Creates a new publish format for a vignette.

Vignette formats specify the size of published vignettes and their thumbnails, as well as zoom levels, sharpening parameters, and the file format version for vignettes produced from primary vignettes published to an Image Rendering server from IPS.

Newer Image Rendering server versions can support pyramid vignettes, which eliminates the need to define specific vignette format sizes for publishing.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (createVignettePublishFormatParam)

Name
Type
Required
Description
companyHandle
xsd:string
Yes
Handle to the company the vignette belongs to.
name
Code Phrase
Yes
Name to identify the vignette publishing format.
targetWidth
Code Phrase
Yes

Specifies the target width of the resulting vignette view in pixels.

Use zero so the output vignette has the same size as the primary vignette.

targetHeight
Code Phrase
Yes
Creates a pyramid vignette optimized for zooming on the Image Rendering server. Starting at the maximum size, set by the Target Vignette Size fields, this creates multiple size views in a single vignette output file. Each subsequent view size is halved until the width and height are within 128x128 pixels.
createPyramid
Code Phrase
Yes
Specifies the width of each resulting thumbnail in pixels. This setting is optional. Leave as zero for no thumbnail file.
thumbWidth
Code Phrase
Yes
Specifies the file format for the published vignettes. Given a new version of Image Authoring and an oler version of the Image Rendering Server, you must specify a vignette version that your ImageRendering Server can read. If you specify a higher version, the Image Rendering server cannot read the published vignettes. Set to zero to publish vignettes at the latest version.
saveAsVersion
Code Phrase
Yes
Specifies the character the separates the vignette name and the suffix indicating its width.
sizeSuffixSeparator
Code Phrase
Yes
Specifies the character the separates the vignette name and the suffix indicating its width.
sharpen
Code Phrase
No
Applies sharpening to the main view image for each puvlish vignette size Sharpening can compensate for blurring when the vignetters are scaled.
usmAmount
Code Phrase
Yes
Digital unsharp masking is a flexible and powerful way to increase sharpness, especially in scanned images. This controls the magnitude of each overshoot (how much darker and light the edge borders become).
usmRadius
Code Phrase
Yes
Affects the size of the edges to be enhanced or how wide the edge rims become, so a smaller radium enhances smaller-scalle detail. Higher radius values can cause halos at the edges. Fine detail needs a smaller radius as tiny detail of the same size or smaller than the radius is lost.
usmThreshold
Code Phrase
Yes
Controls the minimum brightness change to be sharpened or how far apart adjacent tonal values must be before the filter works. This setting can sharpen more pronouced edges while leaving more subtle edges untouched. THe allowable range of threshold of 0 to 255.

Output (createVignettePublishFormatReturn)

Name
Type
Required
Description
vignetteFormatHandle
xsd:string
Yes
The handle to the created vignette format.

Examples

This code creates vignette publish format. The creation request specifies a name, target width and height, and other required values.

Request

<createVignettePublishFormatParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <name>APIcreateVignettePublishFormat1</name>
   <targetWidth>1200</<targetWidth>
   <targetHeight>800</targetHeight>
   <createPyramid>true</createPyramid>
   <thumbWidth>400</thumbWidth>
   <saveAsVersion>0</saveAsVersion>
   <sizeSuffixSeparator>-</sizeSuffixSeparator>
   <sharpen>50</sharpen>
   <usmAmount>230.0</usmAmount>
   <usmRadius>1.1</usmRadius>
   <usmThreshold>130</usmThreshold>
</createVignettePublishFormatParam>

Response

<createVignettePublishFormatReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <vignetteFormatHandle>v|21|282</vignetteFormatHandle>
</createVignettePublishFormatReturn>
4e9b9d8c-5839-4215-aa35-01b652869681