@vvfx/sdk 0.0.0-alpha.27 → 0.0.0-alpha.29

package/dist/index.d.ts

@@ -46,782 +46,828 @@ type SetItemPropertyValueParam = {
     }[keyof PageFormTypeAndPropertyReference[T]];
 }[keyof PageFormTypeAndPropertyReference];
 
-type BaseFormProperty = {
-    position: [number, number, number];
-    rotation: [number, number, number];
-    size: [number, number];
-    visible: boolean;
-    keyPropertyEditing: boolean;
-};
-type SpriteFormProperty = BaseFormProperty & {
-    image: string;
-};
-type TextFormProperty = BaseFormProperty & {
-    font: string;
-    color: [number, number, number, number];
-    weight: spec.TextWeight;
-    text: string;
-    alignment: spec.TextAlignment;
-};
-/**
- * @description 页面表单类型和属性引用
- */
-type PageFormTypeAndPropertyReference = {
-    [spec.ItemType.base]: BaseFormProperty;
-    [spec.ItemType.sprite]: SpriteFormProperty;
-    [spec.ItemType.particle]: BaseFormProperty;
-    [spec.ItemType.null]: BaseFormProperty;
-    [spec.ItemType.interact]: BaseFormProperty;
-    [spec.ItemType.plugin]: BaseFormProperty;
-    [spec.ItemType.camera]: BaseFormProperty;
-    [spec.ItemType.composition]: BaseFormProperty;
-    [spec.ItemType.spine]: BaseFormProperty;
-    [spec.ItemType.mesh]: BaseFormProperty;
-    [spec.ItemType.tree]: BaseFormProperty;
-    [spec.ItemType.text]: TextFormProperty;
-    [spec.ItemType.light]: BaseFormProperty;
-    [spec.ItemType.skybox]: BaseFormProperty;
-    [spec.ItemType.effect]: BaseFormProperty;
-    [spec.ItemType.shape]: BaseFormProperty;
-    [spec.ItemType.postProcessVolume]: BaseFormProperty;
-    [spec.ItemType.node]: BaseFormProperty;
-    [spec.ItemType.video]: BaseFormProperty;
-    [spec.ItemType.audio]: BaseFormProperty;
-    [spec.ItemType.richtext]: TextFormProperty;
+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";
 };
-type SpecificPageFormProps<T extends keyof PageFormTypeAndPropertyReference> = {
-    type: T;
-    property: PageFormTypeAndPropertyReference[T];
-    onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[T]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[T][N]) => void;
+
+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 SDKOptions = {
-    /** 导出视频时，是否开启转码日志 */
-    loggerInExportVideoTranscoding?: boolean;
+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;
 };
