O objeto de preset do leitor

Um preset do leitor é um design de leitor reutilizável. Crias e editas presets na interface de administração Ignite. Com uma chave API podes ler presets, por exemplo para renderizar o teu próprio leitor com o mesmo design. As chaves API não podem criar, atualizar nem eliminar presets.

O objeto de preset do leitor é um objeto JSON com as seguintes propriedades:

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

Marca o preset predefinido do workspace. Só um preset pode ser o predefinido. Se criares um vídeo sem preset, a Ignite atribui o preset predefinido ao vídeo.

Propriedades de design do leitor

Todas as propriedades exceto id, title, isDefault, createdAt e updatedAt são definições de design do leitor. O player.playerDesign do vídeo usa as mesmas propriedades. A configuração do leitor embed descreve o que cada definição faz.

A maioria das propriedades de design tem um parâmetro de URL correspondente no leitor embed. Estas propriedades usam um nome diferente:

aspectRatio não é um parâmetro de URL. Vê aspectRatio.

fullscreenOnPlay é apenas um parâmetro de URL. Não fica guardado num preset do leitor nem em player.playerDesign.

As cores incluem o prefixo # (por exemplo #FFFFFF). Remove o # quando passas uma cor hex como parâmetro de URL.

Usar um preset no leitor embed

Para aplicar um preset a uma incorporação, passa o seu id como parâmetro de URL preset.