Member Junction
    Preparing search index...

    Interface VideoGenerationParams

    Parameters for submitting a general video generation job via BaseVideoGenerator.GenerateVideo.

    interface VideoGenerationParams {
        AspectRatio: string;
        CancellationToken?: AbortSignal;
        DurationSeconds: number;
        Keyframes?: VideoKeyframeInput[];
        Mode: VideoGenerationMode;
        Prompt: string;
        Quality: VideoGenerationQuality;
        ReferenceImages?: MediaInput[];
        Seed?: number;
        SourceVideo?: MediaInput;
        WantAudio?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    AspectRatio CancellationToken? DurationSeconds Keyframes? Mode Prompt Quality ReferenceImages? Seed? SourceVideo? WantAudio?

    Properties

    AspectRatio: string

    Aspect ratio in width:height form (for example, '16:9', '9:16', '1:1', '4:5').

    CancellationToken?: AbortSignal

    Optional signal for cancelling the request. The driver is responsible for honoring it: it passes the signal to the provider's SDK or HTTP call, so an aborted request is torn down rather than left running. A driver that stops because the signal fired reports the failure classified as Cancelled (see BuildCancellationErrorInfo), which is never failed over.

    DurationSeconds: number

    Requested output clip duration in seconds.

    Keyframes?: VideoKeyframeInput[]

    Optional timestamped keyframe images anchoring motion across the clip.

    Mode: VideoGenerationMode

    Generation mode selecting how input references/video are used.

    Prompt: string

    Text prompt describing the scene, motion, and visual style to generate.

    Quality: VideoGenerationQuality

    Vendor-neutral quality tier ('draft' | 'standard' | 'high').

    ReferenceImages?: MediaInput[]

    Optional reference images guiding subject, style, or initial frame.

    Seed?: number

    Optional deterministic seed when supported by the provider.

    SourceVideo?: MediaInput

    Optional source video for 'VideoToVideo' or 'Continuation' modes.

    WantAudio?: boolean

    Whether synchronized ambient/generated audio is requested with the video clip.

    Settings

    Member Visibility

    On This Page

    Properties