createViewerPreset

Erstellt eine Vorgabenansicht, die bestimmt, was ein Benutzer sehen kann. Der Viewer kann einen beliebigen Typ aufweisen, der in IPS verfügbar ist. Die Vorgabenansicht wird angewendet, wenn die Assets veröffentlicht werden.

Syntax

Autorisierte Benutzertypen

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameter

Eingabe (createViewerPresetParam)

Name Typ Erforderlich Beschreibung
*companyHandle* xsd:string Ja Das Handle des Unternehmens, das die Viewer-Vorgaben und Assets enthält.
*folderHandle* xsd:string Ja Der Handle des Ordners, der die Assets enthält.
*name* xsd:string Ja Viewer-Name.
*type* xsd:string Ja Viewer-Typ.
*configSettingArray* types:ConfigSettingArray Nein Ein Array, das Namen, Werte und Handles von Bildern enthält, auf die Sie Vorgaben anwenden.

Ausgabe (createViewerPresetReturn)

Name Typ Erforderlich Beschreibung
*viewerPresetHandle* xsd:string Ja Handhabung der Vorgabe an den Viewer.

Beispiele

In diesem Codebeispiel wird eine Videoplayer-Vorgabe erstellt. Die Antwort gibt einen Handle an die Vorgabe zurück.

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

Antwort

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

Auf dieser Seite