@vvfx/sdk 0.0.0-alpha.4 → 0.0.0-alpha.40

package/dist/index.d.cts

@@ -1,15 +1,6 @@
-import { math, spec, Player } from '@galacean/effects';
+import * as _galacean_effects from '@galacean/effects';
+import { spec, Player } from '@galacean/effects';
 export { spec } from '@galacean/effects';
-import * as _galacean_effects_weapp from '@galacean/effects/weapp';
-
-declare class Vector2 extends math.Vector2 {
-    subtract(other: Vector2): this;
-    toViewCoordinate(width: number, height: number): this;
-    clone(): Vector2;
-    distanceTo(other: Vector2): number;
-    scaleByCenter(scalar: Vector2, anchor?: Vector2): Vector2;
-    round(precision?: number): this;
-}
 
 type ViewItemTypedProperty = {
     [K in keyof PageFormTypeAndPropertyReference]: {
@@ -55,10 +46,597 @@ type SetItemPropertyValueParam = {
     }[keyof PageFormTypeAndPropertyReference[T]];
 }[keyof PageFormTypeAndPropertyReference];
 
+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";
+};
+/**
+ * GIF 压缩参数
+ * 核心通过参数 flags + palettegen + paletteuse 实现
+ * highest: lanczos + max_colors=256 + dither=bayer
+ * high: bicubic + max_colors=200 + dither=bayer
+ * medium: bilinear + max_colors=64 + dither=bayer
+ * low: neighbor + max_colors=32 + dither=none
+ */
+declare const GIF_QUALITY_TO_FFMPEG_ARGS: {
+    highest: string;
+    high: string;
+    medium: string;
+    low: string;
+};
+
+declare global {
+    interface Window {
+        /**
+         * @description 创建 WebP Core 实例
+         */
+        createWebPCore: (config: any) => Promise<Img2WebPCore>;
+    }
+}
+type FileBuffer = ArrayBuffer | Uint8Array;
+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;
+    /**
+     * 是否输出 buffer，默认 false
+     */
+    isOutputBuffer?: boolean;
+};
+type GifConfig = {
+    /**
+     * @description GIF 导出时的帧率
+     */
+    fps?: number;
+    /**
+     * @description GIF 导出时的缩放比例
+     * 默认 '-1:-1'， 表示不缩放
+     * 例如 '100:-1'， 表示宽度 100，高度自动
+     * 例如 '-1:100'， 表示宽度自动，高度 100
+     */
+    scale?: string;
+    /**
+     * @description GIF 导出时的质量
+     * 默认 'highest'
+     * 可选 'highest', 'high', 'medium', 'low'
+     */
+    quality?: keyof typeof GIF_QUALITY_TO_FFMPEG_ARGS;
+};
+type ApngConfig = {
+    /**
+     * @description APNG 导出时的帧率
+     */
+    fps?: number;
+    /**
+     * @description APNG 导出时的缩放比例
+     * 默认 '-1:-1'， 表示不缩放
+     * 例如 '100:-1'， 表示宽度 100，高度自动
+     * 例如 '-1:100'， 表示宽度自动，高度 100
+     */
+    scale?: string;
+    /**
+     * @description APNG 导出时的质量
+     * 默认 'highest'
+     * 可选 'highest', 'high', 'medium', 'low'
+     */
+    quality?: keyof typeof GIF_QUALITY_TO_FFMPEG_ARGS;
+};
+type ExportMediaItemOptions = {
+    /**
+     * 尺寸
+     */
+    size: [number, number];
+    /**
+     * 动效资源
+     */
+    scene: spec.JSONScene;
+    /**
+     * 视频时长，目前仅在导出 MP4 / AlphaMaskVideo 时有效，默认取动效资源时长
+     */
+    time?: number;
+    /**
+     * 是否生成音轨，默认 false，仅在导出 MP4 时有效
+     */
+    audioEnable?: boolean;
+    /**
+     * 帧率， 默认 30
+     */
+    fps?: number;
+    /**
+     * 是否循环，默认 true
+     */
+    loop?: boolean;
+    /**
+     * 视频背景颜色，默认 #000000
+     */
+    backgroundColor?: string;
+    /**
+     * 导出 GIF 时，设置的导出配置
+     */
+    gifConfig?: GifConfig;
+    apngConfig?: ApngConfig;
+};
+
+type SDKMode = 'product' | 'template';
+/**
+ * @description SDK功能配置
+ */
+type SDKConfig = {
+    /**
+     * @description SDK编辑模式 - 模板编辑 | 产物编辑
+     */
+    mode: SDKMode;
+    /**
+     * @description 页面功能配置
+     */
+    pageConfig: PageConfig$1;
+    /**
+     * @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$1 = {
+    /**
+     * @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];
+    'selectedViewChange': [id: number];
+    'pageDataChange': [pageData: PageData];
+    'zoomChange': [zoom: number];
+    'progress': [{
+        duration: number;
+        time: number;
+        end: boolean;
+        paused: boolean;
+    }];
+    'itemPropertyChange': [{
+        id: string;
+        property: string;
+    }];
+    'exportProgress': [progress?: number];
+    'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
+    'exportComplete': [success: boolean, taskInfos: ExportMediaItemOptions[], buffers?: FileBuffer[]];
+    'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
+};
+declare class SDK {
+    static config: SDKConfig;
+    private _eventEmitter;
+    private _pageData;
+    private _screenShot;
+    private _exporter?;
+    private _pageDataUtils;
+    private _sizeAdapt;
+    private _gestureHandler;
+    private disposables;
+    private _isSwitchScene;
+    player: Player;
+    _container: HTMLElement;
+    private _playerContainer;
+    constructor(container: HTMLElement);
+    get pageData(): PageData | undefined;
+    get exportStatus(): string | undefined;
+    private get exportOptions();
+    dispose(): void;
+    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
+    private getInitParam;
+    private initExporter;
+    private initSDK;
+    run(param: SDKInputParam): Promise<void>;
+    getPageData(): PageData;
+    getActiveItems(): string[];
+    setPreSelectedItem(id: string): void;
+    getPreSelectedItem(): string;
+    setSelectedItems(itemIds: string[]): void;
+    /**
+     * @description 获取目标元素的所有属性
+     * @param param 元素ID、类型
+     * @returns 元素属性
+     */
+    getItemProperty<T extends keyof PageFormTypeAndPropertyReference>(param: GetItemPropertyParam<T>): GetItemPropertyResult<T> | undefined;
+    /**
+     * @description 获取目标元素的指定属性
+     * @param param 元素ID、类型、属性名
+     * @returns 元素属性值
+     */
+    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, backgroundColor?: spec.vec4): Promise<string | undefined>;
+    /**
+     * @description 切换场景
+     * @param index 场景索引
+     */
+    switchScene(index: number): Promise<void>;
+    /**
+     * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
+     * @returns 页面的 safeAreaPreview、zoom、adsorption 值
+     */
+    getPageConfig(): PageConfig;
+    /**
+     * 设置页面的 safeAreaPreview、zoom、adsorption 值
+     * @param pageProperty 设置
+     */
+    setPageConfig(pageConfig: PageConfig): void;
+    /**
+     * @description 设置播放进度
+     * @param progress 播放进度 0-100
+     */
+    setPlayProgress(progress: number): Promise<void>;
+    getViewItems(): ViewItem[];
+    setPlayState(playState: 'play' | 'pause'): Promise<void>;
+    /**
+     * @description 获取场景预览图
+     * @returns 视图预览图
+     */
+    getViewThumbnail(): {
+        id: number;
+        thumbnail: Promise<string | undefined>;
+    }[];
+    /**
+     * @description 获取视图JSON产物
+     * @returns 当前所有视图JSON产物
+     */
+    getViewScene(): {
+        id: number;
+        thumbnail: spec.JSONScene;
+    }[];
+    private destroyCompositions;
+    /**
+     * @description 导出，支持导出媒体或其他，如MP4，未来支持 JSON 等；
+     */
+    onExport(): void;
+    /**
+     * @description 取消导出
+     */
+    cancelExport(): void;
+    loadPageData(data: PageData): Promise<void>;
+    runByPageData(data: PageData): Promise<void>;
+    reloadPageDataByScene(scene: string | spec.JSONScene): Promise<void>;
+    addViewParams(viewParams: ViewParam[]): Promise<void>;
+    deleteViewParams(ids: number[]): Promise<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;
+    /**
+     * @description 设置SDK背景
+     * @param type 背景类型
+     * @param value 值
+     */
+    setSDKBackground(type: SDKBackgroundType, value?: string): void;
+    /**
+     * @description 创建图层元素
+     * @param spriteInfo 图层元素信息
+     */
+    addSpriteItem(spriteInfo: SpriteCreateInfo): Promise<void>;
+}
+
+type SizeAdaptDirection = 'x' | 'y';
+
 type BaseFormProperty = {
     position: [number, number, number];
     rotation: [number, number, number];
-    scale: [number, number, number];
+    size: [number, number];
+    visible: boolean;
     keyPropertyEditing: boolean;
 };
 type SpriteFormProperty = BaseFormProperty & {
@@ -102,26 +680,37 @@ type SpecificPageFormProps<T extends keyof PageFormTypeAndPropertyReference> = {
     property: PageFormTypeAndPropertyReference[T];
     onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[T]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[T][N]) => void;
 };
