@cesdk/engine 1.29.0 → 1.30.0-rc.0

package/index.d.ts

@@ -391,6 +391,36 @@ export declare interface AssetsQueryResult<T extends AssetResult = AssetResult>
 
 declare type _AssetsQueryResult = AssetsQueryResult;
 
+/**
+ * @public
+ */
+export declare type AudioExportOptions = {
+    /**
+     * The time offset in seconds relative to the target block.
+     *
+     * @defaultValue 0
+     */
+    timeOffset?: number;
+    /**
+     * The duration in seconds of the final audio.
+     *
+     * @defaultValue The duration of the block.
+     */
+    duration?: number;
+    /**
+     * The sample rate of the exported audio.
+     *
+     * @defaultValue 48000
+     */
+    sampleRate?: number;
+    /**
+     * The number of channels of the exported audio.
+     *
+     * @defaultValue 2
+     */
+    numberOfChannels?: number;
+};
+
 /**
  * @public
  */
@@ -429,10 +459,19 @@ export declare class BlockAPI {
      * @param handle - The design block element to export. Currently, only page blocks are supported.
      * @param mimeType - The mime type of the output video file.
      * @param progressCallback - A callback which reports on the progress of the export. It informs the receiver of the current frame index, which currently gets exported and the total frame count.
-     * @param options - The options for exporting the video
-     * @returns A promise that resolves with video blob or is rejected with an error.
+     * @param options - The options for exporting the video.
+     * @returns A promise that resolves with a video blob or is rejected with an error.
      */
     exportVideo(handle: DesignBlockId, mimeType: MimeType_2 | undefined, progressCallback: (numberOfRenderedFrames: number, numberOfEncodedFrames: number, totalNumberOfFrames: number) => void, options: VideoExportOptions): Promise<Blob>;
+    /**
+     * Exports a design block as an audio file of the given mime type.
+     * @param handle - The design block element to export. Currently, only audio blocks are supported.
+     * @param mimeType - The mime type of the output audio file.
+     * @param progressCallback - A callback which reports on the progress of the export.
+     * @param options - The options for exporting the audio.
+     * @returns A promise that resolves with an audio blob or is rejected with an error.
+     */
+    unstable_exportAudio(handle: DesignBlockId, mimeType: MimeType_2 | undefined, progressCallback: (numberOfRenderedFrames: number, numberOfEncodedFrames: number, totalNumberOfFrames: number) => void, options: AudioExportOptions): Promise<Blob>;
     /**
      * Loads existing blocks from the given string.
      * The blocks are not attached by default and won't be visible until attached to a page or the scene.
@@ -3447,9 +3486,12 @@ export declare class EditorAPI {
      * This function can be called more than once. Subsequent calls will overwrite previous calls.
      * To remove a previously set resolver, pass the value `null`.
      * The given function must return an absolute path with a scheme.
-     * @param resolver - Custom resolution function.
+     * @param resolver - Custom resolution function. The resolution function
+     *                   should not reference variables outside of its scope.
+     *                   It receives the default URI resolver as its second argument
      */
-    setURIResolver(resolver: (URI: string) => string): void;
+    setURIResolver(resolver: (URI: string, defaultURIResolver: (URI: string) => string) => string): void;
+
     /**
      * This is the default implementation for the URI resolver.
      * It resolves the given path relative to the `basePath` setting.
@@ -3633,6 +3675,12 @@ export declare class EventAPI {
     subscribe: (blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void) => (() => void);
 }
 
+/** @public */
+declare interface ExportAudioOptions {
+    sampleRate: number;
+    numberOfChannels: number;
+}
+
 /**
  * @public
  */
@@ -3884,6 +3932,7 @@ declare enum MimeType_2 {
     Jpeg = "image/jpeg",
     WebP = "image/webp",
     Tga = "image/x-tga",
+    Wav = "audio/wav",
     Mp4 = "video/mp4",
     QuickTime = "video/quicktime",
     Binary = "application/octet-stream",
@@ -4343,7 +4392,7 @@ export declare type SceneMode = 'Design' | 'Video';
 export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
+export declare type SettingsBool = 'controlGizmo/showCropHandles' | 'controlGizmo/showCropScaleHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showScaleHandles' | 'doubleClickToCropEnabled' | 'features/singlePageModeEnabled' | 'features/pageCarouselEnabled' | 'mouse/enableScroll' | 'mouse/enableZoom' | 'checkScopesInAPIs' | 'page/dimOutOfPageAreas' | 'page/title/appendPageName' | 'page/title/show' | 'page/title/showOnSinglePage' | 'page/title/showPageTitleTemplate' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'showBuildVersion' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning';
 
 /** @public
  */