@vvfx/sdk 0.1.4-alpha.1 → 0.1.5

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 +14 -1
  2. package/dist/index.d.cts +22 -9
  3. package/dist/index.d.ts +22 -9
  4. package/dist/index.global.js +12 -1
  5. package/dist/index.js +14 -1
  6. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -533,6 +533,20 @@ type ExportMediaItemOptions = {
533
533
  */
534
534
  apngConfig?: ApngConfig;
535
535
  };
536
+ type ExportMediaItemDownloadInfo = {
537
+ /**
538
+ * @description 导出文件夹名称
539
+ */
540
+ folderName: string;
541
+ /**
542
+ * @description 导出视频名称
543
+ */
544
+ name: string;
545
+ };
546
+ type ExportItemParams = ExportMediaItemOptions & ExportMediaItemDownloadInfo;
547
+ type ExportParams = ExportItemParams[];
548
+ type Buffers = FileBuffer[] | undefined;
549
+ type Extras = (FileBuffer | null)[] | null | undefined;
536
550
 
537
551
  type SDKMode = 'editor' | 'template';
538
552
  /**
@@ -1214,8 +1228,8 @@ type SDKEvents = {
1214
1228
  property: string;
1215
1229
  }];
1216
1230
  'exportProgress': [progress?: number];
1217
- 'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
1218
- 'exportComplete': [success: boolean, taskInfos: ExportMediaItemOptions[], buffers?: FileBuffer[]];
1231
+ 'exportDone': [item: ExportItemParams | undefined, success: boolean, buffer?: FileBuffer];
1232
+ 'exportComplete': [success: boolean, taskInfos: ExportParams, buffers: Buffers, extras: Extras];
1219
1233
  'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
1220
1234
  'cutBoxChange': [box: Box2];
1221
1235
  'expandBoxChange': [box: Box2];
@@ -1268,12 +1282,6 @@ declare class SDK {
1268
1282
  on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick" | "videoPlay">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
1269
1283
  setSDKMode(mode: SDKMode): void;
1270
1284
  private getInitParam;
1271
- /**
1272
- * 检测导出是否需要重新初始化
1273
- * @param preExportVideoConfig
1274
- * @param curExportVideoConfig
1275
- */
1276
- private checkExporter;
1277
1285
  private initExporter;
1278
1286
  private initSDK;
1279
1287
  run(param: SDKInputParam): Promise<void>;
@@ -1336,7 +1344,12 @@ declare class SDK {
1336
1344
  }[];
1337
1345
  private destroyCompositions;
1338
1346
  /**
1339
- * @description 导出，支持导出媒体或其他，如MP4，未来支持 JSON 等；
1347
+ * @description 以媒体格式 buffer 下载
1348
+ */
1349
+ downloadByMediaBuffersOfExporter(params: ExportMediaItemDownloadInfo[], buffers: Buffers, extras: Extras): void;
1350
+ /**
1351
+ * @description 导出
1352
+ * 支持导出媒体或其他，如MP4，未来支持 JSON 等；
1340
1353
  */
1341
1354
  onExport(): void;
1342
1355
  /**
package/dist/index.d.ts CHANGED
@@ -533,6 +533,20 @@ type ExportMediaItemOptions = {
533
533
  */
534
534
  apngConfig?: ApngConfig;
535
535
  };
536
+ type ExportMediaItemDownloadInfo = {
537
+ /**
538
+ * @description 导出文件夹名称
539
+ */
540
+ folderName: string;
541
+ /**
542
+ * @description 导出视频名称
543
+ */
544
+ name: string;
545
+ };
546
+ type ExportItemParams = ExportMediaItemOptions & ExportMediaItemDownloadInfo;
547
+ type ExportParams = ExportItemParams[];
548
+ type Buffers = FileBuffer[] | undefined;
549
+ type Extras = (FileBuffer | null)[] | null | undefined;
536
550
 
537
551
  type SDKMode = 'editor' | 'template';
538
552
  /**
@@ -1214,8 +1228,8 @@ type SDKEvents = {
1214
1228
  property: string;
1215
1229
  }];
1216
1230
  'exportProgress': [progress?: number];
1217
- 'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
1218
- 'exportComplete': [success: boolean, taskInfos: ExportMediaItemOptions[], buffers?: FileBuffer[]];
1231
+ 'exportDone': [item: ExportItemParams | undefined, success: boolean, buffer?: FileBuffer];
1232
+ 'exportComplete': [success: boolean, taskInfos: ExportParams, buffers: Buffers, extras: Extras];
1219
1233
  'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
1220
1234
  'cutBoxChange': [box: Box2];
1221
1235
  'expandBoxChange': [box: Box2];
@@ -1268,12 +1282,6 @@ declare class SDK {
1268
1282
  on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick" | "videoPlay">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
1269
1283
  setSDKMode(mode: SDKMode): void;
1270
1284
  private getInitParam;
1271
- /**
1272
- * 检测导出是否需要重新初始化
1273
- * @param preExportVideoConfig
1274
- * @param curExportVideoConfig
1275
- */
1276
- private checkExporter;
1277
1285
  private initExporter;
1278
1286
  private initSDK;
1279
1287
  run(param: SDKInputParam): Promise<void>;
@@ -1336,7 +1344,12 @@ declare class SDK {
1336
1344
  }[];
1337
1345
  private destroyCompositions;
1338
1346
  /**
1339
- * @description 导出，支持导出媒体或其他，如MP4，未来支持 JSON 等；
1347
+ * @description 以媒体格式 buffer 下载
1348
+ */
1349
+ downloadByMediaBuffersOfExporter(params: ExportMediaItemDownloadInfo[], buffers: Buffers, extras: Extras): void;
1350
+ /**
1351
+ * @description 导出
1352
+ * 支持导出媒体或其他，如MP4，未来支持 JSON 等；
1340
1353
  */
1341
1354
  onExport(): void;
1342
1355
  /**