Obiekt presetu odtwarzacza

Preset odtwarzacza to wielokrotnego użytku design odtwarzacza. Tworzysz i edytujesz presety w panelu administracyjnym Ignite. Kluczem API możesz odczytywać presety, na przykład aby renderować własny odtwarzacz z tym samym designem. Klucze API nie mogą tworzyć, aktualizować ani usuwać presetów.

Obiekt presetu odtwarzacza to obiekt JSON z następującymi właściwościami:

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

Oznacza domyślny preset workspace. Tylko jeden preset może być domyślny. Jeśli utworzysz wideo bez presetu, Ignite przypisze do wideo domyślny preset.

Właściwości designu odtwarzacza

Wszystkie właściwości oprócz id, title, isDefault, createdAt i updatedAt to ustawienia designu odtwarzacza. player.playerDesign wideo używa tych samych właściwości. Konfiguracja odtwarzacza embed opisuje, co robi każde ustawienie.

Większość właściwości designu ma odpowiadający parametr URL w odtwarzaczu embed. Te właściwości używają innej nazwy:

aspectRatio nie jest parametrem URL. Zobacz aspectRatio.

fullscreenOnPlay to tylko parametr URL. Nie jest zapisany w presecie odtwarzacza ani w player.playerDesign.

Kolory zawierają prefiks # (na przykład #FFFFFF). Usuń #, gdy przekazujesz kolor hex jako parametr URL.

Użycie presetu w odtwarzaczu embed

Aby zastosować preset w osadzeniu, przekaż jego id jako parametr URL preset.