+type SDKOptions = {
+    /** 导出视频时，是否开启转码日志 */
+    loggerInExportVideoTranscoding?: boolean;
+};
+type SDKInputParam = SDKTemplateInputParam | SDKEditorInputParam;
 /**
  * @description SDK入参
  */
-type SDKInputParam = {
+type SDKTemplateInputParam = {
     /**
      * @description JSON地址
      */
-    scene: string;
+    scene: string | spec.JSONScene;
+    /**
+     * @description SDK模式 - 模板编辑模式
+     */
+    mode: 'template';
     /**
      * @description 视图参数
      */
-    viewParams: ViewParam[];
+    viewParams?: ViewParam[];
     /**
      * @description 页面属性
      */
     options: PageOptions;
+};
+type SDKEditorInputParam = {
     /**
-     * @description 是否开启出血区强制变换
+     * @description SDK模式 - 编辑器模式
      */
-    keepSafe: boolean;
+    mode: 'editor';
 };
 /**
  * @description 页面属性
@@ -144,6 +733,10 @@ type PageOptions = {
  * @description 页面数据
  */
 type PageData = {
+    /**
+     * @description 基础场景数据
+     */
+    scene: spec.JSONScene;
     /**
      * @description 页面属性
      */
@@ -185,6 +778,10 @@ type PageConfig = {
      * @description 吸附开关
      */
     adsorption: boolean;
+    /**
+     * @description 同步开关
+     */
+    asyncMode: boolean;
 };
 /**
  * @description 页面属性
@@ -201,7 +798,7 @@ type PageProperty = {
     /**
      * @description 偏移值
      */
-    translation: Vector2;
+    translation: [number, number];
     /**
      * @description 吸附开关
      */
@@ -209,7 +806,7 @@ type PageProperty = {
     /**
      * @description 同步开关
      */
-    sync: boolean;
+    asyncMode: boolean;
 };
 /**
  * @description 视图创建参数
@@ -218,50 +815,37 @@ type ViewParam = {
     /**
      * @description 页面尺寸
      */
-    size: [number, number];
+    size?: [number, number];
     /**
      * @description 出血区参数
      */
-    safeArea: SafeAreaParam;
+    safeArea?: [number, number, number, number];
     /**
-     * @description 导出参数
+     * @description 自适应方向 - 默认根据视图宽高决定
      */
-    export: ExportParam;
-};
-/**
- * @description 安全区数据
- */
-type SafeAreaParam = {
+    adaptionDirection?: SizeAdaptDirection;
     /**
-     * @description 出血区大小 - [上, 下, 左, 右]
+     * @description 自定义出血区 - 用于展示
      */
-    size: [number, number, number, number];
+    previewSafeAreas?: PreviewSafeAreaParam[];
     /**
-     * @description 元素名称关键字
+     * @description 导出参数
      */
-    keyWords: string[];
+    export: ExportParam;
 };
 /**
  * @description 导出参数
  */
 type ExportParam = {
-    /**
-     * @description 导出视频时长
-     */
-    time: number;
-    /**
-     * @description 导出大小上限 - 单位kb
-     */
-    fileSizeLimit: number;
-    /**
-     * @description 是否开启音轨
-     */
-    audioEnable: boolean;
     /**
      * @description 导出视频类型 - 预留参数
      */
     type?: string;
-};
+    /**
+     * @description 视频名称
+     */
+    name?: string;
+} & Omit<ExportMediaItemOptions, 'scene' | 'size'>;
 /**
  * @description 视图属性
  */
