DokumentationDynamic Media Image Production System-API

createVignettePublishFormat createvignettepublishformat

Last update: Mon Dec 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Erstellt ein neues Veröffentlichungsformat für eine Vignette.

Vignettenformate geben die Größe veröffentlichter Vignetten und deren Miniaturansichten sowie Zoomstufen, Scharfzeichnungsparameter und die Dateiformatversion für Vignetten an, die aus primären Vignetten erstellt wurden, die auf einem Bild-Rendering-Server von IPS veröffentlicht wurden.

Neuere Image Rendering-Server-Versionen können Pyramidenvignetten unterstützen, sodass für die Veröffentlichung keine spezifischen Vignettenformatgrößen definiert werden müssen.

Autorisierte Benutzertypen section-f5c563e3695c4dba8df41e2a965aace7

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameter section-3a368186ec1d4005bca056fc9d9bacc7

Eingabe (createVignettePublishFormatParam)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Handle an die Firma, zu der die Vignette gehört.
Name
Code-Satz
Ja
Name zur Identifizierung des Vignettenveröffentlichungsformats.
targetWidth
Code-Satz
Ja

Gibt die Zielbreite der resultierenden Vignettenansicht in Pixel an.

Verwenden Sie Null, damit die Ausgabe-Vignette dieselbe Größe wie die primäre Vignette hat.

targetHeight
Code-Satz
Ja
Erstellt eine Pyramidenvignette, die für das Zoomen auf dem Bild-Rendering-Server optimiert ist. Beginnend mit der maximalen Größe, die durch die Felder Zielgröße der Vignette festgelegt wird, erstellt dies mehrere Größenansichten in einer einzigen Vignetten-Ausgabedatei. Jede darauffolgende Ansichtsgröße wird halbiert, bis die Breite und Höhe innerhalb von 128x128 Pixeln liegen.
createPyramid
Code-Satz
Ja
Gibt die Breite der einzelnen resultierenden Miniaturen in Pixel an. Diese Einstellung ist optional. Belassen Sie Null für keine Miniaturbilddatei.
thumbWidth
Code-Satz
Ja
Gibt das Dateiformat für die veröffentlichten Vignetten an. Bei einer neuen Version der Bildbearbeitung und einer älteren Version des Bild-Rendering-Servers müssen Sie eine Vignettenversion angeben, die Ihr Bild-Rendering-Server lesen kann. Wenn Sie eine höhere Version angeben, kann der Bild-Rendering-Server die veröffentlichten Vignetten nicht lesen. Auf null gesetzt, um Vignetten mit der neuesten Version zu veröffentlichen.
saveAsVersion
Code-Satz
Ja
Gibt das Zeichen an, das den Namen der Vignette vom Suffix für die Breite trennt.
sizeSuffixSeparator
Code-Satz
Ja
Gibt das Zeichen an, das den Namen der Vignette vom Suffix für die Breite trennt.
schärfen
Code-Satz
Nein
Wendet die Scharfzeichnung auf das Hauptansichtsbild für jede Veröffentlichungs-Vignettengröße an Scharfzeichnung kann Unschärfen ausgleichen, wenn die Vignetten skaliert werden.
usmAmount
Code-Satz
Ja
Die digitale Unschärfemaske ist eine flexible und leistungsstarke Methode, um die Schärfe zu erhöhen, insbesondere bei gescannten Bildern. Damit wird die Größe der einzelnen Überschreitungen (wie viel dunkler und heller die Kantenränder werden) gesteuert.
usmRadius
Code-Satz
Ja
Beeinflusst die Größe der zu vergrößernden Kanten oder die Breite der Kantenränder, sodass ein kleineres Radium die Detailgenauigkeit in kleinerem Maßstab verbessert. Höhere Radiuswerte können zu Lichthöfen an den Kanten führen. Feines Detail benötigt einen kleineren Radius, da winziges Detail der gleichen Größe oder kleiner als der Radius verloren geht.
usmThreshold
Code-Satz
Ja
Steuert die minimale Helligkeitsänderung, die geschärft werden soll, oder den Abstand benachbarter Farbwerte, bevor der Filter funktioniert. Diese Einstellung kann ausgeprägtere Kanten schärfen, während subtilere Kanten unberührt bleiben. Der zulässige Schwellenwert liegt zwischen 0 und 255.

Ausgabe (createVignettePublishFormatReturn)

Name
Typ
Erforderlich
Beschreibung
vignetteFormatHandle
xsd:string
Ja
Der Griff zum erstellten Vignettenformat.

Beispiele section-0564752d439642b9bb8de2903db6de1e

Dieser Code erstellt das Vignettenveröffentlichungsformat. Die Erstellungsanfrage gibt einen Namen, eine Zielbreite und -höhe sowie andere erforderliche Werte an.

Anfrage

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

Antwort

<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