adobe-firefly-sdk
    Preparing search index...

    Type Alias Overlay

    Configuration for an overlay in the reframed video.

    type Overlay = {
        duration: string;
        mediaType: "image/gif" | "image/png" | "image/jpeg";
        position: {
            anchorPoint:
                | "top_left"
                | "top_right"
                | "bottom_left"
                | "bottom_right"
                | "center";
            offsetX: number;
            offsetY: number;
        };
        repeat?: "loop"
        | "once";
        scale: { height: number; width: number };
        source: { url: string };
        startTime: string;
    }
    Index

    Properties

    duration mediaType position repeat? scale source startTime

    Properties

    duration: string

    The duration of the overlay in the video.

    mediaType: "image/gif" | "image/png" | "image/jpeg"

    The media type of the overlay.

    position: {
        anchorPoint:
            | "top_left"
            | "top_right"
            | "bottom_left"
            | "bottom_right"
            | "center";
        offsetX: number;
        offsetY: number;
    }

    The position of the overlay.

    Type Declaration

    • anchorPoint: "top_left" | "top_right" | "bottom_left" | "bottom_right" | "center"

      The anchor point of the overlay.

    • offsetX: number

      The X offset of the overlay from the anchor point.

    • offsetY: number

      The Y offset of the overlay from the anchor point.

    repeat?: "loop" | "once"

    The repeat behavior of the overlay.

    scale: { height: number; width: number }

    The scale of the overlay.

    Type Declaration

    • height: number

      The height of the overlay.

    • width: number

      The width of the overlay.

    source: { url: string }

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

    Type Declaration

    • url: string

      The pre-signed URL pointing to the overlay source.

    startTime: string

    The start time of the overlay in the video.

    Settings

    Member Visibility

    On This Page

    Properties