Brand template representation

templateId

string

required

Template ID

Example:

"cm32g2poc0002t5bnhmg2kfyx"

name

string

required

Template name

Example:

"Karaoke Template"

isDefault

boolean

required

Is default template

Example:

true

preferences

object

required

Render preference

preferences.enableAutoLayout

boolean

default:false

required

Enables automatic layout adjustment.

Example:

false

preferences.enableScreenLayout

boolean

default:false

required

Enables screen layout for the video.

Example:

true

preferences.enableCrop

boolean

default:false

required

Enables cropping of the video.

Example:

true

preferences.enableCaption

boolean

default:false

required

Enables caption overlay on the video.

Example:

true

preferences.enableUppercase

boolean

default:false

required

Converts all characters to uppercase in captions.

Example:

true

preferences.enableHighlight

boolean

default:false

required

Enables keyword highlighting in captions.

Example:

true

preferences.enableEmoji

boolean

default:false

required

Enables emoji overlay on the video.

Example:

true

preferences.enableFillLayout

boolean

default:false

required

Enables fill layout for a single person.

Example:

false

preferences.enableSplitLayout

boolean

default:false

required

Enables split layout for two people.

Example:

true

preferences.enableThreeLayout

boolean

default:false

required

Enables layout for three people.

Example:

true

preferences.enableFourLayout

boolean

default:false

required

Enables layout for four people.

Example:

true

preferences.enableFitLayout

boolean

default:false

required

Enables fit layout for multiple people.

Example:

false

preferences.fitLayoutCropRatio

string

default:4:3

required

Specifies the crop ratio for fit layout.

Example:

"4:3"

preferences.enableVisualHook

boolean

default:false

required

Enables visual hook overlay, deprecated and should always be false.

Example:

false

preferences.enableWatermark

boolean

default:false

required

Enables watermark overlay.

Example:

false

preferences.font

object

required

Font settings for captions.

preferences.font.color

string

required

The color of the font.

Example:

"#ffffff"

preferences.font.style

string[]

required

The style of the font.

Example:

["900"]

preferences.font.family

string

required

The family of the font.

Example:

"Komika-axis"

preferences.font.stroke

object

required

The stroke settings of the font.

Example:

{
  "enabled": false,
  "color": "#000000FF",
  "width": 16
}

preferences.font.shadow

object

required

The shadow settings of the font.

Example:

{
  "enabled": true,
  "color": "#FFFFFFFF",
  "x": 2,
  "y": 2,
  "blur": 16
}

preferences.font.id

string

The ID of the font.

Example:

"font123"

preferences.font.type

enum<string>

The type of the font.

Available options:

CustomizedFont,

System

Example:

"CustomizedFont"

preferences.font.name

string

The name of the font.

Example:

"Arial"

preferences.font.path

string

The storage path of the font.

Example:

"/fonts/arial.ttf"

preferences.font.size

enum<string>

The size of the font.

Available options:

Large,

Middle,

Small

Example:

"Large"

preferences.font.numericalSize

number

The numerical size of the font.

Example:

50

preferences.font.textDecoration

enum<string>

The text decoration of the font.

Available options:

line-through,

underline,

Example:

"underline"

Example:

{
  "color": "#ffffff",
  "style": ["900"],
  "family": "Komika-axis",
  "stroke": {
    "enabled": false,
    "color": "#000000FF",
    "width": 16
  },
  "shadow": {
    "enabled": true,
    "color": "#FFFFFFFF",
    "x": 2,
    "y": 2,
    "blur": 16
  }
}

preferences.highlightColor

object

required

Highlight colors for keywords in captions.

Example:

{
  "primary": "#ff0000",
  "secondary": "#00ff00"
}

preferences.layoutAspectRatio

enum<string>

default:portrait

Specifies the layout aspect ratio.

Available options:

portrait,

landscape,

square

Example:

"portrait"

preferences.enableBroll

boolean

default:false

Enables B-Roll overlay on the video.

Example:

false

Example:

{
  "enableAutoLayout": false,
  "enableFillLayout": false,
  "enableFitLayout": false,
  "fitLayoutCropRatio": "4:3",
  "enableSplitLayout": true,
  "enableThreeLayout": true,
  "enableFourLayout": true,
  "enableScreenLayout": true,
  "enableVisualHook": false,
  "enableWatermark": false,
  "enableCrop": true,
  "enableCaption": true,
  "enableUppercase": true,
  "enableHighlight": true,
  "enableEmoji": true,
  "font": {
    "color": "#ffffff",
    "style": ["900"],
    "family": "Komika-axis",
    "stroke": {
      "enabled": false,
      "color": "#000000FF",
      "width": 16
    },
    "shadow": {
      "enabled": true,
      "color": "#FFFFFFFF",
      "x": 2,
      "y": 2,
      "blur": 16
    }
  },
  "highlightColor": {
    "primary": "#04f827",
    "secondary": "#FFFD03"
  }
}

type

string

Type of template

Example:

"PresetOverwrite"

GET STARTED

ENDPOINTS

PLAYGROUND

Brand template representation