@cesdk/engine 1.9.1 → 1.10.0-preview.0

package/index.d.ts

@@ -6,21 +6,24 @@
  */
 export declare interface Asset {
     /**
-     *  Is a combination of source id, extension pack id (optional), type and asset id
-     *  e.g. "extension://ly.img.cesdk.images.samples/ly.img.image/sample.1"
+     * The unique id of this asset.
      */
     id: string;
-    /**   E.g. `ly.img.image` */
     /**  Groups of the asset.  */
     groups?: Groups;
-    /** URI to a thumbnail of the asset used e.g. in the content library UI */
-    thumbUri: string;
-
     /** Asset-specific and custom meta information */
     meta?: {
+        /** The mime type of this asset or the data behind the asset's uri. */
+        mimeType?: string;
+        /** The type id of the design block that should be created from this asset. */
+        blockType?: string;
         uri?: string;
+        thumbUri?: string;
+        previewUri?: string;
         filename?: string;
         vectorPath?: string;
+        width?: number;
+        height?: number;
         duration?: string;
     } & Record<string, unknown>;
 }
@@ -36,6 +39,16 @@ export declare class AssetAPI {
      * @param source - The asset source.
      */
     addSource(source: AssetSource): void;
+    /**
+     * Adds a local asset source. Its ID has to be unique.
+     * @param source - The asset source.
+     * @param supportedMimeTypes - The mime types of assets that are allowed to be added to this local source.
+     * @param applyAsset - An optional callback that can be used to override the default behavior of applying a given
+     * asset result to the active scene.
+     * @param applyAssetToBlock - An optional callback that can be used to override the default behavior of applying
+     * an asset result to a given block.
+     */
+    addLocalSource(id: string, supportedMimeTypes?: string[], applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>, applyAssetToBlock?: (asset: AssetResult, block: DesignBlockId) => Promise<void>): void;
     /**
      * Removes an asset source with the given ID.
      * @param id - The ID to refer to the asset source.
@@ -59,6 +72,7 @@ export declare class AssetAPI {
      * @returns The asset groups.
      */
     getGroups(id: string): Promise<string[]>;
+    getSupportedMimeTypes(sourceId: string): string[];
     /**
      * Queries the asset source's credits info.
      * @param sourceId - The ID of the asset source.
@@ -78,8 +92,18 @@ export declare class AssetAPI {
         url: string | undefined;
     } | undefined;
     canManageAssets(sourceId: string): boolean;
-
-
+    /**
+     * Adds the given asset to a local asset source.
+     * @param sourceId - The local asset source ID that the asset should be added to.
+     * @param asset - The asset to be added to the asset source.
+     */
+    addAssetToSource(sourceId: string, asset: AssetDefinition): void;
+    /**
+     * Removes the specified asset from its local asset source.
+     * @param sourceId - The id of the local asset source that currently contains the asset.
+     * @param assetId - The id of the asset to be removed.
+     */
+    removeAssetFromSource(sourceId: string, assetId: string): void;
 
 
     /**
@@ -89,7 +113,7 @@ export declare class AssetAPI {
      * @param sourceId - The ID of the asset source.
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
-    apply(sourceId: string, assetResult: AssetResult): Promise<void>;
+    apply(sourceId: string, assetResult: AssetResult): Promise<DesignBlockId | undefined>;
     /**
      * Apply an asset result to the given block.
      * @param sourceId - The ID of the asset source.
@@ -102,7 +126,7 @@ export declare class AssetAPI {
      * This implementation is used when no `applyAsset` function is provided to `addSource`.
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
-    defaultApplyAsset(assetResult: AssetResult): Promise<void>;
+    defaultApplyAsset(assetResult: AssetResult): Promise<DesignBlockId | undefined>;
     /**
      * The default implementation for applying an asset to an existing block.
      * @param assetResult - A single assetResult of a `findAssets` query.
@@ -113,7 +137,7 @@ export declare class AssetAPI {
 }
 
 /**
- * Definition of an assets used if an asset is added to an asset source.
+ * Definition of an asset used if an asset is added to an asset source.
  * @public
  */
 export declare interface AssetDefinition extends Asset {
@@ -197,13 +221,6 @@ export declare interface AssetResult extends Asset {
 declare interface AssetResult_2 {
     /** A unique id of this asset */
     id: string;
-    /** URI to a thumbnail of the asset used e.g. in the content library UI */
-    thumbUri: string;
-    /** Original size of the asset. */
-    size: {
-        width: number;
-        height: number;
-    };
     /** Asset-specific and custom meta information */
     meta?: {
         uri?: string;
@@ -271,16 +288,17 @@ export declare interface AssetSource {
      */
     getAsset?(id: string): Promise<AssetResult | undefined>;
     /**
-     * Can the source add, update and remove assets dynamically? If `false`
-     * methods like `addAsset` `updateAsset` and `removeAsset` will throw an
+     * Can the source add and remove assets dynamically? If `false`
+     * methods like `addAsset` and `removeAsset` will throw an
      * error.
      */
     canManageAssets?: boolean;
     /**
      * Apply the given asset result to the active scene.
      * You can override this with custom behavior.
+     * @returns the id of a new block if one was created from the asset.
      */
-    applyAsset?: (asset: AssetResult) => Promise<void>;
+    applyAsset?: (asset: AssetResult) => Promise<DesignBlockId | undefined>;
     /**
      * Apply the given asset result to the given block.
      * You can override this with custom behavior.
@@ -290,16 +308,8 @@ export declare interface AssetSource {
      * Adds the given asset to this source. Throws an error if `canManageAssets`
      * is `false`.
      *
-     * @returns the id of the added asset
-     */
-    addAsset?(asset: AssetDefinition): Promise<string>;
-    /**
-     * Updates the asset of this source. Throws an error if `canManageAssets`
-     * is `false` or no asset with the given id could not be found.
-     *
-     * @returns the id of the added asset
      */
-    updateAsset?(assetId: string, asset: AssetDefinition): Promise<void>;
+    addAsset?(asset: AssetDefinition): void;
     /**
      * Removes the given asset from this source.
      *
@@ -325,7 +335,7 @@ declare interface AssetSource_2 {
      * Apply the given asset result to the active scene.
      * You can override this with custom behavior.
      */
-    applyAsset?: (asset: AssetResult_2) => Promise<void>;
+    applyAsset?: (asset: AssetResult_2) => Promise<DesignBlockId | undefined>;
     /**
      * Apply the given asset result to the given block.
      * You can override this with custom behavior.
@@ -417,20 +427,36 @@ export declare class Block extends Entity {
     playing: ReadWriteChannelSync<boolean>;
     playbackTime: ReadWriteChannelSync<number>;
     selection: ReadWriteChannelSync<boolean>;
-    sceneMode: ReadWriteChannelSync<SceneMode>;
     duration: ReadWriteChannelSync<number>;
-    totalSceneDuration: ReadWriteChannelSync<number>;
     name: ReadWriteChannelSync<string>;
-    audioMuted: ReadWriteChannelSync<boolean>;
-    videoMuted: ReadWriteChannelSync<boolean>;
     avResourceTotalDuration: ReadWriteChannelSync<number>;
     timeOffset: ReadWriteChannelSync<number>;
     cropTranslationX: ReadWriteChannelSync<number>;
     cropTranslationY: ReadWriteChannelSync<number>;
     cropTranslation: ReadWriteChannelSync<Vec2>;
+    cropScaleRatio: ReadWriteChannelSync<number>;
+    cropRotation: ReadWriteChannelSync<number>;
+    cropScaleX: ReadWriteChannelSync<number>;
+    cropScaleY: ReadWriteChannelSync<number>;
     width: ReadWriteChannelSync<number>;
     height: ReadWriteChannelSync<number>;
     dimensions: ReadWriteChannelSync<Vec2>;
+    contentFillMode: ReadWriteChannelSync<ContentFillMode>;
+    designStyleScope: ReadWriteChannelSync<boolean>;
+    designArrangeScope: ReadWriteChannelSync<boolean>;
+    designArrangeScopeMove: ReadWriteChannelSync<boolean>;
+    designArrangeScopeResize: ReadWriteChannelSync<boolean>;
+    designArrangeScopeRotate: ReadWriteChannelSync<boolean>;
+    designArrangeScopeFlip: ReadWriteChannelSync<boolean>;
+    contentReplaceScope: ReadWriteChannelSync<boolean>;
+    lifecycleDestroyScope: ReadWriteChannelSync<boolean>;
+    lifecycleDuplicateScope: ReadWriteChannelSync<boolean>;
+    editorAddScope: ReadWriteChannelSync<boolean>;
+    editorInspectScope: ReadWriteChannelSync<boolean>;
+    editorPresentScope: ReadWriteChannelSync<boolean>;
+    editorManagePagesScope: ReadWriteChannelSync<boolean>;
+    editorSelectScope: ReadWriteChannelSync<boolean>;
+    editorZoomScope: ReadWriteChannelSync<boolean>;
 
 
 }
@@ -479,6 +505,7 @@ export declare class BlockAPI {
     /**
      * 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.
+     * The UUID of the loaded blocks is replaced with a new one.
      * @param content - A string representing the given blocks.
      * @returns A promise that resolves with a list of handles representing the found blocks or an error.
      */
@@ -502,13 +529,17 @@ export declare class BlockAPI {
      * @returns The created fill's handle.
      */
     createFill(type: string): DesignBlockId;
-
     /**
      * Get the type of the given block, fails if the block is invalid.
      * @param id - The block to query.
      * @returns The blocks type.
      */
     getType(id: DesignBlockId): DesignBlockType;
+    /**
+     * Selects the given block and deselects all other blocks.
+     * @param id - The block to be selected.
+     */
+    select(id: DesignBlockId): void;
     /**
      * Update the selection state of a block.
      * Fails for invalid blocks.
@@ -773,15 +804,29 @@ export declare class BlockAPI {
      */
     setContentFillMode(id: DesignBlockId, mode: ContentFillMode): void;
     /**
-     * Get a block's layout width. The layout width is only available after an
-     * internal update loop, which may not happen immediately.
+     * Get a block's layout position on the x-axis. The position is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
+     * @param id - The block to query.
+     * @returns The layout position on the x-axis.
+     */
+    getFrameX(id: DesignBlockId): number;
+    /**
+     * Get a block's layout position on the y-axis. The position is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
+     * @param id - The block to query.
+     * @returns The layout position on the y-axis.
+     */
+    getFrameY(id: DesignBlockId): number;
+    /**
+     * Get a block's layout width. The width is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
      * @param id - The block to query.
      * @returns The layout width.
      */
     getFrameWidth(id: DesignBlockId): number;
     /**
-     * Get a block's layout height. The layout height is only available after an
-     * internal update loop, which may not happen immediately.
+     * Get a block's layout height. The height is only available after an
+     * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
      * @param id - The block to query.
      * @returns The layout height.
      */
@@ -1908,6 +1953,48 @@ export declare class BlockAPI {
      * @returns Whether solo playback is enabled for this block.
      */
     isSoloPlaybackEnabled(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block supports a playback control.
+     * @param block - The block to query.
+     * @returns Whether the block has playback control.
+     */
+    hasPlaybackControl(id: DesignBlockId): boolean;
+    /**
+     * Set whether the block should start from the beginning again or stop.
+     * @param block - The block or video fill to update.
+     * @param looping - Whether the block should loop to the beginning or stop.
+     */
+    setLooping(id: DesignBlockId, looping: boolean): void;
+    /**
+     * Query whether the block is looping.
+     * @param block - The block to query.
+     * @returns Whether the block is looping.
+     */
+    isLooping(id: DesignBlockId): boolean;
+    /**
+     * Set whether the audio of the block is muted.
+     * @param block - The block or video fill to update.
+     * @param muted - Whether the audio should be muted.
+     */
+    setMuted(id: DesignBlockId, muted: boolean): void;
+    /**
+     * Query whether the block is muted.
+     * @param block - The block to query.
+     * @returns Whether the block is muted.
+     */
+    isMuted(id: DesignBlockId): boolean;
+    /**
+     * Set the audio volume of the given block.
+     * @param block - The block or video fill to update.
+     * @param volume - The desired volume with a range of [0, 1].
+     */
+    setVolume(id: DesignBlockId, volume: number): void;
+    /**
+     * Get the audio volume of the given block.
+     * @param block - The block to query.
+     * @returns The volume with a range of [0, 1].
+     */
+    getVolume(id: DesignBlockId): number;
     /**
      * Begins loading the required audio and video resource for the given video fill or audio block.
      * @param id - The video fill or audio block whose resource should be loaded.
@@ -1987,8 +2074,7 @@ declare type Callbacks = {
  *   data source. Calling this method returns an `unsubscribe` method.
  * * An (optional) `update` method to update the data source
  * * An (optional) synchronous `value` method that can be used to retrieve
- *   the current value or a sensible initial value without waiting for a
- *   potentially asynchronous value coming through the stream.
+ *   the current value.
  * @public
  */
 export declare interface Channel<Out, In = Out> {
@@ -1998,7 +2084,7 @@ export declare interface Channel<Out, In = Out> {
 }
 
 /**
- * A {@link Channel} that is guaranteed to have a `value`
+ * A {@link Channel} that is guaranteed to have a `value` method
  * @public
  */
 export declare interface ChannelSync<Out, In = Out> extends Channel<Out, In> {
@@ -2056,7 +2142,7 @@ declare namespace ConfigTypes {
         Variables,
         Core,
         Extensions,
-        Scene,
+        Scene_2 as Scene,
         Page,
         Callbacks
     }
@@ -2378,6 +2464,16 @@ export declare class EditorAPI {
      * @returns The value as string.
      */
     getSettingEnum(keypath: string): string;
+    /**
+     * Get the currently available memory in bytes.
+     * @returns The currently available memory in bytes.
+     */
+    getAvailableMemory(): number;
+    /**
+     * Get the current memory usage of the engine in bytes.
+     * @returns The current memory usage in bytes.
+     */
+    getUsedMemory(): number;
     /**
      * Sets a custom URI resolver.
      * This function can be called more than once. Subsequent calls will overwrite previous calls.
@@ -2474,6 +2570,7 @@ export declare class Entity {
     get id(): number;
     Int(property: string): ReadWriteChannelSync<number>;
     Float(property: string): ReadWriteChannelSync<number>;
+    Bool(property: string): ReadWriteChannelSync<boolean>;
 }
 
 /** @public */
@@ -2482,7 +2579,6 @@ export declare class EntityChannels<T extends Entity> {
 
 
 
-    constant<V>(constantValue: V): ReadWriteChannelSync<V>;
     dispose(): void;
 }
 
@@ -2720,6 +2816,14 @@ declare type Page = {
     dimOutOfPageAreas?: boolean;
 };
 
+/** @public */
+export declare interface PageDuration {
+    pageId: DesignBlockId;
+    duration: number;
+    start: number;
+    end: number;
+}
+
 /** @public */
 declare type PageFormatDefinition = Preset & {
     width: number;
@@ -2799,7 +2903,7 @@ export declare interface ReadWriteChannel<Out, In = Out> extends Channel<Out, In
 }
 
 /**
- * A {@link ReadWriteChannel} that is guaranteed to have a `value`
+ * A {@link ReadWriteChannel} that is guaranteed to have a `value` and an `update` method
  * @public
  */
 export declare interface ReadWriteChannelSync<Out, In = Out> extends ChannelSync<Out, In>, ReadWriteChannel<Out, In> {
@@ -2850,11 +2954,31 @@ export declare interface RGBColor {
 /** @public */
 export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
 
+/**
+ * Contains channels for scene-specific information that are valid through
+ * scene changes.
+ * @public
+ */
+export declare class Scene {
+    constructor(ubq: UBQ, blockChannels: BlockChannels);
+    /**
+     * A channel containing the latest Block.
+     * Will emit an event when the scene changes
+     */
+    block: ChannelSync<Block | undefined>;
+    mode: ChannelSync<SceneMode | undefined>;
+    totalDuration: ChannelSync<number>;
+    pages: ChannelSync<DesignBlockId[]> & EngineChannel<DesignBlockId[]>;
+    playing: ReadWriteChannelSync<boolean>;
+    playbackTime: ReadWriteChannelSync<number>;
+    pageDurations: ChannelSync<PageDuration[]> & EngineChannel<PageDuration[]>;
+}
+
 /**
  * Export Settings
  * @public
  */
-declare type Scene = {
+declare type Scene_2 = {
     /**
      * The DPI value to use when exporting and when converting between pixels and inches or millimeter units.
      * (In the CESDK, this value is synonymous with PPI).
@@ -2954,6 +3078,11 @@ export declare class SceneAPI {
      * @returns The current mode of the scene.
      */
     getMode(): SceneMode;
+    /**
+     * Get the sorted list of pages in the scene.
+     * @returns The sorted list of pages in the scene.
+     */
+    getPages(): DesignBlockId[];
     /**
      * Sets the zoom level of the active scene.
      * Only has an effect if the zoom level is not handled by the UI.
@@ -3023,11 +3152,11 @@ export declare type SceneMode = 'Design' | 'Video';
 export declare class SelectionChannel implements ReadWriteChannelSync<number[]> {
     #private;
     subscribe: Source<number[]>;
+    update: (selectedDesignElements: number[]) => void;
+    value: () => number[];
 
     private deselectAll;
     private selectAll;
-    update: (selectedDesignElements: number[]) => void;
-    value: () => number[];
 }
 
 /** @public */
@@ -3180,11 +3309,10 @@ export declare interface Vec4 {
  * @public
  */
 export declare class ZoomLevelChannel implements ReadWriteChannelSync<number> {
-    #private;
     subscribe: Source<number>;
-
     update: (zoomLevel: number) => void;
     value: () => number;
+
 }
 
 export { }