Documentatie Dynamic Media Image Production System API

createViewerPreset

8 maart 2022

Onderwerpen:

Gemaakt voor:

Ontwikkelaar
Beheerder

Hiermee maakt u een voorinstellingsweergave die bepaalt wat een gebruiker kan zien. De kijker kan van om het even welk type beschikbaar in IPS zijn. De voorinstellingsweergave wordt toegepast wanneer de elementen worden gepubliceerd.

Syntaxis

Geautoriseerde gebruikerstypen

IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin

Parameters

Input (createViewerPresetParam)

Naam	Type	Vereist	Beschrijving
companyHandle	`xsd:string`	Ja	De handgreep van het bedrijf dat de voorinstellingen en elementen van de viewer bevat.
folderHandle	`xsd:string`	Ja	De greep van de map die de elementen bevat.
name	`xsd:string`	Ja	Naam van viewer.
type	`xsd:string`	Ja	Type viewer.
configSettingArray	`types:ConfigSettingArray`	Nee	Een array met namen, waarden en grepen van afbeeldingen waarop u voorinstellingen toepast.

Uitvoer (createViewerPresetReturn)

Naam	Type	Vereist	Beschrijving
viewerPresetHandle	`xsd:string`	Ja	Verwerk de voorinstelling aan de viewer.

Voorbeelden

In dit codevoorbeeld wordt een voorinstelling voor een videospeler gemaakt. Het antwoord retourneert een greep naar de voorinstelling.

<createViewerPresetParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|0</companyHandle>
   <folderHandle>Scene7SharedAssets/</folderHandle>
   <name>eVideo4</name>
   <type>VideoPlayer</type>
   <configSettingArray>
      <items>
         <name>Video Bit Rate</name>
         <value>393334.6508779093</value>
      </items>
      <items>
         <name>Audio Sample Rate</name>
         <value>44100</value>
      </items>
      ...
      <items>
         <name>vidPaneWidth</name>
         <value>0</value>
      </items>
   </configSettingArray>
</createViewerPresetParam>

Antwoord

<createViewerPresetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <viewerPresetHandle>a|151760|40|151760</viewerPresetHandle>
</createViewerPresetReturn>

recommendation-more-help