@vvfx/sdk 0.0.0-alpha.23 → 0.0.0-alpha.24

package/dist/index.d.ts

@@ -46,40 +46,6 @@ type SetItemPropertyValueParam = {
     }[keyof PageFormTypeAndPropertyReference[T]];
 }[keyof PageFormTypeAndPropertyReference];
 
-declare global {
-    interface Window {
-        /**
-         * @description 创建 WebP Core 实例
-         */
-        createWebPCore: (config: any) => Promise<Img2WebPCore>;
-    }
-}
-type FS = {
-    writeFile: (path: string, data: Uint8Array | string) => void;
-    readFile(path: string, opts: {
-        encoding: 'binary';
-        flags?: string | undefined;
-    }): Uint8Array;
-    readFile(path: string, opts: {
-        encoding: 'utf8';
-        flags?: string | undefined;
-    }): string;
-    readFile(path: string, opts?: {
-        flags?: string | undefined;
-    }): Uint8Array;
-    unlink: (path: string) => void;
-    quit: () => void;
-};
-type Pointer = number;
-type Img2WebPCore = {
-    FS: FS;
-    run: (...args: string[]) => number;
-    cwrap: (ident: string, returnType: string, argTypes: string[]) => ((argc: number, argv: Pointer) => number);
-    _malloc: (size: number) => Pointer;
-    writeAsciiToMemory: (str: string, buffer: number, dontAddNull?: boolean) => void;
-    setValue: (ptr: number, value: any, type: string, noSafe?: boolean) => void;
-};
-
 type BaseFormProperty = {
     position: [number, number, number];
     rotation: [number, number, number];
@@ -128,18 +94,10 @@ type SpecificPageFormProps<T extends keyof PageFormTypeAndPropertyReference> = {
     property: PageFormTypeAndPropertyReference[T];
     onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[T]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[T][N]) => void;
 };
-/** 视频导出状态 */
-declare const ExportStatusMap: {
-    readonly DEFAULT: "default";
-    readonly EXPORTING: "exporting";
-    readonly SUCCESS: "success";
-    readonly ERROR: "error";
-};
 type SDKOptions = {
     /** 导出视频时，是否开启转码日志 */
     loggerInExportVideoTranscoding?: boolean;
 };
-type ExportStatus = typeof ExportStatusMap[keyof typeof ExportStatusMap];
 /**
  * @description SDK入参
  */
@@ -156,14 +114,6 @@ type SDKInputParam = {
      * @description 页面属性
      */
     options: PageOptions;
-    /**
-     * @description 是否开启出血区强制变换
-     */
-    keepSafe?: boolean;
-    /**
-     * @description 是否开启静态预览功能 - 第一个合成仅支持播放，不可编辑
-     */
-    staticPreview?: boolean;
 };
 /**
  * @description 页面属性
@@ -218,7 +168,7 @@ type PageData = {
 /**
  * @description 页面配置
  */
