adobe-firefly-sdk
    Preparing search index...

    Type Alias GenerateReframedVideoData

    type GenerateReframedVideoData = {
        body: {
            outputConfig: { aspectRatios: string[] };
            overlays?: Overlay[];
            sceneEditDetection?: boolean;
            video: {
                mediaType: "video/mp4" | "video/quicktime";
                source: { url: string };
            };
        };
        path?: never;
        query?: never;
        url: "/v1/reframe";
    }
    Index

    Properties

    body path? query? url

    Properties

    body

    body: {
        outputConfig: { aspectRatios: string[] };
        overlays?: Overlay[];
        sceneEditDetection?: boolean;
        video: {
            mediaType: "video/mp4" | "video/quicktime";
            source: { url: string };
        };
    }

    The reframe request body.

    Type Declaration

    • outputConfig: { aspectRatios: string[] }

      Configuration details for the generated reframed video.

      • aspectRatios: string[]

        A list of aspect ratios for the output video.

    • Optionaloverlays?: Overlay[]

      Configuration details for video overlays.

    • OptionalsceneEditDetection?: boolean

      Apply Scene Edit Detection before reframing.

    • video: { mediaType: "video/mp4" | "video/quicktime"; source: { url: string } }

      Video input details.

      • mediaType: "video/mp4" | "video/quicktime"

        Supported video media types.

      • source: { url: string }

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

        • url: string

          The pre-signed URL pointing to the input source.

    path?: never
    query?: never
    url: "/v1/reframe"

    Settings

    Member Visibility

    On This Page

    Properties