Interface Overlay

Configuration for an overlay in the reframed video.

interface Overlay {
    duration: string;
    mediaType: AudioVideoApiClient.OverlayMediaType;
    position: OverlayPosition;
    repeat?: AudioVideoApiClient.OverlayRepeat;
    scale: OverlayScale;
    source: OverlaySource;
    startTime: string;
}

Index

Properties

duration mediaType position repeat? scale source startTime

Properties

duration

duration: string

The duration of the overlay in the video.

mediaType

mediaType: AudioVideoApiClient.OverlayMediaType

The media type of the overlay.

position

position: OverlayPosition

The position of the overlay.

`Optional`repeat

repeat?: AudioVideoApiClient.OverlayRepeat

The repeat behavior of the overlay.

scale

scale: OverlayScale

The scale of the overlay.

source

source: OverlaySource

Details of the source including a pre-signed URL. See the list of allowed domains for storage.

startTime

startTime: string

The start time of the overlay in the video.