VidStudio SDK reference
    Preparing search index...

    Interface ClipRepository

    interface ClipRepository {
        create(data: Omit<Clip, "id">): Promise<Clip>;
        delete(id: string): Promise<void>;
        deleteByTrackId(trackId: string): Promise<void>;
        getAll(): Promise<Clip[]>;
        getById(id: string): Promise<Clip | undefined>;
        getByMediaAssetId(mediaAssetId: string): Promise<Clip[]>;
        getByTrackId(trackId: string): Promise<Clip[]>;
        restore(clip: Clip): Promise<void>;
        setLinkedClip(clipId: string, partnerId: string | null): Promise<void>;
        update(
            id: string,
            changes: Partial<
                Pick<
                    Clip,
                    | "start_time"
                    | "duration"
                    | "source_offset"
                    | "volume"
                    | "opacity"
                    | "text_content"
                    | "text_properties",
                >,
            >,
        ): Promise<Clip>;
    }
    Index
    • Parameters

      • data: Omit<Clip, "id">

      Returns Promise<Clip>

    • Parameters

      • id: string

      Returns Promise<void>

    • Parameters

      • trackId: string

      Returns Promise<void>

    • Every clip row in the database, across all tracks.

      Returns Promise<Clip[]>

    • Parameters

      • id: string

      Returns Promise<Clip | undefined>

    • Find all clips that use a specific media asset

      Parameters

      • mediaAssetId: string

      Returns Promise<Clip[]>

    • Parameters

      • trackId: string

      Returns Promise<Clip[]>

    • Restore a clip with its original ID (for undo). Creates or replaces.

      Parameters

      Returns Promise<void>

    • Writes the partner onto the row, or takes the field off when partnerId is null.

      Parameters

      • clipId: string
      • partnerId: string | null

      Returns Promise<void>

    • Parameters

      • id: string
      • changes: Partial<
            Pick<
                Clip,
                | "start_time"
                | "duration"
                | "source_offset"
                | "volume"
                | "opacity"
                | "text_content"
                | "text_properties",
            >,
        >

      Returns Promise<Clip>