The player preset object

A player preset is a reusable player design. You create and edit presets in the Ignite admin interface. With an API key, you can read presets, for example to render your own player with the same design. API keys cannot create, update, or delete presets.

The player preset object is a JSON object with the following properties:

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

Marks the default preset of the workspace. Only one preset can be the default. If you create a video without a preset, Ignite assigns the default preset to the video.

Player design properties

All properties except id, title, isDefault, createdAt, and updatedAt are player design settings. The video’s player.playerDesign uses the same properties. The embed player setup describes what each setting does.

Most design properties have a matching URL parameter. These properties use a different name:

aspectRatio is not a URL parameter. See aspectRatio.

fullscreenOnPlay is only a URL parameter. It is not stored on a player preset or on player.playerDesign.

Colors include the # prefix (for example #FFFFFF). Remove the # when you pass a hex color as a URL parameter.

Use a preset in the embed player

To apply a preset to an embed, pass its id as the preset URL parameter.