BrandingOverlayOptions

BrandingOverlayOptions = OverlayFillPlacement | OverlayBoxPlacement & Pick<OverlayCaptureCommon, "duration" | "clip" | "pinToScreen" | "overMouse" | "fadeIn" | "fadeOut"> & object

Defined in: asset.ts:607

Declares an overlay whose file is a shared branding asset: an image or video uploaded once on the Branding page and referenced from code by name.

Unlike a { path } overlay, no bytes are recorded or uploaded. The export resolves the name against the Branding page (the project’s override first, then the organisation’s), so replacing the file there updates every video on its next export without re-recording. An export whose name no longer exists fails with a clear message rather than silently dropping the overlay.

An image asset needs a length (duration, .for(), .until(), or a live start()/end() window); a video asset plays its own length and accepts the video options (volume, speed, time, start, end).

Type Declaration

end?

optional end?: TimelineOffset

Early end into a branding VIDEO.

speed?

optional speed?: number

Playback-rate multiplier for a branding VIDEO.

start?

optional start?: TimelineOffset

Late start into a branding VIDEO.

time?

optional time?: number

Target playback duration (ms) for a branding VIDEO.

volume?

optional volume?: number

Linear gain for a branding VIDEO (rejected for an image asset).

Example

const overlays = createOverlays({
  logo: { branding: 'logo', x: 1560, y: 960, width: 288 },
  intro: { branding: 'intro-clip', fill: 'screen' },
})
await overlays.intro()
await overlays.logo.for(3000)