DokumentationDynamic Media Image Production System API

createVignettePublishFormat createvignettepublishformat

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Developer
  • Admin

Skapar ett nytt publiceringsformat för en vinjett.

Vinjetteringsformaten anger storleken på publicerade vinjetteringar och deras miniatyrbilder samt zoomnivåer, skärpeparametrar och filformatsversionen för vinjetteringar som skapats från primära vinjetteringar som publicerats på en bildåtergivningsserver från IPS.

Nya serverversioner för bildåtergivning har stöd för pyramidvinjettering, vilket eliminerar behovet av att definiera specifika vinjettformat för publicering.

Auktoriserade användartyper section-f5c563e3695c4dba8df41e2a965aace7

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parametrar section-3a368186ec1d4005bca056fc9d9bacc7

Indata (createVignettePublishFormatParam)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:sträng
Ja
Handtag till det företag som vinjetteringen tillhör.
name
Kodfras
Ja
Namn som identifierar vinjetteringens publiceringsformat.
targetWidth
Kodfras
Ja

Anger målbredden för den resulterande vinjetteringsvyn i pixlar.

Använd noll så att utdatavärjningen har samma storlek som den primära vinjetteringen.

targetHeight
Kodfras
Ja
Skapar en pyramidvinjettering som är optimerad för zoomning på servern för bildåtergivning. Med början från den maximala storleken, som anges av fälten Storlek på målvinjett, skapas vyer i flera storlekar i en enda vinjettutdatafil. Varje efterföljande visningsstorlek halveras tills bredden och höjden är inom 128 x 128 pixlar.
createPyramid
Kodfras
Ja
Anger bredden på varje miniatyrbild i pixlar. Den här inställningen är valfri. Använd noll om du inte har någon miniatyrfil.
thumbWidth
Kodfras
Ja
Anger filformatet för de publicerade vinjetterna. Om du har en ny version av Image Authoring och en äldre version av Image Rendering Server måste du ange en vinjettversion som ImageRendering Server kan läsa. Om du anger en senare version kan inte servern för bildåtergivning läsa de publicerade vinjetterna. Ange noll om du vill publicera vinjetter i den senaste versionen.
saveAsVersion
Kodfras
Ja
Anger det tecken som avgränsar vinjettnamnet och suffixet som anger bredden.
sizeSuffixSeparator
Kodfras
Ja
Anger det tecken som avgränsar vinjettnamnet och suffixet som anger bredden.
skärpa
Kodfras
Nej
Använder skärpa i huvudvisningsbilden för varje publik vinjettstorlek Skärpa kan kompensera för oskärpa när vinjetterarna skalas.
usmAmount
Kodfras
Ja
Digital oskarp maskning är ett flexibelt och kraftfullt sätt att öka skärpan, särskilt i skannade bilder. Detta styr storleken på varje överskjutande del (hur mycket mörkare och ljusare kanterna blir).
usmRadius
Kodfras
Ja
Påverkar storleken på kanterna som ska förbättras eller hur breda kanterna blir, så en mindre radie förbättrar detaljskärpan i mindre skala. Högre radievärden kan orsaka glorior vid kanterna. För fina detaljer krävs en mindre radie, eftersom små detaljer av samma storlek eller mindre än radien förloras.
usmThreshold
Kodfras
Ja
Styr den minsta intensitetsändring som ska göras skarpare eller hur långt ifrån intilliggande tonvärden måste vara innan filtret fungerar. Den här inställningen kan göra mer skarpa kanter skarpare samtidigt som mer subtila kanter lämnas orörda. Det tillåtna tröskelintervallet mellan 0 och 255.

Utdata (createVinjettPublishFormatReturn)

Namn
Typ
Obligatoriskt
Beskrivning
vinjetteringFormatHandtag
xsd:string
Ja
Handtaget till det skapade vinjettformatet.

Exempel section-0564752d439642b9bb8de2903db6de1e

Den här koden skapar ett format för vinjettering. Begäran om att skapa anger ett namn, målbredd och -höjd och andra obligatoriska värden.

Begäran

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

Svar

<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