-/**
- * @description SDK入参
- */
-type SDKInputParam = {
-    /**
-     * @description JSON地址
-     */
-    scene: string | spec.JSONScene;
-    /**
-     * @description 视图参数
-     */
-    viewParams: ViewParam[];
+type ExportMediaInitOptions = {
     /**
-     * @description 页面属性
+     * 导出类型
      */
-    options: PageOptions;
-};
-/**
- * @description 页面属性
- */
-type PageOptions = {
+    mediaType: MediaType;
     /**
-     * @description 同步模式开关
+     * 额外画布，导出透明视频时使用
      */
-    asyncMode: boolean;
+    extraCanvas?: HTMLCanvasElement | null;
     /**
-     * @description 安全区展示开关
+     * 是否打印转码过程中的日志，仅在导出 MP4/AlphaMaskVideo 时有效， 默认 false
+     * 供开发调试使用
      */
-    safeAreaPreview: boolean;
+    loggerInTranscoding?: boolean;
     /**
-     * @description 吸附开关
+     * ffmpeg 转码是否开启多线程，默认 false，确保环境支持 SharedArrayBuffer
      */
-    adsorption: boolean;
+    multiThreading?: boolean;
 };
-/**
- * @description 页面数据
- */
-type PageData = {
+type ExportMediaItemOptions = {
     /**
-     * @description 基础场景数据
+     * 尺寸
      */
-    scene: spec.JSONScene;
+    size: [number, number];
     /**
-     * @description 页面属性
+     * 动效资源
      */
-    property: PageProperty;
+    scene: spec.JSONScene;
     /**
-     * @description 视图属性
+     * 视频时长，目前仅在导出 MP4 / AlphaMaskVideo 时有效，默认取动效资源时长
      */
-    viewProperties: ViewProperty[];
+    time?: number;
     /**
-     * @description 活跃数据
+     * 是否生成音轨，默认 false，仅在导出 MP4 时有效
      */
-    activeData: ActiveData;
+    audioEnable?: boolean;
     /**
-     * @description 元素数据
+     * 帧率， 默认 30
      */
-    items: ViewItem[];
+    fps?: number;
     /**
-     * @description 视图当前时间
+     * 是否循环，默认 true
      */
-    time: number;
+    loop?: boolean;
     /**
-     * @description 是否处于播放态
+     * 视频背景颜色，默认 #000000
      */
-    playing: boolean;
+    backgroundColor?: string;
 };
+
 /**
- * @description 页面配置
+ * @description SDK功能配置
  */
-type PageConfig$1 = {
+type SDKConfig = {
     /**
-     * @description 出血区域展示开关
+     * @description 页面功能配置
      */
-    safeAreaPreview: boolean;
+    pageConfig: PageConfig$1;
     /**
-     * @description 缩放值
+     * @description 截图功能配置
      */
-    zoom: number;
+    screenShotConfig: ScreenShotConfig;
     /**
-     * @description 吸附开关
+     * @description 导出视频功能配置
      */
-    adsorption: boolean;
+    exportVideoConfig: VideoExportConfig;
     /**
-     * @description 同步开关
+     * @description 尺寸自适应功能开关
      */
-    asyncMode: boolean;
+    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 页面属性
+ * @description 页面功能配置
  */
-type PageProperty = {
+type PageConfig$1 = {
     /**
-     * @description 出血区域展示开关
+     * @description 同步修改功能开关
      */
-    safeAreaPreview: boolean;
+    asncMode: boolean;
     /**
-     * @description 缩放值
+     * @description 静态预览【视图只提供播放预览功能】功能开关
      */
-    zoom: number;
+    staticPreview: boolean;
     /**
-     * @description 偏移值
+     * @description 静态预览视图名称
      */
-    translation: [number, number];
+    staticPreviewName: string;
     /**
-     * @description 吸附开关
+     * @description 需过滤的元素名称
      */
-    adsorption: boolean;
+    filterItemNames: string[];
     /**
-     * @description 同步开关
+     * @description 成组操作元素显隐
      */
-    asyncMode: boolean;
+    groupVisible: boolean;
 };
 /**
- * @description 视图创建参数
+ * @description 视频导出功能配置
  */
-type ViewParam = {
+type VideoExportConfig = {
+    enabled: boolean;
+} & ExportMediaInitOptions;
+/**
+ * @description 截图功能配置
+ */
+type ScreenShotConfig = {
+    enabled: boolean;
+};
+/**
+ * @description 尺寸自适应功能配置
+ */
+type SizeAdaptConfig = {
+    enabled: boolean;
+};
+/**
+ * @description 对齐吸附功能参数
+ */
+type AdsorptionGizmoConfig = {
     /**
-     * @description 页面尺寸
-     */
-    size: [number, number];
+   * @description 对齐吸附线宽
+   */
+    lineWidth: number;
     /**
-     * @description 出血区参数
+     * @description 对齐线颜色
      */
-    safeArea?: [number, number, number, number];
+    lineColor: number;
     /**
-     * @description 自定义出血区 - 用于展示
+     * @description 对齐吸附距离
      */
-    previewSafeAreas?: PreviewSafeAreaParam[];
+    distance: number;
+};
+/**
+ * @description 视图控制功能参数
+ */
+type ControlGizmoConfig = {
     /**
-     * @description 导出参数
+     * @description 缩放步长
      */
-    export: ExportParam;
+    zoomStep: number;
 };
 /**
- * @description 导出参数
+ * @description 视口展示功能参数
  */
-type ExportParam = {
+type PreferenceGizmoConfig = {
     /**
-     * @description 导出视频时长
+   * @description 视口窗包围盒颜色
+   */
+    boxColor: number;
+    /**
+     * @description 视口窗包围盒宽度
      */
-    time?: number;
+    boxWidth: number;
     /**
-     * @description 导出大小上限 - 单位kb
+     * @description 视口区域外遮罩颜色
      */
-    fileSizeLimit: number;
+    markColor: number;
     /**
-     * @description 是否开启音轨
+     * @description 视口区域外遮罩透明度
      */
-    audioEnable: boolean;
+    markAlpha: number;
     /**
-     * @description 视频fps - 默认 30
+     * @description 出血区预览开关
      */
-    fps?: number;
+    safeAreaEnabled: boolean;
     /**
-     * @description 导出视频类型 - 预留参数
+     * @description 出血区颜色
      */
-    type?: string;
+    safeAreaBoxColor: number;
     /**
-     * @description 视频名称
+     * @description 出血区透明度
      */
-    name?: string;
+    safeAreaBoxAlpha: number;
 };
 /**
- * @description 视图属性
+ * @description 选择功能参数
  */
-type ViewProperty = {
+type SelectorGizmoConfig = {
     /**
-     * @description 视图ID
+     * @description 预选框线宽
      */
-    id: number;
+    preSelectedWidth: number;
     /**
-     * @description 视图宽高
+     * @description 预选框颜色
      */
-    size: [number, number];
+    preSelectedColor: number;
     /**
-     * @description 出血区数据
+     * @description 框选区域颜色
      */
-    safeArea: [number, number, number, number];
+    regionBoxColor: number;
     /**
-     * @description 自定义出血区数据
+     * @description 框选区域透明度
      */
-    previewSafeAreas: PreviewSafeAreaParam[];
+    regionBoxAlpha: number;
     /**
-     * @description 视图场景数据
+     * @description 框选区域包围框颜色
      */
-    scene: spec.JSONScene;
+    regionWireframeColor: number;
     /**
-     * @description 导出参数
+     * @description 框选区域包围框透明度
      */
-    export: ExportParam;
+    regionWireframeAlpha: number;
     /**
-     * @description 忽略交互 - 仅供展示
+     * @description 框选区域包围框宽度
      */
-    ignoreInteraction: boolean;
+    regionWireframeWidth: number;
 };
 /**
- * @description 自定义出血区数据
+ * @description 变换功能参数
  */
-type PreviewSafeAreaParam = {
+type TransformGizmoConfig = {
     /**
-     * @description 出血区包围盒 [left top width height]
+     * @description 变换交互框颜色
      */
-    box: [number, number, number, number];
+    wireframeColor: number;
     /**
-     * @description 出血区色块颜色 默认为 [255, 255, 255, 0.3]
+     * @description 变换交互框透明度
      */
-    color?: [number, number, number, number];
-};
-/**
- * @description 页面活跃数据
- */
-type ActiveData = {
+    wireframeAlpha: number;
     /**
-     * @description 视图ID
+     * @description 变换交互框宽度
      */
-    view?: number;
+    wireframeWidth: number;
     /**
-     * @description 选中元素
+     * @description 变换交互框角点填充色
      */
-    selectedItems: string[];
+    cornerFillColor: number;
     /**
-     * @description 预选中元素
+     * @description 变换交互框角点线框色
      */
-    preSelectedItem?: string;
+    cornerLineColor: number;
+    /**
+     * @description 变换交互框角点线框宽度
+     */
+    cornerLineWidth: number;
+    /**
+     * @description 变换交互框角点线框透明度
+     */
+    cornerLineAlpha: number;
+    /**
+     * @description 交互框缩放圆半径
+     */
+    scaleCircleSize: number;
+    /**
+     * @description 交互框旋转圆半径
+     */
+    rotationCircleSize: number;
 };
-/**
- * @description 视图元素
- */
-type ViewItem = {
+
+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];
+    '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;
+    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 元素ID
+     * @description 获取目标元素的所有属性
+     * @param param 元素ID、类型
+     * @returns 元素属性
      */
-    id: string;
+    getItemProperty<T extends keyof PageFormTypeAndPropertyReference>(param: GetItemPropertyParam<T>): GetItemPropertyResult<T> | undefined;
     /**
-     * @description 元素名称
+     * @description 获取目标元素的指定属性
+     * @param param 元素ID、类型、属性名
+     * @returns 元素属性值
      */
-    name: string;
+    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 | undefined>;
     /**
-     * @description 元素父节点ID
+     * @description 切换场景
+     * @param index 场景索引
      */
-    parentId?: string;
+    switchScene(index: number): Promise<void>;
     /**
-     * @description 子元素
+     * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
+     * @returns 页面的 safeAreaPreview、zoom、adsorption 值
      */
-    children: string[];
+    getConfig(): PageConfig;
     /**
-     * @description 元素生命周期
+     * 设置页面的 safeAreaPreview、zoom、adsorption 值
+     * @param pageProperty 设置
      */
-    duration: number;
+    setConfig(pageConfig: PageConfig): void;
     /**
-     * @description 元素生命周期延时
+     * @description 设置播放进度
+     * @param progress 播放进度 0-100
      */
-    delay: number;
+    setPlayProgress(progress: number): Promise<void>;
+    getViewItems(): ViewItem[];
+    setPlayState(playState: 'play' | 'pause'): Promise<void>;
     /**
-     * @description 元素结束行为
+     * @description 获取场景预览图
+     * @returns 视图预览图
      */
-    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 = {
+    getViewThumbnail(): {
+        id: number;
+        thumbnail: Promise<string | undefined>;
+    }[];
     /**
-     * 导出类型
+     * @description 获取视图JSON产物
+     * @returns 当前所有视图JSON产物
      */
-    mediaType: MediaType;
+    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 视图名称
      */
-    extraCanvas?: HTMLCanvasElement | null;
+    setStaticPreviewName(name: string): void;
     /**
-     * 是否打印转码过程中的日志，仅在导出 MP4/AlphaMaskVideo 时有效， 默认 false
-     * 供开发调试使用
+     * @description 设置同步修改功能开关
+     * @param enabled 功能开关
      */
-    loggerInTranscoding?: boolean;
+    setAsyncEnabled(enabled: boolean): void;
     /**
-     * ffmpeg 转码是否开启多线程，默认 false，确保环境支持 SharedArrayBuffer
+     * @description 设置 成组显影 开关
      */
-    multiThreading?: boolean;
-};
-
-/**
- * @description SDK功能配置
- */
-type SDKConfig = {
+    setGroupVisibleEnabled(enabled: boolean): void;
     /**
-     * @description 页面功能配置
+     * @description 新增过滤元素名称
+     * @param itemNames 过滤元素名称
      */
-    pageConfig: PageConfig;
+    addFilterItemNames(itemNames: string[] | string): void;
     /**
-     * @description 截图功能配置
+     * @description 设置预览辅助层颜色
+     * @param color 色值
      */
-    screenShotConfig: ScreenShotConfig;
+    setPreferenceBackgroundColor(color: [number, number, number, number]): void;
     /**
-     * @description 导出视频功能配置
+     * @description 设置出血区颜色
+     * @param color 色值
      */
-    exportVideoConfig: VideoExportConfig;
+    setSafeAreaColor(color: [number, number, number, number]): void;
     /**
-     * @description 尺寸自适应功能开关
+     * @description 设置 尺寸自适应拓展 功能开关
+     * @param enabled 功能开关
      */
-    sizeAdaptConfig: SizeAdaptConfig;
+    setSizeAdaptEnabled(enabled: boolean): void;
     /**
-     * @description 辅助面板功能配置
+     * @description 设置 截图 功能开关
+     * @param enabled 功能开关
      */
-    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 = {
+    setScreenShotEnabled(enabled: boolean): void;
     /**
-     * @description 同步修改功能开关
+     * @description 设置 导出 功能开关
+     * @param enabled
      */
-    asncMode: boolean;
+    setExportVideoEnabled(enabled: boolean): void;
     /**
-     * @description 静态预览【视图只提供播放预览功能】功能开关
+     * @description 设置预选框参数
+     * @param preSelectedColor 预选框颜色
+     * @param preSelectedWidth 预选框线框宽度
      */
-    staticPreview: boolean;
+    setSelectorGizmoPreSelectConfig(preSelectedColor?: number, preSelectedWidth?: number): void;
     /**
-     * @description 静态预览视图名称
+     * @description 设置 变换控制器 交互框参数
+     * @param config 参数
      */
-    staticPreviewName: string;
+    setTranformGizmoWireframeConfig(config: {
+        wireframeColor?: number;
+        wireframeAlpha?: number;
+        wireframeWidth?: number;
+    }): void;
     /**
-     * @description 需过滤的元素名称
+     * @description 获取 SDK 配置参数
+     * @returns SDK 配置参数
      */
-    filterItemNames: string[];
+    getSDKConfig(): SDKConfig;
     /**
-     * @description 成组操作元素显隐
+     * @description 设置 SDK 配置参数
+     * @param config SDK 配置参数
      */
-    groupVisible: boolean;
+    setSDKConfig(config: SDKConfig): void;
+}
+
+type SizeAdaptDirection = 'x' | 'y';
+
+type BaseFormProperty = {
+    position: [number, number, number];
+    rotation: [number, number, number];
+    size: [number, number];
+    visible: boolean;
+    keyPropertyEditing: boolean;
 };
-/**
- * @description 视频导出功能配置
- */
-type VideoExportConfig = {
-    enabled: boolean;
-} & ExportMediaInitOptions;
-/**
- * @description 截图功能配置
- */
-type ScreenShotConfig = {
-    enabled: boolean;
+type SpriteFormProperty = BaseFormProperty & {
+    image: string;
+};
+type TextFormProperty = BaseFormProperty & {
+    font: string;
+    color: [number, number, number, number];
+    weight: spec.TextWeight;
+    text: string;
+    alignment: spec.TextAlignment;
 };
 /**
- * @description 尺寸自适应功能配置
+ * @description 页面表单类型和属性引用
  */
-type SizeAdaptConfig = {
-    enabled: boolean;
+type PageFormTypeAndPropertyReference = {
+    [spec.ItemType.base]: BaseFormProperty;
+    [spec.ItemType.sprite]: SpriteFormProperty;
+    [spec.ItemType.particle]: BaseFormProperty;
+    [spec.ItemType.null]: BaseFormProperty;
+    [spec.ItemType.interact]: BaseFormProperty;
+    [spec.ItemType.plugin]: BaseFormProperty;
+    [spec.ItemType.camera]: BaseFormProperty;
+    [spec.ItemType.composition]: BaseFormProperty;
+    [spec.ItemType.spine]: BaseFormProperty;
+    [spec.ItemType.mesh]: BaseFormProperty;
+    [spec.ItemType.tree]: BaseFormProperty;
+    [spec.ItemType.text]: TextFormProperty;
+    [spec.ItemType.light]: BaseFormProperty;
+    [spec.ItemType.skybox]: BaseFormProperty;
+    [spec.ItemType.effect]: BaseFormProperty;
+    [spec.ItemType.shape]: BaseFormProperty;
+    [spec.ItemType.postProcessVolume]: BaseFormProperty;
+    [spec.ItemType.node]: BaseFormProperty;
+    [spec.ItemType.video]: BaseFormProperty;
+    [spec.ItemType.audio]: BaseFormProperty;
+    [spec.ItemType.richtext]: TextFormProperty;
+};
+type SpecificPageFormProps<T extends keyof PageFormTypeAndPropertyReference> = {
+    type: T;
+    property: PageFormTypeAndPropertyReference[T];
+    onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[T]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[T][N]) => void;
+};
+type SDKOptions = {
+    /** 导出视频时，是否开启转码日志 */
+    loggerInExportVideoTranscoding?: boolean;
 };
 /**
- * @description 对齐吸附功能参数
+ * @description SDK入参
  */
-type AdsorptionGizmoConfig = {
+type SDKInputParam = {
     /**
-   * @description 对齐吸附线宽
-   */
-    lineWidth: number;
+     * @description JSON地址
+     */
+    scene: string | spec.JSONScene;
     /**
-     * @description 对齐线颜色
+     * @description 视图参数
      */
-    lineColor: number;
+    viewParams: ViewParam[];
     /**
-     * @description 对齐吸附距离
+     * @description 页面属性
      */
-    distance: number;
+    options: PageOptions;
 };
 /**
- * @description 视图控制功能参数
+ * @description 页面属性
  */
-type ControlGizmoConfig = {
+type PageOptions = {
     /**
-     * @description 缩放步长
+     * @description 同步模式开关
      */
-    zoomStep: number;
+    asyncMode: boolean;
+    /**
+     * @description 安全区展示开关
+     */
+    safeAreaPreview: boolean;
+    /**
+     * @description 吸附开关
+     */
+    adsorption: boolean;
 };
 /**
- * @description 视口展示功能参数
+ * @description 页面数据
  */
-type PreferenceGizmoConfig = {
+type PageData = {
     /**
-   * @description 视口窗包围盒颜色
-   */
-    boxColor: number;
+     * @description 基础场景数据
+     */
+    scene: spec.JSONScene;
     /**
-     * @description 视口窗包围盒宽度
+     * @description 页面属性
      */
-    boxWidth: number;
+    property: PageProperty;
     /**
-     * @description 视口区域外遮罩颜色
+     * @description 视图属性
      */
-    markColor: number;
+    viewProperties: ViewProperty[];
     /**
-     * @description 视口区域外遮罩透明度
+     * @description 活跃数据
      */
-    markAlpha: number;
+    activeData: ActiveData;
     /**
-     * @description 出血区预览开关
+     * @description 元素数据
      */
-    safeAreaEnabled: boolean;
+    items: ViewItem[];
     /**
-     * @description 出血区颜色
+     * @description 视图当前时间
      */
-    safeAreaBoxColor: number;
+    time: number;
     /**
-     * @description 出血区透明度
+     * @description 是否处于播放态
      */
-    safeAreaBoxAlpha: number;
+    playing: boolean;
 };
 /**
- * @description 选择功能参数
+ * @description 页面配置
  */
-type SelectorGizmoConfig = {
-    /**
-     * @description 预选框线宽
-     */
-    preSelectedWidth: number;
-    /**
-     * @description 预选框颜色
-     */
-    preSelectedColor: number;
-    /**
-     * @description 框选区域颜色
-     */
-    regionBoxColor: number;
+type PageConfig = {
     /**
-     * @description 框选区域透明度
+     * @description 出血区域展示开关
      */
-    regionBoxAlpha: number;
+    safeAreaPreview: boolean;
     /**
-     * @description 框选区域包围框颜色
+     * @description 缩放值
      */
-    regionWireframeColor: number;
+    zoom: number;
     /**
-     * @description 框选区域包围框透明度
+     * @description 吸附开关
      */
-    regionWireframeAlpha: number;
+    adsorption: boolean;
     /**
-     * @description 框选区域包围框宽度
+     * @description 同步开关
      */
-    regionWireframeWidth: number;
+    asyncMode: boolean;
 };
 /**
- * @description 变换功能参数
+ * @description 页面属性
  */
-type TransformGizmoConfig = {
+type PageProperty = {
     /**
-     * @description 变换交互框颜色
+     * @description 出血区域展示开关
      */
-    wireframeColor: number;
+    safeAreaPreview: boolean;
     /**
-     * @description 变换交互框透明度
+     * @description 缩放值
      */
-    wireframeAlpha: number;
+    zoom: number;
     /**
-     * @description 变换交互框宽度
+     * @description 偏移值
      */
-    wireframeWidth: number;
+    translation: [number, number];
     /**
-     * @description 变换交互框角点填充色
+     * @description 吸附开关
      */
-    cornerFillColor: number;
+    adsorption: boolean;
     /**
-     * @description 变换交互框角点线框色
+     * @description 同步开关
      */
-    cornerLineColor: number;
+    asyncMode: boolean;
+};
+/**
+ * @description 视图创建参数
+ */
+type ViewParam = {
     /**
-     * @description 变换交互框角点线框宽度
+     * @description 页面尺寸
      */
-    cornerLineWidth: number;
+    size?: [number, number];
     /**
-     * @description 变换交互框角点线框透明度
+     * @description 出血区参数
      */
-    cornerLineAlpha: number;
+    safeArea?: [number, number, number, number];
     /**
-     * @description 交互框缩放圆半径
+     * @description 自适应方向 - 默认根据视图宽高决定
      */
-    scaleCircleSize: number;
+    adaptionDirection?: SizeAdaptDirection;
     /**
-     * @description 交互框旋转圆半径
+     * @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];
-    'exportComplete': [success: boolean];
-    'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
+    previewSafeAreas?: PreviewSafeAreaParam[];
+    /**
+     * @description 导出参数
+     */
+    export: ExportParam;
 };
-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;
-    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" | "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 导出参数
+ */
+type ExportParam = {
     /**
-     * @description 获取目标元素的所有属性
-     * @param param 元素ID、类型
-     * @returns 元素属性
+     * @description 导出视频时长
      */
-    getItemProperty<T extends keyof PageFormTypeAndPropertyReference>(param: GetItemPropertyParam<T>): GetItemPropertyResult<T> | undefined;
+    time?: number;
     /**
-     * @description 获取目标元素的指定属性
-     * @param param 元素ID、类型、属性名
-     * @returns 元素属性值
+     * @description 导出大小上限 - 单位kb
      */
-    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 | undefined>;
+    fileSizeLimit: number;
     /**
-     * @description 切换场景
-     * @param index 场景索引
+     * @description 是否开启音轨
      */
-    switchScene(index: number): Promise<void>;
+    audioEnable: boolean;
     /**
-     * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
-     * @returns 页面的 safeAreaPreview、zoom、adsorption 值
+     * @description 视频fps - 默认 30
      */
-    getConfig(): PageConfig$1;
+    fps?: number;
     /**
-     * 设置页面的 safeAreaPreview、zoom、adsorption 值
-     * @param pageProperty 设置
+     * @description 导出视频类型 - 预留参数
      */
-    setConfig(pageConfig: PageConfig$1): void;
+    type?: string;
     /**
-     * @description 设置播放进度
-     * @param progress 播放进度 0-100
+     * @description 视频名称
      */
-    setPlayProgress(progress: number): Promise<void>;
-    getViewItems(): ViewItem[];
-    setPlayState(playState: 'play' | 'pause'): Promise<void>;
+    name?: string;
+};
+/**
+ * @description 视图属性
+ */
+type ViewProperty = {
     /**
-     * @description 获取场景预览图
-     * @returns 视图预览图
+     * @description 视图ID
      */
-    getViewThumbnail(): {
-        id: number;
-        thumbnail: Promise<string | undefined>;
-    }[];
-    private destroyCompositions;
+    id: number;
     /**
-     * @description 导出，支持导出媒体或其他，如MP4，未来支持 JSON 等；
+     * @description 视图宽高
      */
-    onExport(): void;
+    size: [number, number];
     /**
-     * @description 取消导出
+     * @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[]): void;
-    setExportParam(exportParam: ExportParam, id?: number): void;
+    safeArea: [number, number, number, number];
     /**
-     * @description 设置视图缩放
-     * @param zoom 缩放值
+     * @description 自定义出血区数据
      */
-    setPageZoom(zoom: number): void;
+    previewSafeAreas: PreviewSafeAreaParam[];
     /**
-     * @description 设置静态预览功能开关
-     * @param enabled 功能开关
+     * @description 视图场景数据
      */
-    setStaticPreviewEnabled(enabled: boolean): void;
+    scene: spec.JSONScene;
     /**
-     * @description 设置静态预览视图名称
-     * @param name 视图名称
+     * @description 导出参数
      */
-    setStaticPreviewName(name: string): void;
+    export: ExportParam;
     /**
-     * @description 设置同步修改功能开关
-     * @param enabled 功能开关
+     * @description 忽略交互 - 仅供展示
      */
-    setAsyncEnabled(enabled: boolean): void;
+    ignoreInteraction: boolean;
+};
+/**
+ * @description 自定义出血区数据
+ */
+type PreviewSafeAreaParam = {
     /**
-     * @description 设置 成组显影 开关
+     * @description 出血区包围盒 [left top width height]
      */
-    setGroupVisibleEnabled(enabled: boolean): void;
+    box: [number, number, number, number];
     /**
-     * @description 新增过滤元素名称
-     * @param itemNames 过滤元素名称
+     * @description 出血区色块颜色 默认为 [255, 255, 255, 0.3]
      */
-    addFilterItemNames(itemNames: string[] | string): void;
+    color?: [number, number, number, number];
+};
+/**
+ * @description 页面活跃数据
+ */
+type ActiveData = {
     /**
-     * @description 设置预览辅助层颜色
-     * @param color 色值
+     * @description 视图ID
      */
-    setPreferenceBackgroundColor(color: [number, number, number, number]): void;
+    view?: number;
     /**
-     * @description 设置出血区颜色
-     * @param color 色值
+     * @description 选中元素
      */
-    setSafeAreaColor(color: [number, number, number, number]): void;
+    selectedItems: string[];
     /**
-     * @description 设置 尺寸自适应拓展 功能开关
-     * @param enabled 功能开关
+     * @description 预选中元素
      */
-    setSizeAdaptEnabled(enabled: boolean): void;
+    preSelectedItem?: string;
+};
+/**
+ * @description 视图元素
+ */
+type ViewItem = {
     /**
-     * @description 设置 截图 功能开关
-     * @param enabled 功能开关
+     * @description 元素ID
      */
-    setScreenShotEnabled(enabled: boolean): void;
+    id: string;
     /**
-     * @description 设置 导出 功能开关
-     * @param enabled
+     * @description 元素名称
      */
-    setExportVideoEnabled(enabled: boolean): void;
+    name: string;
     /**
-     * @description 设置预选框参数
-     * @param preSelectedColor 预选框颜色
-     * @param preSelectedWidth 预选框线框宽度
+     * @description 元素父节点ID
      */
-    setSelectorGizmoPreSelectConfig(preSelectedColor?: number, preSelectedWidth?: number): void;
+    parentId?: string;
     /**
-     * @description 设置 变换控制器 交互框参数
-     * @param config 参数
+     * @description 子元素
      */
-    setTranformGizmoWireframeConfig(config: {
-        wireframeColor?: number;
-        wireframeAlpha?: number;
-        wireframeWidth?: number;
-    }): void;
+    children: string[];
     /**
-     * @description 获取 SDK 配置参数
-     * @returns SDK 配置参数
+     * @description 元素生命周期
      */
-    getSDKConfig(): SDKConfig;
+    duration: number;
     /**
-     * @description 设置 SDK 配置参数
-     * @param config SDK 配置参数
+     * @description 元素生命周期延时
      */
-    setSDKConfig(config: SDKConfig): void;
-}
+    delay: number;
+    /**
+     * @description 元素结束行为
+     */
+    endBehavior: spec.EndBehavior;
+} & ViewItemTypedProperty;
 
 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 };