-type PageConfig = {
+type PageConfig$1 = {
     /**
      * @description 出血区域展示开关
      */
@@ -272,7 +222,7 @@ type ViewParam = {
     /**
      * @description 出血区参数
      */
-    safeArea: [number, number, number, number];
+    safeArea?: [number, number, number, number];
     /**
      * @description 自定义出血区 - 用于展示
      */
@@ -335,10 +285,6 @@ type ViewProperty = {
      * @description 视图场景数据
      */
     scene: spec.JSONScene;
-    /**
-     * @description 预览图数据
-     */
-    thumbnail: string;
     /**
      * @description 导出参数
      */
@@ -412,6 +358,284 @@ type ViewItem = {
     endBehavior: spec.EndBehavior;
 } & ViewItemTypedProperty;
 
+declare const MEDIA_TYPE: {
+    readonly APNG: "APNG";
+    readonly MP4: "MP4";
+    readonly WebM: "WebM";
+    readonly Images: "Images";
+    readonly WebP: "WebP";
+    readonly GIF: "GIF";
+    readonly AlphaMaskVideo: "AlphaMaskVideo";
+};
+
+declare global {
+    interface Window {
+        /**
+         * @description 创建 WebP Core 实例
+         */
+        createWebPCore: (config: any) => Promise<Img2WebPCore>;
+    }
+}
+type MediaType = typeof MEDIA_TYPE[keyof typeof MEDIA_TYPE];
+type FS = {
+    writeFile: (path: string, data: Uint8Array | string) => void;
+    readFile(path: string, opts: {
+        encoding: 'binary';
+        flags?: string | undefined;
+    }): Uint8Array;
+    readFile(path: string, opts: {
+        encoding: 'utf8';
+        flags?: string | undefined;
+    }): string;
+    readFile(path: string, opts?: {
+        flags?: string | undefined;
+    }): Uint8Array;
+    unlink: (path: string) => void;
+    quit: () => void;
+};
+type Pointer = number;
+type Img2WebPCore = {
+    FS: FS;
+    run: (...args: string[]) => number;
+    cwrap: (ident: string, returnType: string, argTypes: string[]) => ((argc: number, argv: Pointer) => number);
+    _malloc: (size: number) => Pointer;
+    writeAsciiToMemory: (str: string, buffer: number, dontAddNull?: boolean) => void;
+    setValue: (ptr: number, value: any, type: string, noSafe?: boolean) => void;
+};
+type ExportMediaInitOptions = {
+    /**
+     * 导出类型
+     */
+    mediaType: MediaType;
+    /**
+     * 额外画布，导出透明视频时使用
+     */
+    extraCanvas?: HTMLCanvasElement | null;
+    /**
+     * 是否打印转码过程中的日志，仅在导出 MP4/AlphaMaskVideo 时有效， 默认 false
+     * 供开发调试使用
+     */
+    loggerInTranscoding?: boolean;
+    /**
+     * ffmpeg 转码是否开启多线程，默认 false，确保环境支持 SharedArrayBuffer
+     */
+    multiThreading?: boolean;
+};
+
+/**
+ * @description SDK功能配置
+ */
+type SDKConfig = {
+    /**
+     * @description 页面功能配置
+     */
+    pageConfig: PageConfig;
+    /**
+     * @description 截图功能配置
+     */
+    screenShotConfig: ScreenShotConfig;
+    /**
+     * @description 导出视频功能配置
+     */
+    exportVideoConfig: VideoExportConfig;
+    /**
+     * @description 尺寸自适应功能开关
+     */
+    sizeAdaptConfig: SizeAdaptConfig;
+    /**
+     * @description 辅助面板功能配置
+     */
+    gestureHandlerConfig: {
+        enabled: boolean;
+        adsorptionGizmoEnabled: boolean;
+        adsorptionGizmoConfig: AdsorptionGizmoConfig;
+        controlGizmoEnabled: boolean;
+        controlGizmoConfig: ControlGizmoConfig;
+        preferenceGizmoEnabled: boolean;
+        preferenceGizmoConfig: PreferenceGizmoConfig;
+        selectorGizmoEnabled: boolean;
+        selectorGizmoConfig: SelectorGizmoConfig;
+        transformGizmoEnabled: boolean;
+        transformGizmoConfig: TransformGizmoConfig;
+    };
+};
+/**
+ * @description 页面功能配置
+ */
+type PageConfig = {
+    /**
+     * @description 同步修改功能开关
+     */
+    asncMode: boolean;
+    /**
+     * @description 静态预览【视图只提供播放预览功能】功能开关
+     */
+    staticPreview: boolean;
+    /**
+     * @description 静态预览视图名称
+     */
+    staticPreviewName: string;
+    /**
+     * @description 需过滤的元素名称
+     */
+    filterItemNames: string[];
+    /**
+     * @description 成组操作元素显隐
+     */
+    groupVisible: boolean;
+};
+/**
+ * @description 视频导出功能配置
+ */
+type VideoExportConfig = {
+    enabled: boolean;
+} & ExportMediaInitOptions;
+/**
+ * @description 截图功能配置
+ */
+type ScreenShotConfig = {
+    enabled: boolean;
+};
+/**
+ * @description 尺寸自适应功能配置
+ */
+type SizeAdaptConfig = {
+    enabled: boolean;
+};
+/**
+ * @description 对齐吸附功能参数
+ */
+type AdsorptionGizmoConfig = {
+    /**
+   * @description 对齐吸附线宽
+   */
+    lineWidth: number;
+    /**
+     * @description 对齐线颜色
+     */
+    lineColor: number;
+    /**
+     * @description 对齐吸附距离
+     */
+    distance: number;
+};
+/**
+ * @description 视图控制功能参数
+ */
+type ControlGizmoConfig = {
+    /**
+     * @description 缩放步长
+     */
+    zoomStep: number;
+};
+/**
+ * @description 视口展示功能参数
+ */
+type PreferenceGizmoConfig = {
+    /**
+   * @description 视口窗包围盒颜色
+   */
+    boxColor: number;
+    /**
+     * @description 视口窗包围盒宽度
+     */
+    boxWidth: number;
+    /**
+     * @description 视口区域外遮罩颜色
+     */
+    markColor: number;
+    /**
+     * @description 视口区域外遮罩透明度
+     */
+    markAlpha: number;
+    /**
+     * @description 出血区预览开关
+     */
+    safeAreaEnabled: boolean;
+    /**
+     * @description 出血区颜色
+     */
+    safeAreaBoxColor: number;
+    /**
+     * @description 出血区透明度
+     */
+    safeAreaBoxAlpha: number;
+};
+/**
+ * @description 选择功能参数
+ */
+type SelectorGizmoConfig = {
+    /**
+     * @description 预选框线宽
+     */
+    preSelectedWidth: number;
+    /**
+     * @description 预选框颜色
+     */
+    preSelectedColor: number;
+    /**
+     * @description 框选区域颜色
+     */
+    regionBoxColor: number;
+    /**
+     * @description 框选区域透明度
+     */
+    regionBoxAlpha: number;
+    /**
+     * @description 框选区域包围框颜色
+     */
+    regionWireframeColor: number;
+    /**
+     * @description 框选区域包围框透明度
+     */
+    regionWireframeAlpha: number;
+    /**
+     * @description 框选区域包围框宽度
+     */
+    regionWireframeWidth: number;
+};
+/**
+ * @description 变换功能参数
+ */
+type TransformGizmoConfig = {
+    /**
+     * @description 变换交互框颜色
+     */
+    wireframeColor: number;
+    /**
+     * @description 变换交互框透明度
+     */
+    wireframeAlpha: number;
+    /**
+     * @description 变换交互框宽度
+     */
+    wireframeWidth: number;
+    /**
+     * @description 变换交互框角点填充色
+     */
+    cornerFillColor: number;
+    /**
+     * @description 变换交互框角点线框色
+     */
+    cornerLineColor: number;
+    /**
+     * @description 变换交互框角点线框宽度
+     */
+    cornerLineWidth: number;
+    /**
+     * @description 变换交互框角点线框透明度
+     */
+    cornerLineAlpha: number;
+    /**
+     * @description 交互框缩放圆半径
+     */
+    scaleCircleSize: number;
+    /**
+     * @description 交互框旋转圆半径
+     */
+    rotationCircleSize: number;
+};
+
 type SDKEvents = {
     'selectedItemChange': [id: string[]];
     'preSelectedItemChange': [id: string | undefined];
@@ -430,26 +654,27 @@ type SDKEvents = {
     }];
     'exportProgress': [progress?: number];
     'exportComplete': [success: boolean];
+    'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
 };
 declare class SDK {
+    static config: SDKConfig;
     private _eventEmitter;
     private _pageData;
-    private _screenShotContainer;
-    private _screenShotPlayer;
-    private _SDKUtils;
-    private _ExportVideo;
+    private _screenShot;
+    private _exporter;
+    private _pageDataUtils;
+    private _sizeAdapt;
     private _gestureHandler;
-    private _playerContainer;
-    private _exportStatus;
     private disposables;
     private _isSwitchScene;
     player: Player;
-    constructor(container: HTMLElement, options?: SDKOptions);
+    private _playerContainer;
+    constructor(container: HTMLElement);
     get pageData(): PageData | undefined;
-    get exportStatus(): ExportStatus;
+    get exportStatus(): string;
     private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportComplete">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
+    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportComplete" | "sdkConfigChange">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     private getInitParam;
     private initSDK;
     run(param: SDKInputParam): Promise<void>;
@@ -471,7 +696,7 @@ declare class SDK {
      */
     getItemPropertyValue<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]>(param: GetItemPropertyValueParam<T, N>): GetItemPropertyValueResult<T, N> | undefined;
     setItemPropertyValue(param: SetItemPropertyValueParam): Promise<void>;
-    generateScreenShot(id: number, size?: [number, number], tick?: number): Promise<string>;
+    generateScreenShot(id: number, size?: [number, number], tick?: number): Promise<string | undefined>;
     /**
      * @description 切换场景
      * @param index 场景索引
@@ -481,12 +706,12 @@ declare class SDK {
      * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
      * @returns 页面的 safeAreaPreview、zoom、adsorption 值
      */
-    getConfig(): PageConfig;
+    getConfig(): PageConfig$1;
     /**
      * 设置页面的 safeAreaPreview、zoom、adsorption 值
      * @param pageProperty 设置
      */
-    setConfig(pageConfig: PageConfig): void;
+    setConfig(pageConfig: PageConfig$1): void;
     /**
      * @description 设置播放进度
      * @param progress 播放进度 0-100
@@ -500,24 +725,102 @@ declare class SDK {
      */
     getViewThumbnail(): {
         id: number;
-        thumbnail: string;
+        thumbnail: Promise<string | undefined>;
     }[];
     private destroyCompositions;
-    private onExportProgress;
-    private onExportFinish;
-    private onExportError;
     /**
-     * @description 导出视频
+     * @description 导出，支持导出媒体或其他，如MP4，未来支持 JSON 等；
      */
-    exportAllVideos(): void;
-    cancelExportAllVideos(): void;
+    onExport(): void;
+    /**
+     * @description 取消导出
+     */
+    cancelExport(): void;
     loadPageData(data: PageData): Promise<void>;
     runByPageData(data: PageData): Promise<void>;
     reloadPageDataByScene(scene: string | spec.JSONScene): Promise<void>;
-    setPageBackgroundColor(color: [number, number, number, number]): void;
     addViewParams(viewParams: ViewParam[]): Promise<void>;
     deleteViewParams(ids: number[]): void;
     setExportParam(exportParam: ExportParam, id?: number): void;
+    /**
+     * @description 设置视图缩放
+     * @param zoom 缩放值
+     */
+    setPageZoom(zoom: number): void;
+    /**
+     * @description 设置静态预览功能开关
+     * @param enabled 功能开关
+     */
+    setStaticPreviewEnabled(enabled: boolean): void;
+    /**
+     * @description 设置静态预览视图名称
+     * @param name 视图名称
+     */
+    setStaticPreviewName(name: string): void;
+    /**
+     * @description 设置同步修改功能开关
+     * @param enabled 功能开关
+     */
+    setAsyncEnabled(enabled: boolean): void;
+    /**
+     * @description 设置 成组显影 开关
+     */
+    setGroupVisibleEnabled(enabled: boolean): void;
+    /**
+     * @description 新增过滤元素名称
+     * @param itemNames 过滤元素名称
+     */
+    addFilterItemNames(itemNames: string[] | string): void;
+    /**
+     * @description 设置预览辅助层颜色
+     * @param color 色值
+     */
+    setPreferenceBackgroundColor(color: [number, number, number, number]): void;
+    /**
+     * @description 设置出血区颜色
+     * @param color 色值
+     */
+    setSafeAreaColor(color: [number, number, number, number]): void;
+    /**
+     * @description 设置 尺寸自适应拓展 功能开关
+     * @param enabled 功能开关
+     */
+    setSizeAdaptEnabled(enabled: boolean): void;
+    /**
+     * @description 设置 截图 功能开关
+     * @param enabled 功能开关
+     */
+    setScreenShotEnabled(enabled: boolean): void;
+    /**
+     * @description 设置 导出 功能开关
+     * @param enabled
+     */
+    setExportVideoEnabled(enabled: boolean): void;
+    /**
+     * @description 设置预选框参数
+     * @param preSelectedColor 预选框颜色
+     * @param preSelectedWidth 预选框线框宽度
+     */
+    setSelectorGizmoPreSelectConfig(preSelectedColor?: number, preSelectedWidth?: number): void;
+    /**
+     * @description 设置 变换控制器 交互框参数
+     * @param config 参数
+     */
+    setTranformGizmoWireframeConfig(config: {
+        wireframeColor?: number;
+        wireframeAlpha?: number;
+        wireframeWidth?: number;
+    }): void;
+    /**
+     * @description 获取 SDK 配置参数
+     * @returns SDK 配置参数
+     */
+    getSDKConfig(): SDKConfig;
+    /**
+     * @description 设置 SDK 配置参数
+     * @param config SDK 配置参数
+     */
+    setSDKConfig(config: SDKConfig): void;
 }
 
-export { type ActiveData, type BaseFormProperty, type ExportStatus, ExportStatusMap, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKOptions, type SpecificPageFormProps, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };
+export { type ActiveData, type BaseFormProperty, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKOptions, type SpecificPageFormProps, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };