Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

CanvasVideoBackground

Published interface export CanvasVideoBackground.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/canvas.ts (opens in a new tab)

Signature

TypeScript
export interface CanvasVideoBackground extends CanvasImageBackgroundOptions {
    source: string | Buffer;
    /**
     * 1-based frame number. Mutually exclusive with `time`.
     * Defaults to frame 1 when neither selector is provided.
     */
    frame?: number;
    /** Timestamp in seconds. Mutually exclusive with `frame`. */
    time?: number;
    format?: "jpg" | "png";
    /** FFmpeg image quality value from 1 (best) through 31. */
    quality?: number;
    /** @deprecated A canvas video background is one extracted still frame; looping has no effect. */
    loop?: boolean;
    /** @deprecated A canvas video background is one extracted still frame; autoplay has no effect. */
    autoplay?: boolean;
}

Related APIs

No explicit related API metadata.

Next steps