L’objet preset de lecteur

Un preset de lecteur est un design de lecteur réutilisable. Tu crées et modifies les presets dans l’interface d’administration Ignite. Avec une Clé API, tu peux lire les presets, par exemple pour afficher ton propre lecteur avec le même design. Les Clés API ne peuvent pas créer, mettre à jour ni supprimer de presets.

L’objet preset de lecteur est un objet JSON avec les propriétés suivantes :

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

Indique le preset par défaut de l’espace de travail. Un seul preset peut être le preset par défaut. Si tu crées une vidéo sans preset, Ignite lui assigne le preset par défaut.

Options de design du lecteur

Toutes les propriétés sauf id, title, isDefault, createdAt et updatedAt sont des réglages de design du lecteur. Le champ player.playerDesign de la vidéo utilise les mêmes propriétés. La configuration du lecteur embed décrit ce que fait chaque réglage.

La plupart des propriétés de design ont un paramètre d’URL correspondant dans le lecteur embed. Ces propriétés utilisent un nom différent :

aspectRatio n’est pas un paramètre d’URL. Voir aspectRatio.

fullscreenOnPlay est seulement un paramètre d’URL. Il n’est pas enregistré dans un preset de lecteur ni dans player.playerDesign.

Les couleurs incluent le préfixe # (par exemple #FFFFFF). Retire le # lorsque tu passes une couleur hex comme paramètre d’URL.

Utiliser un preset dans le lecteur embed

Pour appliquer un preset à une intégration, passe son id comme paramètre d’URL preset.