Das Player-Preset-Objekt

Ein Player-Preset ist ein wiederverwendbares Player-Design. Du erstellst und bearbeitest Presets in der Ignite-Admin-Oberfläche. Mit einem API-Key kannst du Presets lesen, zum Beispiel um deinen eigenen Player mit demselben Design darzustellen. API-Keys können keine Presets erstellen, aktualisieren oder löschen.

Das Player-Preset-Objekt ist ein JSON-Objekt mit den folgenden Eigenschaften:


{
  "id": string,
  "title": string,
  "isDefault": boolean,
  "controls": boolean,
  "autoplay": boolean,
  "loop": boolean,
  "muted": boolean,
  "primaryColor": string, // hex or rgba, e.g. "#FFFFFF"
  "secondaryColor": string,
  "backgroundColor": string,
  "aspectRatio": "original" | "16/9" | "9/16" | "responsive" | "4/3" | "1/1" | "3/4" | "4/5",
  "uiRadius": number,
  "uiPadding": number,
  "initCaptions": boolean,
  "captionsOnFullscreen": boolean,
  "showTranscription": boolean,
  "captionsColorFont": string,
  "captionsColorBackground": string,
  "captionsRadius": number,
  "fullscreen": boolean,
  "allowAirPlay": boolean,
  "allowGoogleCast": boolean,
  "pictureInPicture": boolean,
  "showAudioTracks": boolean,
  "showSeekButtons": boolean,
  "fit": "contain" | "cover",
  "uiLanguage": string | null, // e.g. "de-DE", empty or null uses the browser language
  "limitQuality": "2160p" | "1080p" | "720p" | "540p" | "360p" | "240p",
  "aiContentLabel": "auto" | "off" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight",
  "createdAt": Date,
  "updatedAt": Date
}

`isDefault`

Markiert das Standard-Preset des Workspace. Nur ein Preset kann das Standard-Preset sein. Wenn du ein Video ohne Preset erstellst, weist Ignite dem Video das Standard-Preset zu.

Player-Design-Eigenschaften

Alle Eigenschaften außer id, title, isDefault, createdAt und updatedAt sind Player-Design-Einstellungen. player.playerDesign des Videos nutzt dieselben Eigenschaften. Das Embed-Player-Setup beschreibt, was jede Einstellung bewirkt.

Die meisten Design-Eigenschaften haben einen passenden URL-Parameter im Embed-Player. Diese Eigenschaften verwenden einen anderen Namen:

Eigenschaft	URL-Parameter
`primaryColor`	`colorPrimary`
`secondaryColor`	`colorSecondary`
`backgroundColor`	`colorBackground`
`allowAirPlay`	`airPlay`
`allowGoogleCast`	`googleCast`
`pictureInPicture`	`pip`
`uiLanguage`	`lang`

aspectRatio ist kein URL-Parameter. Siehe aspectRatio.

fullscreenOnPlay ist nur ein URL-Parameter. Es wird nicht in einem Player-Preset und nicht in player.playerDesign gespeichert.

Farben enthalten das Präfix # (zum Beispiel #FFFFFF). Entferne das #, wenn du eine Hex-Farbe als URL-Parameter übergibst.

Preset im Embed-Player verwenden

Um ein Preset auf ein Embed anzuwenden, übergib seine id als URL-Parameter preset.