L’oggetto preset del player

Un preset del player è un design del player riutilizzabile. Crei e modifichi i preset nell’interfaccia di amministrazione Ignite. Con una chiave API puoi leggere i preset, per esempio per renderizzare il tuo player con lo stesso design. Le chiavi API non possono creare, aggiornare o eliminare preset.

L’oggetto preset del player è un oggetto JSON con le seguenti proprietà:

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

Contrassegna il preset predefinito del workspace. Solo un preset può essere il predefinito. Se crei un video senza preset, Ignite assegna il preset predefinito al video.

Proprietà di design del player

Tutte le proprietà tranne id, title, isDefault, createdAt e updatedAt sono impostazioni di design del player. Il player.playerDesign del video usa le stesse proprietà. La configurazione del player embed descrive cosa fa ogni impostazione.

La maggior parte delle proprietà di design ha un parametro URL corrispondente nel player embed. Queste proprietà usano un nome diverso:

aspectRatio non è un parametro URL. Vedi aspectRatio.

fullscreenOnPlay è solo un parametro URL. Non è salvato in un preset del player né in player.playerDesign.

I colori includono il prefisso # (per esempio #FFFFFF). Rimuovi il # quando passi un colore hex come parametro URL.

Usare un preset nel player embed

Per applicare un preset a un embed, passa il suo id come parametro URL preset.