@video-editor/protocol 0.0.1-beta.1 → 0.0.1-beta.11

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { IEffectSegment } from '@video-editor/shared';
 import { IFillMode } from '@video-editor/shared';
 import { IFilterSegment } from '@video-editor/shared';
 import { IFramesSegmentUnion } from '@video-editor/shared';
-import { IImageSegment } from '@video-editor/shared';
 import { ISamples } from './fetch';
+import { IStickerSegment } from '@video-editor/shared';
 import { ITextSegment } from '@video-editor/shared';
 import { ITrackType } from '@video-editor/shared';
 import { ITransition } from '@video-editor/shared';
@@ -36,7 +36,7 @@ export declare function createValidator(): {
     };
     verifyFramesSegment: (o: object) => IFramesSegmentUnion;
     verifyTextSegment: (o: object) => ITextSegment;
-    verifyPhotoSegment: (o: object) => IImageSegment;
+    verifyStickerSegment: (o: object) => IStickerSegment;
     verifyAudioSegment: (o: object) => IAudioSegment;
     verifyEffectSegment: (o: object) => IEffectSegment;
     verifyFilterSegment: (o: object) => IFilterSegment;
@@ -45,10 +45,15 @@ export declare function createValidator(): {
     };
     verifySegment: (o: object & {
         segmentType: ITrackType;
-    }) => IFramesSegmentUnion | IAudioSegment | IEffectSegment | IFilterSegment | IImageSegment | ITextSegment;
+    }) => IFramesSegmentUnion | IAudioSegment | IEffectSegment | IFilterSegment | IStickerSegment | ITextSegment;
 };
 
-export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
+export declare function createVideoProtocolManager(protocol: IVideoProtocol, options?: {
+    idFactory?: {
+        segment?: () => string;
+        track?: () => string;
+    };
+}): {
     videoBasicInfo: {
         version: `${number}.${number}.${number}`;
         width: number;
@@ -111,6 +116,9 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly segmentType: "frames";
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     } | {
     readonly type: "image";
     readonly format: "img" | "gif";
@@ -158,6 +166,9 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly segmentType: "frames";
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     } | {
     readonly type: "3D";
     readonly url: string;
@@ -204,7 +215,13 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly segmentType: "frames";
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     })[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     readonly isMain?: boolean | undefined;
     }[];
     text: readonly {
@@ -257,13 +274,19 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly url?: string | undefined;
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
-    image: readonly {
+    sticker: readonly {
     readonly trackId: string;
-    readonly trackType: "image";
+    readonly trackType: "sticker";
     readonly children: readonly {
-    readonly segmentType: "image";
+    readonly segmentType: "sticker";
     readonly format: "img" | "gif";
     readonly url: string;
     readonly fillMode?: IFillMode | undefined;
@@ -296,7 +319,13 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly id: string;
     readonly startTime: number;
     readonly endTime: number;
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     audio: readonly {
     readonly trackId: string;
@@ -312,7 +341,13 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly id: string;
     readonly startTime: number;
     readonly endTime: number;
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     effect: readonly {
     readonly trackId: string;
@@ -325,7 +360,13 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly url?: string | undefined;
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     filter: readonly {
     readonly trackId: string;
@@ -339,24 +380,73 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly url?: string | undefined;
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     }>;
     segmentMap: ComputedRef<Record<string, DeepReadonly<SegmentUnion | undefined>>>;
     getSegment: <T extends ITrackType>(id: SegmentUnion["id"], type?: T) => DeepReadonly<TrackTypeMapSegment[T]> | undefined;
-    addSegment: (segment: PartialByKeys<TrackTypeMapSegment[ITrackType], "id">) => string;
-    removeSegment: (id: SegmentUnion["id"]) => boolean;
+    addSegment: (segment: PartialByKeys<TrackTypeMapSegment[ITrackType], "id">) => {
+        id: string;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
+    removeSegment: (id: SegmentUnion["id"]) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
     updateSegment: <T extends ITrackType>(updater: (segment: TrackTypeMapSegment[T]) => void, id?: string, type?: T) => void;
+    moveSegment: (moveOptions: {
+        segmentId: string;
+        sourceTrackId: string;
+        targetTrackId?: string;
+        startTime: number;
+        endTime: number;
+        isNewTrack?: boolean;
+        newTrackInsertIndex?: number;
+        newTrackId?: string;
+    }) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
+    resizeSegment: (options: {
+        segmentId: string;
+        trackId: string;
+        startTime: number;
+        endTime: number;
+    }) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
     exportProtocol: () => IVideoProtocol;
     addTransition: (transition: ITransition, addTime?: number) => boolean;
     removeTransition: (segmentId: string) => boolean;
     updateTransition: (segmentId: string, updater: (transition: ITransition) => void) => boolean;
+    replaceTrackId: (oldTrackId: string, newTrackId: string) => boolean;
     undo: () => void;
     redo: () => void;
     redoCount: ComputedRef<number>;
     undoCount: ComputedRef<number>;
 };
 
+export declare const DEFAULT_RESOURCE_DIR = "/video-editor-res";
+
 export declare const DUPLICATE_SEGMENT_ID = "duplicate segment id";
 
 export declare const DUPLICATE_TRACK_ID = "duplicate track id";
@@ -379,6 +469,22 @@ export declare function fileToMP4Samples(input: string | OPFSToolFile, cbs: {
     stop: () => void;
 }>;
 
+/** Generate thumbnails for a video, preferring OPFS resources with network fallback. */
+export declare function generateThumbnails(url: string, options?: GenerateThumbnailsOptions): Promise<Thumbnail[]>;
+
+declare interface GenerateThumbnailsOptions {
+    /** Thumbnail width in pixels (default 100). */
+    imgWidth?: number;
+    /** Start time in microseconds. */
+    start?: number;
+    /** End time in microseconds. */
+    end?: number;
+    /** Step duration in microseconds; fallback to keyframes when omitted. */
+    step?: number;
+    /** OPFS resource directory; defaults to `/video-editor-res`. */
+    resourceDir?: string;
+}
+
 export declare function getResourceType(url: string): Promise<{
     type: IResType;
     totalSize: number;
@@ -414,6 +520,11 @@ declare type PartialByKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T,
 
 export { SegmentUnion }
 
+declare interface Thumbnail {
+    ts: number;
+    img: Blob;
+}
+
 export { TrackTypeMapSegment }
 
 export { TrackUnion }