VideoUltra API
    Preparing search index...

    Function useProject

    • Part of the project as the editor shows it (inside an open combined clip, its inside), re-rendering only when it changes (shallow compare).

      Type Parameters

      • T

      Parameters

      • selector: (
            project: {
                assets: z.ZodMiniRecord<
                    z.ZodMiniString<string>,
                    z.ZodMiniObject<
                        {
                            audioTrack: z.ZodMiniOptional<z.ZodMiniInt>;
                            credit: z.ZodMiniOptional<z.ZodMiniString<string>>;
                            duration: z.ZodMiniInt;
                            fps: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
                            hasAudio: z.ZodMiniBoolean<boolean>;
                            hdr: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
                            height: z.ZodMiniOptional<z.ZodMiniInt>;
                            id: z.ZodMiniString<string>;
                            kind: z.ZodMiniEnum<
                                {
                                    audio: "audio";
                                    compound: "compound";
                                    image: "image";
                                    lut: "lut";
                                    video: "video";
                                },
                            >;
                            mimeType: z.ZodMiniString<string>;
                            name: z.ZodMiniString<string>;
                            rotation: z.ZodMiniOptional<
                                z.ZodMiniUnion<
                                    readonly [
                                        z.ZodMiniLiteral<0>,
                                        z.ZodMiniLiteral<90>,
                                        z.ZodMiniLiteral<180>,
                                        z.ZodMiniLiteral<270>,
                                    ],
                                >,
                            >;
                            size: z.ZodMiniInt;
                            source: z.ZodMiniDiscriminatedUnion<
                                [
                                    z.ZodMiniObject<
                                        { key: z.ZodMiniString<string>; type: z.ZodMiniLiteral<"opfs"> },
                                        z.core.$strip,
                                    >,
                                    z.ZodMiniObject<
                                        {
                                            key: z.ZodMiniString<string>;
                                            type: z.ZodMiniLiteral<"handle">;
                                        },
                                        z.core.$strip,
                                    >,
                                    z.ZodMiniObject<
                                        { type: z.ZodMiniLiteral<"url">; url: z.ZodMiniString<string> },
                                        z.core.$strip,
                                    >,
                                    z.ZodMiniObject<
                                        { type: z.ZodMiniLiteral<"compound"> },
                                        z.core.$strip,
                                    >,
                                ],
                                "type",
                            >;
                            tracks: z.ZodMiniOptional<
                                z.ZodMiniArray<
                                    z.ZodMiniObject<
                                        {
                                            caption: z.ZodMiniOptional<z.ZodMiniObject<(...), (...)>>;
                                            hidden: z.ZodMiniBoolean<boolean>;
                                            id: z.ZodMiniString<string>;
                                            items: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<(...), (...)>>;
                                            kind: z.ZodMiniEnum<
                                                {
                                                    audio: ...;
                                                    caption: ...;
                                                    main: ...;
                                                    overlay: ...;
                                                    text: ...;
                                                },
                                            >;
                                            locked: z.ZodMiniBoolean<boolean>;
                                            muted: z.ZodMiniBoolean<boolean>;
                                        },
                                        z.core.$strip,
                                    >,
                                >,
                            >;
                            vfr: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
                            width: z.ZodMiniOptional<z.ZodMiniInt>;
                        },
                        z.core.$strip,
                    >,
                >;
                createdAt: string;
                id: string;
                markers?: { id: string; label?: string; time: number }[];
                name: string;
                settings: {
                    background:
                        | { color: string; type: "color" }
                        | { amount: number; type: "blur" };
                    exportRange?: { end: number; start: number };
                    frameRate: { den: number; num: number };
                    height: number;
                    width: number;
                };
                tracks: {
                    caption?: {
                        highlight: "fill"
                        | "none"
                        | "type"
                        | "word"
                        | "box"
                        | "reveal";
                        highlightColor: string;
                        preset: string;
                    };
                    hidden: boolean;
                    id: string;
                    items: (
                        | {
                            adjust: {
                                brightness?: number;
                                contrast?: number;
                                highlights?: number;
                                saturation?: number;
                                shadows?: number;
                                sharpen?: number;
                                tint?: number;
                                vignette?: number;
                                warmth?: number;
                            };
                            animation?: {
                                in?: { duration: ...; type: ... };
                                loop?: { speed?: ...; type: ... };
                                out?: { duration: ...; type: ... };
                            };
                            assetId: string;
                            audioFx?: {
                                compress?: number;
                                denoise?: number;
                                eq?: { high: ...; low: ...; mid: ... };
                                keepPitch?: boolean;
                                pitch?: number;
                            };
                            blend?: | "add"
                            | "normal"
                            | "multiply"
                            | "screen"
                            | "overlay"
                            | "soft-light"
                            | "lighten"
                            | "darken"
                            | "difference";
                            crop: { bottom: number; left: number; right: number; top: number };
                            duck?: number;
                            duration: number;
                            fadeIn: number;
                            fadeOut: number;
                            filter: { id: string; intensity: number } | null;
                            fit: "fit" | "fill";
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            key?: {
                                color: string;
                                softness: number;
                                spill: number;
                                tolerance: number;
                            };
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "video";
                            locked?: boolean;
                            lut?: { assetId: string; intensity: number };
                            mask?: { feather: number; invert?: boolean; shape: string };
                            muted: boolean;
                            name?: string;
                            sourceIn: number;
                            speed: number;
                            start: number;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                            transitionIn: | {
                                direction?: "left"
                                | "right"
                                | "up"
                                | "down";
                                duration: number;
                                ease?:
                                    | "back"
                                    | "linear"
                                    | "smooth"
                                    | "ease-in"
                                    | "ease-out"
                                    | "snappy"
                                    | "expo"
                                    | "anticipate"
                                    | "bounce"
                                    | "elastic"
                                    | "ball"
                                    | "slow-mo"
                                    | "steps";
                                type: string;
                            }
                            | null;
                            volume: number;
                        }
                        | {
                            adjust: {
                                brightness?: number;
                                contrast?: number;
                                highlights?: number;
                                saturation?: number;
                                shadows?: number;
                                sharpen?: number;
                                tint?: number;
                                vignette?: number;
                                warmth?: number;
                            };
                            animation?: {
                                in?: { duration: ...; type: ... };
                                loop?: { speed?: ...; type: ... };
                                out?: { duration: ...; type: ... };
                            };
                            assetId: string;
                            blend?: | "add"
                            | "normal"
                            | "multiply"
                            | "screen"
                            | "overlay"
                            | "soft-light"
                            | "lighten"
                            | "darken"
                            | "difference";
                            crop: { bottom: number; left: number; right: number; top: number };
                            cutout?: { assetId: string };
                            duration: number;
                            filter: { id: string; intensity: number } | null;
                            fit: "fit" | "fill";
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            key?: {
                                color: string;
                                softness: number;
                                spill: number;
                                tolerance: number;
                            };
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "image";
                            locked?: boolean;
                            lut?: { assetId: string; intensity: number };
                            mask?: { feather: number; invert?: boolean; shape: string };
                            name?: string;
                            start: number;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                            transitionIn: | {
                                direction?: "left"
                                | "right"
                                | "up"
                                | "down";
                                duration: number;
                                ease?:
                                    | "back"
                                    | "linear"
                                    | "smooth"
                                    | "ease-in"
                                    | "ease-out"
                                    | "snappy"
                                    | "expo"
                                    | "anticipate"
                                    | "bounce"
                                    | "elastic"
                                    | "ball"
                                    | "slow-mo"
                                    | "steps";
                                type: string;
                            }
                            | null;
                        }
                        | {
                            adjust: {
                                brightness?: number;
                                contrast?: number;
                                highlights?: number;
                                saturation?: number;
                                shadows?: number;
                                sharpen?: number;
                                tint?: number;
                                vignette?: number;
                                warmth?: number;
                            };
                            animation?: {
                                in?: { duration: ...; type: ... };
                                loop?: { speed?: ...; type: ... };
                                out?: { duration: ...; type: ... };
                            };
                            assetId: string;
                            blend?: | "add"
                            | "normal"
                            | "multiply"
                            | "screen"
                            | "overlay"
                            | "soft-light"
                            | "lighten"
                            | "darken"
                            | "difference";
                            crop: { bottom: number; left: number; right: number; top: number };
                            duration: number;
                            filter: { id: string; intensity: number } | null;
                            fit: "fit" | "fill";
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            key?: {
                                color: string;
                                softness: number;
                                spill: number;
                                tolerance: number;
                            };
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "freeze";
                            locked?: boolean;
                            lut?: { assetId: string; intensity: number };
                            mask?: { feather: number; invert?: boolean; shape: string };
                            name?: string;
                            sourceTime: number;
                            start: number;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                            transitionIn: | {
                                direction?: "left"
                                | "right"
                                | "up"
                                | "down";
                                duration: number;
                                ease?:
                                    | "back"
                                    | "linear"
                                    | "smooth"
                                    | "ease-in"
                                    | "ease-out"
                                    | "snappy"
                                    | "expo"
                                    | "anticipate"
                                    | "bounce"
                                    | "elastic"
                                    | "ball"
                                    | "slow-mo"
                                    | "steps";
                                type: string;
                            }
                            | null;
                        }
                        | {
                            assetId: string;
                            audioFx?: {
                                compress?: number;
                                denoise?: number;
                                eq?: { high: ...; low: ...; mid: ... };
                                keepPitch?: boolean;
                                pitch?: number;
                            };
                            duck?: number;
                            duration: number;
                            fadeIn: number;
                            fadeOut: number;
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            kind: "audio";
                            locked?: boolean;
                            muted: boolean;
                            name?: string;
                            sourceIn: number;
                            speed: number;
                            start: number;
                            volume: number;
                        }
                        | {
                            adjust: {
                                brightness?: number;
                                contrast?: number;
                                highlights?: number;
                                saturation?: number;
                                shadows?: number;
                                sharpen?: number;
                                tint?: number;
                                vignette?: number;
                                warmth?: number;
                            };
                            animation?: {
                                in?: { duration: ...; type: ... };
                                loop?: { speed?: ...; type: ... };
                                out?: { duration: ...; type: ... };
                            };
                            blend?: | "add"
                            | "normal"
                            | "multiply"
                            | "screen"
                            | "overlay"
                            | "soft-light"
                            | "lighten"
                            | "darken"
                            | "difference";
                            duration: number;
                            filter: { id: string; intensity: number }
                            | null;
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "text";
                            locked?: boolean;
                            maxWidth?: number;
                            name?: string;
                            start: number;
                            style: {
                                align: "left"
                                | "right"
                                | "center";
                                background: { color: string; padding: number; radius: number } | null;
                                color: string;
                                fontFamily: string;
                                fontWeight: number;
                                italic: boolean;
                                letterSpacing: number;
                                lineHeight: number;
                                outline: { color: string; width: number } | null;
                                shadow: { blur: number; color: string; x: number; y: number } | null;
                                size: number;
                            };
                            text: string;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                            unsure?: boolean;
                            words?: { end: number; start: number; text: string }[];
                        }
                        | {
                            adjust: {
                                brightness?: number;
                                contrast?: number;
                                highlights?: number;
                                saturation?: number;
                                shadows?: number;
                                sharpen?: number;
                                tint?: number;
                                vignette?: number;
                                warmth?: number;
                            };
                            animation?: {
                                in?: { duration: ...; type: ... };
                                loop?: { speed?: ...; type: ... };
                                out?: { duration: ...; type: ... };
                            };
                            assetId: string
                            | null;
                            blend?:
                                | "add"
                                | "normal"
                                | "multiply"
                                | "screen"
                                | "overlay"
                                | "soft-light"
                                | "lighten"
                                | "darken"
                                | "difference";
                            cutout?: { assetId: string };
                            duration: number;
                            emoji: string | null;
                            filter: { id: string; intensity: number } | null;
                            groupId?: string;
                            hidden?: boolean;
                            id: string;
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "sticker";
                            locked?: boolean;
                            name?: string;
                            start: number;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                        }
                        | {
                            amount: number;
                            duration: number;
                            effect: "blur"
                            | "pixelate";
                            groupId?: string;
                            height: number;
                            hidden?: boolean;
                            id: string;
                            keyframes?: {
                                opacity?: (...)[];
                                rotation?: (...)[];
                                scale?: (...)[];
                                shift?: number;
                                x?: (...)[];
                                y?: (...)[];
                            };
                            kind: "region";
                            locked?: boolean;
                            name?: string;
                            shape: "rectangle"
                            | "ellipse";
                            start: number;
                            transform: {
                                flipX: boolean;
                                flipY: boolean;
                                opacity: number;
                                rotation: number;
                                scale: number;
                                x: number;
                                y: number;
                            };
                            width: number;
                        }
                    )[];
                    kind: "audio"
                    | "text"
                    | "overlay"
                    | "caption"
                    | "main";
                    locked: boolean;
                    muted: boolean;
                }[];
                updatedAt: string;
                version: 6;
            },
        ) => T

      Returns T