@@ -277,19 +861,36 @@ type ViewProperty = {
     /**
      * @description 出血区数据
      */
-    safeArea: SafeAreaParam;
+    safeArea: [number, number, number, number];
     /**
-     * @description 视图场景数据
+     * @description 自定义出血区数据
      */
-    scene: spec.JSONScene;
+    previewSafeAreas: PreviewSafeAreaParam[];
     /**
-     * @description 预览图数据
+     * @description 视图场景数据
      */
-    thumbnail: string;
+    scene: spec.JSONScene;
     /**
      * @description 导出参数
      */
     export: ExportParam;
+    /**
+     * @description 忽略交互 - 仅供展示
+     */
+    ignoreInteraction: boolean;
+};
+/**
+ * @description 自定义出血区数据
+ */
+type PreviewSafeAreaParam = {
+    /**
+     * @description 出血区包围盒 [left top width height]
+     */
+    box: [number, number, number, number];
+    /**
+     * @description 出血区色块颜色 默认为 [255, 255, 255, 0.3]
+     */
+    color?: [number, number, number, number];
 };
 /**
  * @description 页面活跃数据
@@ -341,107 +942,39 @@ type ViewItem = {
      */
     endBehavior: spec.EndBehavior;
 } & ViewItemTypedProperty;
-
-declare const ExportStatusMap: {
-    readonly DEFAULT: "default";
-    readonly EXPORTING: "exporting";
-    readonly SUCCESS: "success";
-    readonly ERROR: "error";
-};
-type ExportStatus = typeof ExportStatusMap[keyof typeof ExportStatusMap];
-type SDKEvents = {
-    'selectedItemChange': [id: string[]];
-    'preSelectedItemChange': [id: string | undefined];
-    'pageDataChange': [pageData: PageData];
-    'zoomChange': [zoom: number];
-    'progress': [{
-        duration: number;
-        time: number;
-        end: boolean;
-        paused: boolean;
-    }];
-    'exportingChange': [status: ExportStatus, progress?: number];
-    'itemPropertyChange': [{
-        id: string;
-        property: string;
-    }];
-};
-declare class SDK {
-    private _eventEmitter;
-    private _pageData;
-    private _screenShotContainer;
-    private _screenShotPlayer;
-    private _SDKUtils;
-    private _ExportVideo;
-    private _gestureHandler;
-    private _playerContainer;
-    private _isExportReady;
-    private _exportStatus;
-    player: Player;
-    constructor(container: HTMLElement);
-    get pageData(): PageData | undefined;
-    get exportStatus(): ExportStatus;
-    private get exportVideoCanceled();
-    dispose(): void;
-    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "pageDataChange" | "zoomChange" | "exportingChange" | "itemPropertyChange">(eventName: E, listener: _galacean_effects_weapp.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects_weapp.EventEmitterOptions) => () => void;
-    private getInitParam;
-    private initSDK;
-    run(param: SDKInputParam): Promise<void>;
-    getPageData(): PageData;
-    getActiveItems(): string[];
-    setPreSelectedItem(id: string): void;
-    getPreSelectedItem(): string;
-    setSelectedItems(itemIds: string[]): void;
-    /**
-     * @description 获取目标元素的所有属性
-     * @param param 元素ID、类型
-     * @returns 元素属性
-     */
-    getItemProperty<T extends keyof PageFormTypeAndPropertyReference>(param: GetItemPropertyParam<T>): GetItemPropertyResult<T> | undefined;
+type SDKBackgroundType = 'color' | 'image' | 'chess-board';
+/**
+ * @description 图层创建信息
+ */
+type SpriteCreateInfo = {
     /**
-     * @description 获取目标元素的指定属性
-     * @param param 元素ID、类型、属性名
-     * @returns 元素属性值
+     * @description 图层名称
      */
-    getItemPropertyValue<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]>(param: GetItemPropertyValueParam<T, N>): GetItemPropertyValueResult<T, N> | undefined;
-    setItemPropertyValue(param: SetItemPropertyValueParam): void;
-    generateScreenShot(id: number): Promise<string>;
+    name?: string;
     /**
-     * @description 切换场景
-     * @param index 场景索引
+     * @description 元素id
      */
-    switchScene(index: number): Promise<void>;
+    id?: string;
     /**
-     * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
-     * @returns 页面的 safeAreaPreview、zoom、adsorption 值
+     * @description 图片资源地址
      */
-    getConfig(): PageConfig;
+    url: string;
     /**
-     * 设置页面的 safeAreaPreview、zoom、adsorption 值
-     * @param pageProperty 设置
+     * @description 图层元素像素大小
      */
-    setConfig(pageConfig: PageConfig): void;
+    size: spec.vec2;
     /**
-     * @description 设置播放进度
-     * @param progress 播放进度 0-100
+     * @description 图层元素缩放
      */
-    setPlayProgress(progress: number): void;
-    getViewItems(): ViewItem[];
-    setPlayState(playState: 'play' | 'pause'): void;
+    scale?: spec.vec2;
     /**
-     * @description 获取场景预览图
-     * @returns 视图预览图
+     * @description 图层元素旋转
      */
-    getViewThumbnail(): {
-        id: number;
-        thumbnail: string;
-    }[];
+    rotation?: number;
     /**
-     * @description 导出所有视频
-     * @returns 导出视频的 ArrayBuffer 数组
+     * @description 图层元素二维位置
      */
-    exportAllVideos(): Promise<void>;
-    cancelExportAllVideos(): void;
-}
+    position: spec.vec2;
+};
 
-export { type ActiveData, type BaseFormProperty, type ExportStatus, ExportStatusMap, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, 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 };