@vvfx/sdk 0.1.14-alpha.4 → 0.1.14-alpha.6

package/dist/index.d.cts

@@ -108,13 +108,13 @@ type EffectsItemOptions = SDKItemOptions & {
  * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
  */
 declare enum SDKItemType {
-    Sprite = "sprite",
-    Text = "text",
-    Video = "video",
-    Group = "group",
-    Generator = "generator",
-    Effects = "effects",
-    Frame = "frame"
+    SPRITE = "sprite",
+    TEXT = "text",
+    VIDEO = "video",
+    GROUP = "group",
+    GENERATOR = "generator",
+    EFFECTS = "effects",
+    FRAME = "frame"
 }
 
 /**
@@ -243,7 +243,7 @@ declare class SpriteItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Sprite;
+    readonly type = SDKItemType.SPRITE;
     /**
      * @description 元素属性
      */
@@ -308,7 +308,7 @@ declare class TextItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Text;
+    readonly type = SDKItemType.TEXT;
     /**
      * @description 元素属性
      */
@@ -412,7 +412,7 @@ declare class VideoItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Video;
+    readonly type = SDKItemType.VIDEO;
     /**
      * @description 元素属性
      */
@@ -491,7 +491,7 @@ declare class GroupItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Group;
+    readonly type = SDKItemType.GROUP;
     /**
      * @description 元素属性
      */
@@ -552,7 +552,7 @@ declare class GeneratorItem extends BaseItem {
     /**
      * @description 元素类型（独立类型，不属于 spec.ItemType）
      */
-    readonly type = SDKItemType.Generator;
+    readonly type = SDKItemType.GENERATOR;
     /**
      * @description 元素属性（包含 generatorType）
      */
@@ -627,7 +627,7 @@ declare class EffectsItem extends BaseItem {
     /**
      * @description 元素类型（独立类型，不属于 spec.ItemType）
      */
-    readonly type = SDKItemType.Effects;
+    readonly type = SDKItemType.EFFECTS;
     /**
      * @description 元素属性
      */
@@ -2068,7 +2068,18 @@ declare class SDK {
      * @param progress 播放进度 0-100
      */
     setPlayProgress(progress: number): Promise<void>;
-    getSDKItems(): SDKItem$1[];
+    /**
+     * @description 获取元素
+     * @param id 元素ID
+     * @returns 元素
+     * */
+    getSDKItem(id: string): SDKItem$1 | undefined;
+    /**
+     * @description 获取元素数组
+     * @param id 元素ID数组
+     * @returns 元素数组
+     * */
+    getSDKItems(ids?: string[]): SDKItem$1[];
     setPlayState(playState: 'play' | 'pause'): Promise<void>;
     /**
      * @description 获取场景预览图
@@ -2238,8 +2249,8 @@ declare class SDK {
     addTextItem(textInfo: TextCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
     addItemByCreateInfos(createInfos: ItemCreateInfo[], asyncMode?: boolean): Promise<(string | undefined)[]>;
     deleteItems(idInfo: string | string[]): void;
-    getItemCreateInfo(idInfo: string): ItemCreateInfo | undefined;
-    getItemCreateInfo(idInfo: string[]): ItemCreateInfo[];
+    getItemCreateInfo(id: string): ItemCreateInfo | undefined;
+    getItemCreateInfos(ids?: string[]): ItemCreateInfo[];
     createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
     getChildrenIds(id: string): string[];
     /**
@@ -2255,7 +2266,6 @@ declare class SDK {
      */
     exportJSON(idInfo?: number | number[]): spec.JSONScene[];
     getViewBoxById(id: string): Box2;
-    getSDKItemById(id: string): SDKItem$1 | undefined;
     /**
      * @description 批量设置元素扩展属性
      * @param id 元素ID
@@ -2460,13 +2470,13 @@ type PageFormTypeAndPropertyReference = {
     [spec.ItemType.base]: BaseItemProperty;
     [spec.ItemType.sprite]: SpriteItemProperty;
     [spec.ItemType.null]: BaseItemProperty;
-    [SDKItemType.Sprite]: SpriteItemProperty;
-    [SDKItemType.Text]: TextItemProperty;
-    [SDKItemType.Video]: VideoItemProperty;
-    [SDKItemType.Group]: GroupItemProperty;
-    [SDKItemType.Generator]: GeneratorItemProperty;
-    [SDKItemType.Effects]: EffectsItemProperty;
-    [SDKItemType.Frame]: BaseItemProperty;
+    [SDKItemType.SPRITE]: SpriteItemProperty;
+    [SDKItemType.TEXT]: TextItemProperty;
+    [SDKItemType.VIDEO]: VideoItemProperty;
+    [SDKItemType.GROUP]: GroupItemProperty;
+    [SDKItemType.GENERATOR]: GeneratorItemProperty;
+    [SDKItemType.EFFECTS]: EffectsItemProperty;
+    [SDKItemType.FRAME]: BaseItemProperty;
     [spec.ItemType.interact]: BaseItemProperty;
     [spec.ItemType.plugin]: BaseItemProperty;
     [spec.ItemType.camera]: BaseItemProperty;
@@ -2743,7 +2753,7 @@ type SDKBackgroundType = 'color' | 'image' | 'chess-board' | 'dot-board';
  * @description 图层创建信息
  */
 type SpriteCreateInfo = {
-    type: SDKItemType.Sprite;
+    type: SDKItemType.SPRITE;
     /**
      * @description 图层名称
      */
@@ -2769,9 +2779,13 @@ type SpriteCreateInfo = {
          */
         image: string;
         /**
-         * @description 元素像素大小
+         * @description 图层像素宽度
+         */
+        width: number;
+        /**
+         * @description 图层像素高度
          */
-        size: [number, number];
+        height: number;
         /**
          * @description 元素位置
          */
@@ -2790,7 +2804,7 @@ type SpriteCreateInfo = {
  * @description 空节点创建信息
  */
 type GroupCreateInfo = {
-    type: SDKItemType.Group;
+    type: SDKItemType.GROUP;
     /**
      * @description 元素id
      */
@@ -2814,7 +2828,7 @@ type GroupCreateInfo = {
         /**
          * @description 元素位置
          */
-        position: [number, number];
+        position?: [number, number];
         /**
          * @description 元素旋转 z | [x, y, z]
          */
@@ -2833,7 +2847,7 @@ type GroupCreateInfo = {
  * @description 文本创建信息
  */
 type TextCreateInfo = {
-    type: SDKItemType.Text;
+    type: SDKItemType.TEXT;
     /**
      * @description 元素id
      */
@@ -2855,9 +2869,13 @@ type TextCreateInfo = {
      */
     property: {
         /**
-     * @description 文本宽高
-     */
-        size: [number, number];
+         * @description 文本宽度
+         */
+        width: number;
+        /**
+         * @description 文本高度
+         */
+        height?: number;
         /**
          * @description 元素位置
          */
@@ -2924,7 +2942,7 @@ type TextCreateInfo = {
  * @description 视频创建信息
  */
 type VideoCreateInfo = {
-    type: SDKItemType.Video;
+    type: SDKItemType.VIDEO;
     /**
      * @description 视频名称
      */
@@ -2950,9 +2968,13 @@ type VideoCreateInfo = {
          */
         video: string;
         /**
-         * @description 视频元素像素大小
+         * @description 视频元素像素宽度
+         */
+        width: number;
+        /**
+         * @description 视频元素像素高度
          */
-        size: [number, number];
+        height: number;
         /**
          * @description 视频元素位置
          */
@@ -2994,7 +3016,7 @@ type GeneratorCreateInfo = {
     /**
      * @description 元素类型 - 生成器
      */
-    type: SDKItemType.Generator;
+    type: SDKItemType.GENERATOR;
     /**
      * @description 元素名称
      */
@@ -3020,9 +3042,13 @@ type GeneratorCreateInfo = {
          */
         generatorType: GeneratorType;
         /**
-         * @description 生成器元素像素大小
+         * @description 生成器元素像素宽度
          */
-        size: [number, number];
+        width: number;
+        /**
+         * @description 生成器元素像素高度
+         */
+        height: number;
         /**
          * @description 生成器元素位置
          */
@@ -3100,7 +3126,7 @@ type EffectsCreateInfo = {
     /**
      * @description 元素类型 - 特效
      */
-    type: SDKItemType.Effects;
+    type: SDKItemType.EFFECTS;
     /**
      * @description 元素名称
      */
@@ -3115,9 +3141,13 @@ type EffectsCreateInfo = {
     parentId?: string;
     property: {
         /**
-         * @description 生成器大小
+         * @description 动效像素宽度
+         */
+        width?: number;
+        /**
+         * @description 动效像素高度
          */
-        size?: spec.vec2;
+        height?: number;
         /**
          * @description 生成器位置
          */
@@ -3182,4 +3212,4 @@ type ViewportFitShiftParam = {
     bottom?: number;
 };
 
-export { type ActiveData, BaseItem, type BaseItemProperty, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };
+export { type ActiveData, BaseItem, type BaseItemProperty, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, SDKItemType, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };

package/dist/index.d.ts

@@ -108,13 +108,13 @@ type EffectsItemOptions = SDKItemOptions & {
  * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
  */
 declare enum SDKItemType {
-    Sprite = "sprite",
-    Text = "text",
-    Video = "video",
-    Group = "group",
-    Generator = "generator",
-    Effects = "effects",
-    Frame = "frame"
+    SPRITE = "sprite",
+    TEXT = "text",
+    VIDEO = "video",
+    GROUP = "group",
+    GENERATOR = "generator",
+    EFFECTS = "effects",
+    FRAME = "frame"
 }
 
 /**
@@ -243,7 +243,7 @@ declare class SpriteItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Sprite;
+    readonly type = SDKItemType.SPRITE;
     /**
      * @description 元素属性
      */
@@ -308,7 +308,7 @@ declare class TextItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Text;
+    readonly type = SDKItemType.TEXT;
     /**
      * @description 元素属性
      */
@@ -412,7 +412,7 @@ declare class VideoItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Video;
+    readonly type = SDKItemType.VIDEO;
     /**
      * @description 元素属性
      */
@@ -491,7 +491,7 @@ declare class GroupItem extends BaseItem {
     /**
      * @description 元素类型
      */
-    readonly type = SDKItemType.Group;
+    readonly type = SDKItemType.GROUP;
     /**
      * @description 元素属性
      */
@@ -552,7 +552,7 @@ declare class GeneratorItem extends BaseItem {
     /**
      * @description 元素类型（独立类型，不属于 spec.ItemType）
      */
-    readonly type = SDKItemType.Generator;
+    readonly type = SDKItemType.GENERATOR;
     /**
      * @description 元素属性（包含 generatorType）
      */
@@ -627,7 +627,7 @@ declare class EffectsItem extends BaseItem {
     /**
      * @description 元素类型（独立类型，不属于 spec.ItemType）
      */
-    readonly type = SDKItemType.Effects;
+    readonly type = SDKItemType.EFFECTS;
     /**
      * @description 元素属性
      */
@@ -2068,7 +2068,18 @@ declare class SDK {
      * @param progress 播放进度 0-100
      */
     setPlayProgress(progress: number): Promise<void>;
-    getSDKItems(): SDKItem$1[];
+    /**
+     * @description 获取元素
+     * @param id 元素ID
+     * @returns 元素
+     * */
+    getSDKItem(id: string): SDKItem$1 | undefined;
+    /**
+     * @description 获取元素数组
+     * @param id 元素ID数组
+     * @returns 元素数组
+     * */
+    getSDKItems(ids?: string[]): SDKItem$1[];
     setPlayState(playState: 'play' | 'pause'): Promise<void>;
     /**
      * @description 获取场景预览图
@@ -2238,8 +2249,8 @@ declare class SDK {
     addTextItem(textInfo: TextCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
     addItemByCreateInfos(createInfos: ItemCreateInfo[], asyncMode?: boolean): Promise<(string | undefined)[]>;
     deleteItems(idInfo: string | string[]): void;
-    getItemCreateInfo(idInfo: string): ItemCreateInfo | undefined;
-    getItemCreateInfo(idInfo: string[]): ItemCreateInfo[];
+    getItemCreateInfo(id: string): ItemCreateInfo | undefined;
+    getItemCreateInfos(ids?: string[]): ItemCreateInfo[];
     createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
     getChildrenIds(id: string): string[];
     /**
@@ -2255,7 +2266,6 @@ declare class SDK {
      */
     exportJSON(idInfo?: number | number[]): spec.JSONScene[];
     getViewBoxById(id: string): Box2;
-    getSDKItemById(id: string): SDKItem$1 | undefined;
     /**
      * @description 批量设置元素扩展属性
      * @param id 元素ID
@@ -2460,13 +2470,13 @@ type PageFormTypeAndPropertyReference = {
     [spec.ItemType.base]: BaseItemProperty;
     [spec.ItemType.sprite]: SpriteItemProperty;
     [spec.ItemType.null]: BaseItemProperty;
-    [SDKItemType.Sprite]: SpriteItemProperty;
-    [SDKItemType.Text]: TextItemProperty;
-    [SDKItemType.Video]: VideoItemProperty;
-    [SDKItemType.Group]: GroupItemProperty;
-    [SDKItemType.Generator]: GeneratorItemProperty;
-    [SDKItemType.Effects]: EffectsItemProperty;
-    [SDKItemType.Frame]: BaseItemProperty;
+    [SDKItemType.SPRITE]: SpriteItemProperty;
+    [SDKItemType.TEXT]: TextItemProperty;
+    [SDKItemType.VIDEO]: VideoItemProperty;
+    [SDKItemType.GROUP]: GroupItemProperty;
+    [SDKItemType.GENERATOR]: GeneratorItemProperty;
+    [SDKItemType.EFFECTS]: EffectsItemProperty;
+    [SDKItemType.FRAME]: BaseItemProperty;
     [spec.ItemType.interact]: BaseItemProperty;
     [spec.ItemType.plugin]: BaseItemProperty;
     [spec.ItemType.camera]: BaseItemProperty;
@@ -2743,7 +2753,7 @@ type SDKBackgroundType = 'color' | 'image' | 'chess-board' | 'dot-board';
  * @description 图层创建信息
  */
 type SpriteCreateInfo = {
-    type: SDKItemType.Sprite;
+    type: SDKItemType.SPRITE;
     /**
      * @description 图层名称
      */
@@ -2769,9 +2779,13 @@ type SpriteCreateInfo = {
          */
         image: string;
         /**
-         * @description 元素像素大小
+         * @description 图层像素宽度
+         */
+        width: number;
+        /**
+         * @description 图层像素高度
          */
-        size: [number, number];
+        height: number;
         /**
          * @description 元素位置
          */
@@ -2790,7 +2804,7 @@ type SpriteCreateInfo = {
  * @description 空节点创建信息
  */
 type GroupCreateInfo = {
-    type: SDKItemType.Group;
+    type: SDKItemType.GROUP;
     /**
      * @description 元素id
      */
@@ -2814,7 +2828,7 @@ type GroupCreateInfo = {
         /**
          * @description 元素位置
          */
-        position: [number, number];
+        position?: [number, number];
         /**
          * @description 元素旋转 z | [x, y, z]
          */
@@ -2833,7 +2847,7 @@ type GroupCreateInfo = {
  * @description 文本创建信息
  */
 type TextCreateInfo = {
-    type: SDKItemType.Text;
+    type: SDKItemType.TEXT;
     /**
      * @description 元素id
      */
@@ -2855,9 +2869,13 @@ type TextCreateInfo = {
      */
     property: {
         /**
-     * @description 文本宽高
-     */
-        size: [number, number];
+         * @description 文本宽度
+         */
+        width: number;
+        /**
+         * @description 文本高度
+         */
+        height?: number;
         /**
          * @description 元素位置
          */
@@ -2924,7 +2942,7 @@ type TextCreateInfo = {
  * @description 视频创建信息
  */
 type VideoCreateInfo = {
-    type: SDKItemType.Video;
+    type: SDKItemType.VIDEO;
     /**
      * @description 视频名称
      */
@@ -2950,9 +2968,13 @@ type VideoCreateInfo = {
          */
         video: string;
         /**
-         * @description 视频元素像素大小
+         * @description 视频元素像素宽度
+         */
+        width: number;
+        /**
+         * @description 视频元素像素高度
          */
-        size: [number, number];
+        height: number;
         /**
          * @description 视频元素位置
          */
@@ -2994,7 +3016,7 @@ type GeneratorCreateInfo = {
     /**
      * @description 元素类型 - 生成器
      */
-    type: SDKItemType.Generator;
+    type: SDKItemType.GENERATOR;
     /**
      * @description 元素名称
      */
@@ -3020,9 +3042,13 @@ type GeneratorCreateInfo = {
          */
         generatorType: GeneratorType;
         /**
-         * @description 生成器元素像素大小
+         * @description 生成器元素像素宽度
          */
-        size: [number, number];
+        width: number;
+        /**
+         * @description 生成器元素像素高度
+         */
+        height: number;
         /**
          * @description 生成器元素位置
          */
@@ -3100,7 +3126,7 @@ type EffectsCreateInfo = {
     /**
      * @description 元素类型 - 特效
      */
-    type: SDKItemType.Effects;
+    type: SDKItemType.EFFECTS;
     /**
      * @description 元素名称
      */
@@ -3115,9 +3141,13 @@ type EffectsCreateInfo = {
     parentId?: string;
     property: {
         /**
-         * @description 生成器大小
+         * @description 动效像素宽度
+         */
+        width?: number;
+        /**
+         * @description 动效像素高度
          */
-        size?: spec.vec2;
+        height?: number;
         /**
          * @description 生成器位置
          */
@@ -3182,4 +3212,4 @@ type ViewportFitShiftParam = {
     bottom?: number;
 };
 
-export { type ActiveData, BaseItem, type BaseItemProperty, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };
+export { type ActiveData, BaseItem, type BaseItemProperty, Box2, type CreateOperation, type DeleteOperation, type EffectsCreateInfo, EffectsItem, type EffectsItemOptions, type GeneratorCreateInfo, GeneratorItem, type GeneratorItemOptions, type GeneratorItemProperty, type GizmoType, type GroupCreateInfo, GroupItem, type GroupItemOptions, type ItemCreateInfo, ItemOrderAction, type Operation, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKItem$1 as SDKItem, type SDKItemOptions, SDKItemType, type SDKOptions, type SetItemPropertyValueParam, type SpecificPageFormProps, type SpriteCreateInfo, SpriteItem, type SpriteItemOptions, type SpriteItemProperty, type TextCreateInfo, TextItem, type TextItemOptions, type TextItemProperty, type UpdateOperation, Vector2, type VideoCreateInfo, VideoItem, type VideoItemOptions, type VideoItemProperty, type ViewItemTypedProperty, type ViewParam, type ViewProperty, createSDKItem, isBaseItem, isEffectsItem, isGeneratorItem, isGroupItem, isSpriteItem, isTextItem, isVideoItem };