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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/index.cjs +1 -1
  2. package/dist/index.d.cts +34 -2
  3. package/dist/index.d.ts +34 -2
  4. package/dist/index.global.js +1 -1
  5. package/dist/index.js +1 -1
  6. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _galacean_effects from '@galacean/effects';
2
- import { Player, spec } from '@galacean/effects';
2
+ import { spec, Player } from '@galacean/effects';
3
3
  export { spec } from '@galacean/effects';
4
4
 
5
5
  type ViewItemTypedProperty = {
@@ -64,6 +64,7 @@ declare global {
64
64
  createWebPCore: (config: any) => Promise<Img2WebPCore>;
65
65
  }
66
66
  }
67
+ type FileBuffer = ArrayBuffer | Uint8Array;
67
68
  type MediaType = typeof MEDIA_TYPE[keyof typeof MEDIA_TYPE];
68
69
  type FS = {
69
70
  writeFile: (path: string, data: Uint8Array | string) => void;
@@ -109,6 +110,36 @@ type ExportMediaInitOptions = {
109
110
  */
110
111
  multiThreading?: boolean;
111
112
  };
113
+ type ExportMediaItemOptions = {
114
+ /**
115
+ * 尺寸
116
+ */
117
+ size: [number, number];
118
+ /**
119
+ * 动效资源
120
+ */
121
+ scene: spec.JSONScene;
122
+ /**
123
+ * 视频时长，目前仅在导出 MP4 / AlphaMaskVideo 时有效，默认取动效资源时长
124
+ */
125
+ time?: number;
126
+ /**
127
+ * 是否生成音轨，默认 false，仅在导出 MP4 时有效
128
+ */
129
+ audioEnable?: boolean;
130
+ /**
131
+ * 帧率， 默认 30
132
+ */
133
+ fps?: number;
134
+ /**
135
+ * 是否循环，默认 true
136
+ */
137
+ loop?: boolean;
138
+ /**
139
+ * 视频背景颜色，默认 #000000
140
+ */
141
+ backgroundColor?: string;
142
+ };
112
143
 
113
144
  /**
114
145
  * @description SDK功能配置
@@ -341,6 +372,7 @@ type SDKEvents = {
341
372
  property: string;
342
373
  }];
343
374
  'exportProgress': [progress?: number];
375
+ 'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
344
376
  'exportComplete': [success: boolean];
345
377
  'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
346
378
  };
@@ -362,7 +394,7 @@ declare class SDK {
362
394
  get exportStatus(): string | undefined;
363
395
  private get exportOptions();
364
396
  dispose(): void;
365
- 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;
397
+ 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;
366
398
  private getInitParam;
367
399
  private initExporter;
368
400
  private initSDK;
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _galacean_effects from '@galacean/effects';
2
- import { Player, spec } from '@galacean/effects';
2
+ import { spec, Player } from '@galacean/effects';
3
3
  export { spec } from '@galacean/effects';
4
4
 
5
5
  type ViewItemTypedProperty = {
@@ -64,6 +64,7 @@ declare global {
64
64
  createWebPCore: (config: any) => Promise<Img2WebPCore>;
65
65
  }
66
66
  }
67
+ type FileBuffer = ArrayBuffer | Uint8Array;
67
68
  type MediaType = typeof MEDIA_TYPE[keyof typeof MEDIA_TYPE];
68
69
  type FS = {
69
70
  writeFile: (path: string, data: Uint8Array | string) => void;
@@ -109,6 +110,36 @@ type ExportMediaInitOptions = {
109
110
  */
110
111
  multiThreading?: boolean;
111
112
  };
113
+ type ExportMediaItemOptions = {
114
+ /**
115
+ * 尺寸
116
+ */
117
+ size: [number, number];
118
+ /**
119
+ * 动效资源
120
+ */
121
+ scene: spec.JSONScene;
122
+ /**
123
+ * 视频时长，目前仅在导出 MP4 / AlphaMaskVideo 时有效，默认取动效资源时长
124
+ */
125
+ time?: number;
126
+ /**
127
+ * 是否生成音轨，默认 false，仅在导出 MP4 时有效
128
+ */
129
+ audioEnable?: boolean;
130
+ /**
131
+ * 帧率， 默认 30
132
+ */
133
+ fps?: number;
134
+ /**
135
+ * 是否循环，默认 true
136
+ */
137
+ loop?: boolean;
138
+ /**
139
+ * 视频背景颜色，默认 #000000
140
+ */
141
+ backgroundColor?: string;
142
+ };
112
143
 
113
144
  /**
114
145
  * @description SDK功能配置
@@ -341,6 +372,7 @@ type SDKEvents = {
341
372
  property: string;
342
373
  }];
343
374
  'exportProgress': [progress?: number];
375
+ 'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
344
376
  'exportComplete': [success: boolean];
345
377
  'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
346
378
  };
@@ -362,7 +394,7 @@ declare class SDK {
362
394
  get exportStatus(): string | undefined;
363
395
  private get exportOptions();
364
396
  dispose(): void;
365
- 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;
397
+ 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;
366
398
  private getInitParam;
367
399
  private initExporter;
368
400
  private initSDK;