@vvfx/sdk 0.0.0-alpha.4

package/dist/index.d.ts

@@ -0,0 +1,447 @@
+import { math, 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]: {
+        /**
+         * @description 元素类型
+         */
+        type: K;
+        /**
+         * @description 元素属性
+         */
+        property: PageFormTypeAndPropertyReference[K];
+    };
+}[keyof PageFormTypeAndPropertyReference];
+type PageFormTypedProperty = {
+    [K in keyof PageFormTypeAndPropertyReference]: {
+        type: K;
+        property: PageFormTypeAndPropertyReference[K];
+        onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[K]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[K][N]) => void;
+    };
+}[keyof PageFormTypeAndPropertyReference];
+type GetItemPropertyValueParam<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]> = {
+    itemId: string;
+    type: T;
+    propertyName: N;
+};
+type GetItemPropertyValueResult<T extends keyof PageFormTypeAndPropertyReference, N extends keyof PageFormTypeAndPropertyReference[T]> = PageFormTypeAndPropertyReference[T][N];
+type GetItemPropertyParam<T extends keyof PageFormTypeAndPropertyReference> = {
+    itemId: string;
+    type: T;
+};
+type GetItemPropertyResult<T extends keyof PageFormTypeAndPropertyReference> = {
+    type: T;
+    property: PageFormTypeAndPropertyReference[T];
+};
+type SetItemPropertyValueParam = {
+    [T in keyof PageFormTypeAndPropertyReference]: {
+        [N in keyof PageFormTypeAndPropertyReference[T]]: {
+            itemId: string;
+            type: T;
+            propertyName: N;
+            propertyValue: PageFormTypeAndPropertyReference[T][N];
+        };
+    }[keyof PageFormTypeAndPropertyReference[T]];
+}[keyof PageFormTypeAndPropertyReference];
+
+type BaseFormProperty = {
+    position: [number, number, number];
+    rotation: [number, number, number];
+    scale: [number, number, number];
+    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;
+};
+type SpecificPageFormProps<T extends keyof PageFormTypeAndPropertyReference> = {
+    type: T;
+    property: PageFormTypeAndPropertyReference[T];
+    onPropertyValueChange: <N extends keyof PageFormTypeAndPropertyReference[T]>(propertyName: N, propertyValue: PageFormTypeAndPropertyReference[T][N]) => void;
+};
+/**
+ * @description SDK入参
+ */
+type SDKInputParam = {
+    /**
+     * @description JSON地址
+     */
+    scene: string;
+    /**
+     * @description 视图参数
+     */
+    viewParams: ViewParam[];
+    /**
+     * @description 页面属性
+     */
+    options: PageOptions;
+    /**
+     * @description 是否开启出血区强制变换
+     */
+    keepSafe: boolean;
+};
+/**
+ * @description 页面属性
+ */
+type PageOptions = {
+    /**
+     * @description 同步模式开关
+     */
+    asyncMode: boolean;
+    /**
+     * @description 安全区展示开关
+     */
+    safeAreaPreview: boolean;
+    /**
+     * @description 吸附开关
+     */
+    adsorption: boolean;
+};
+/**
+ * @description 页面数据
+ */
+type PageData = {
+    /**
+     * @description 页面属性
+     */
+    property: PageProperty;
+    /**
+     * @description 视图属性
+     */
+    viewProperties: ViewProperty[];
+    /**
+     * @description 活跃数据
+     */
+    activeData: ActiveData;
+    /**
+     * @description 元素数据
+     */
+    items: ViewItem[];
+    /**
+     * @description 视图当前时间
+     */
+    time: number;
+    /**
+     * @description 是否处于播放态
+     */
+    playing: boolean;
+};
+/**
+ * @description 页面配置
+ */
+type PageConfig = {
+    /**
+     * @description 出血区域展示开关
+     */
+    safeAreaPreview: boolean;
+    /**
+     * @description 缩放值
+     */
+    zoom: number;
+    /**
+     * @description 吸附开关
+     */
+    adsorption: boolean;
+};
+/**
+ * @description 页面属性
+ */
+type PageProperty = {
+    /**
+     * @description 出血区域展示开关
+     */
+    safeAreaPreview: boolean;
+    /**
+     * @description 缩放值
+     */
+    zoom: number;
+    /**
+     * @description 偏移值
+     */
+    translation: Vector2;
+    /**
+     * @description 吸附开关
+     */
+    adsorption: boolean;
+    /**
+     * @description 同步开关
+     */
+    sync: boolean;
+};
+/**
+ * @description 视图创建参数
+ */
+type ViewParam = {
+    /**
+     * @description 页面尺寸
+     */
+    size: [number, number];
+    /**
+     * @description 出血区参数
+     */
+    safeArea: SafeAreaParam;
+    /**
+     * @description 导出参数
+     */
+    export: ExportParam;
+};
+/**
+ * @description 安全区数据
+ */
+type SafeAreaParam = {
+    /**
+     * @description 出血区大小 - [上, 下, 左, 右]
+     */
+    size: [number, number, number, number];
+    /**
+     * @description 元素名称关键字
+     */
+    keyWords: string[];
+};
+/**
+ * @description 导出参数
+ */
+type ExportParam = {
+    /**
+     * @description 导出视频时长
+     */
+    time: number;
+    /**
+     * @description 导出大小上限 - 单位kb
+     */
+    fileSizeLimit: number;
+    /**
+     * @description 是否开启音轨
+     */
+    audioEnable: boolean;
+    /**
+     * @description 导出视频类型 - 预留参数
+     */
+    type?: string;
+};
+/**
+ * @description 视图属性
+ */
+type ViewProperty = {
+    /**
+     * @description 视图ID
+     */
+    id: number;
+    /**
+     * @description 视图宽高
+     */
+    size: [number, number];
+    /**
+     * @description 出血区数据
+     */
+    safeArea: SafeAreaParam;
+    /**
+     * @description 视图场景数据
+     */
+    scene: spec.JSONScene;
+    /**
+     * @description 预览图数据
+     */
+    thumbnail: string;
+    /**
+     * @description 导出参数
+     */
+    export: ExportParam;
+};
+/**
+ * @description 页面活跃数据
+ */
+type ActiveData = {
+    /**
+     * @description 视图ID
+     */
+    view?: number;
+    /**
+     * @description 选中元素
+     */
+    selectedItems: string[];
+    /**
+     * @description 预选中元素
+     */
+    preSelectedItem?: string;
+};
+/**
+ * @description 视图元素
+ */
+type ViewItem = {
+    /**
+     * @description 元素ID
+     */
+    id: string;
+    /**
+     * @description 元素名称
+     */
+    name: string;
+    /**
+     * @description 元素父节点ID
+     */
+    parentId?: string;
+    /**
+     * @description 子元素
+     */
+    children: string[];
+    /**
+     * @description 元素生命周期
+     */
+    duration: number;
+    /**
+     * @description 元素生命周期延时
+     */
+    delay: number;
+    /**
+     * @description 元素结束行为
+     */
+    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;
+    /**
+     * @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): void;
+    generateScreenShot(id: number): Promise<string>;
+    /**
+     * @description 切换场景
+     * @param index 场景索引
+     */
+    switchScene(index: number): Promise<void>;
+    /**
+     * @description 获取页面的 safeAreaPreview、zoom、adsorption 值
+     * @returns 页面的 safeAreaPreview、zoom、adsorption 值
+     */
+    getConfig(): PageConfig;
+    /**
+     * 设置页面的 safeAreaPreview、zoom、adsorption 值
+     * @param pageProperty 设置
+     */
+    setConfig(pageConfig: PageConfig): void;
+    /**
+     * @description 设置播放进度
+     * @param progress 播放进度 0-100
+     */
+    setPlayProgress(progress: number): void;
+    getViewItems(): ViewItem[];
+    setPlayState(playState: 'play' | 'pause'): void;
+    /**
+     * @description 获取场景预览图
+     * @returns 视图预览图
+     */
+    getViewThumbnail(): {
+        id: number;
+        thumbnail: string;
+    }[];
+    /**
+     * @description 导出所有视频
+     * @returns 导出视频的 ArrayBuffer 数组
+     */
+    exportAllVideos(): Promise<void>;
+    cancelExportAllVideos(): void;
+}
+
+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 };