DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

createVignettePublishFormat createvignettepublishformat

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador
  • Administrador

Crea un nuevo formato de publicación para una viñeta.

Los formatos de viñeta especifican el tamaño de las viñetas publicadas y sus miniaturas, así como los niveles de zoom, los parámetros de enfoque y la versión del formato de archivo para las viñetas producidas a partir de viñetas principales publicadas en un servidor de procesamiento de imágenes desde IPS.

Las versiones más recientes del servidor de procesamiento de imágenes admiten viñetas piramidales, lo que elimina la necesidad de definir tamaños de formato de viñeta específicos para la publicación.

Tipos de usuarios autorizados section-f5c563e3695c4dba8df41e2a965aace7

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parámetros section-3a368186ec1d4005bca056fc9d9bacc7

Entrada (createVignettePublishFormatParam)

Nombre
Tipo
Obligatorio
Descripción
companyHandle
xsd:string
Sí
Identificador de la compañía a la que pertenece la viñeta.
nombre
Frase de código
Sí
Nombre para identificar el formato de publicación de viñeta.
targetWidth
Frase de código
Sí

Especifica la anchura de destino de la vista de viñeta resultante en píxeles.

Utilice cero para que la viñeta de salida tenga el mismo tamaño que la viñeta principal.

targetHeight
Frase de código
Sí
Crea una viñeta piramidal optimizada para la ampliación y la reducción en el servidor de procesamiento de imágenes. Empezando por el tamaño máximo, definido por los campos de tamaño de viñeta de destino, esto crea múltiples vistas de tamaño en un solo archivo de salida de viñeta. Cada tamaño de vista posterior se reduce a la mitad hasta que la anchura y la altura tengan un valor inferior a 128 x 128 píxeles.
createPyramid
Frase de código
Sí
Especifica la anchura en píxeles de cada miniatura creada. Esta configuración es opcional. Dejar como cero para que no haya archivo de miniaturas.
thumbWidth
Frase de código
Sí
Especifica el formato de archivo para las viñetas publicadas. Dada la nueva versión de Image Authoring y la versión anterior del servidor de procesamiento de imágenes, debe especificar una versión de viñeta que el servidor de procesamiento de imágenes pueda leer. Si especifica una versión superior, el servidor de procesamiento de imágenes no podrá leer las viñetas publicadas. Establézcalo en cero para publicar viñetas en la última versión.
saveAsVersion
Frase de código
Sí
Especifica el carácter que separa el nombre de la viñeta y el sufijo que indica su anchura.
sizeSuffixSeparator
Frase de código
Sí
Especifica el carácter que separa el nombre de la viñeta y el sufijo que indica su anchura.
enfoque
Frase de código
No
Aplica enfoque a la imagen de vista principal para cada tamaño de viñeta de publicación. El enfoque puede compensar el desenfoque que se produce cuando las viñetas se reducen o se agrandan.
usmAmount
Frase de código
Sí
La máscara de enfoque digital es una forma flexible y eficaz de aumentar la nitidez, especialmente en imágenes digitalizadas. Esto controla la magnitud de cada sobregiro (cuánto más oscuros y claros se vuelven los bordes de borde).
usmRadius
Frase de código
Sí
Afecta al tamaño de las aristas que se van a mejorar o a la anchura de las aristas, por lo que un radio más pequeño aumenta el detalle a menor escala. Los valores de radio más altos pueden causar halos en los bordes. El detalle fino necesita un radio más pequeño, ya que se pierde un detalle minúsculo del mismo tamaño o más pequeño que el radio.
usmThreshold
Frase de código
Sí
Controla el cambio de brillo mínimo que se va a enfocar o la distancia entre los valores tonales adyacentes que se deben situar antes de que el filtro funcione. Esta configuración puede enfocar los bordes más pronunciados sin modificar los más sutiles. El intervalo permitido de umbral de 0 a 255.

Salida (createVignettePublishFormatReturn)

Nombre
Tipo
Obligatorio
Descripción
vignetteFormatHandle
xsd:string
Sí
El controlador para el formato de viñeta creado.

Ejemplos section-0564752d439642b9bb8de2903db6de1e

Este código crea un formato de publicación de viñeta. La solicitud de creación especifica un nombre, una anchura y altura de destino y otros valores necesarios.

Solicitud

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

Respuesta

<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