文档Dynamic Media Image Production System API

createVignettePublishFormat createvignettepublishformat

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined

为晕影创建新的发布格式。

晕影格式指定已发布晕影及其缩略图的大小，以及缩放级别、锐化参数和晕影的文件格式版本，这些晕影由从IPS发布到图像渲染服务器的主晕影生成。

较新的图像渲染服务器版本可以支持金字塔晕影，从而无需定义用于发布的特定晕影格式大小。

授权用户类型 section-f5c563e3695c4dba8df41e2a965aace7

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

参数 section-3a368186ec1d4005bca056fc9d9bacc7

输入(createVignettePublishFormatParam)

名称
类型
必需
说明
companyHandle
xsd：string
是
处理晕影所属的公司。
名称
代码短语
是
用于标识晕影发布格式的名称。
targetWidth
代码短语
是

指定生成的晕影视图的目标宽度（以像素为单位）。

使用零以使输出晕影具有与主晕影相同的大小。

targetHeight
代码短语
是
创建为图像渲染服务器上的缩放而优化的金字塔晕影。 从目标晕影大小字段设置的最大大小开始，这会在单个晕影输出文件中创建多个大小视图。 每个后续视图大小都减半，直到宽度和高度在128x128像素以内。
createPyramid
代码短语
是
指定每个结果缩略图的宽度（像素）。 此设置是可选的。 对于无缩略图文件，保留为0。
thumbWidth
代码短语
是
指定已发布晕影的文件格式。 给定图像创作的新版本和图像渲染服务器的旧版本，必须指定图像渲染服务器可以读取的晕影版本。 如果指定较高的版本，则图像渲染服务器无法读取发布的晕影。 设置为零可发布最新版本的晕影。
saveAsVersion
代码短语
是
指定用于分隔晕影名称和后缀（用于指示其宽度）的字符。
sizeSuffixSeparator
代码短语
是
指定用于分隔晕影名称和后缀（用于指示其宽度）的字符。
锐化
代码短语
否
对每个发布的晕影大小的主视图图像应用锐化。锐化可在缩放晕影时补偿模糊。
usmAmount
代码短语
是
数字钝化蒙版是一种灵活而强大的增强锐度的方法，尤其是在扫描的图像中。 这控制每个超调的大小（边缘边界变得多暗多亮）。
usmRadius
代码短语
是
影响要增强的边的大小或边框的宽度，因此较小的半径可增强较小尺寸的细节。 半径值越大，边缘会出现光晕。 细细节需要较小的半径，因为与半径相同或小于该半径的微小细节将丢失。
usmThreshold
代码短语
是
控制要锐化的最小亮度变化或在滤镜工作之前相邻色调值必须相距多远。 此设置可以锐化更细微的边缘，同时保持更细微的边缘不变。 阈值允许范围为0到255。

输出(createVignettePublishFormatReturn)

名称
类型
必需
说明
vignetteFormatHandle
xsd:string
是
创建的晕影格式的句柄。

示例 section-0564752d439642b9bb8de2903db6de1e

此代码创建晕影发布格式。 创建请求会指定名称、目标宽度和高度以及其他必需值。

请求

<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>

响应

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