@cesdk/engine 1.8.0-alpha.2 → 1.8.0-alpha.5

package/index.d.ts

@@ -93,6 +93,7 @@ export declare class AssetAPI {
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
     defaultApplyAsset(assetResult: AssetResult): Promise<void>;
+
 }
 
 /**
@@ -359,6 +360,16 @@ declare interface AssetsQueryResult_2 {
  */
 export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'Lighten' | 'Screen' | 'ColorDodge' | 'Overlay' | 'SoftLight' | 'HardLight' | 'Difference' | 'Exclusion' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
 
+/**
+ * Holds Channels for the different properties of a block.
+ * Ensures that for each property, only one channel exists.
+ * @public
+ */
+export declare class Block extends Entity {
+    effects: ReadWriteChannelSync<number[]>;
+
+}
+
 /**
  * @public
  */
@@ -374,6 +385,18 @@ export declare class BlockAPI {
      * @returns A promise that resolves with the exported image or is rejected with an error.
      */
     export(handle: DesignBlockId, mimeType?: MimeType_2, options?: ExportOptions): Promise<Blob>;
+    /**
+     * Exports a design block element as a file of the given mime type.
+     * Performs an internal update to resolve the final layout for the blocks.
+     * @param handle - The design block element to export.
+     * @param mimeType - The mime type of the output file.
+     * @param maskColorR - The red component of the special color mask color.
+     * @param maskColorG - The green component of the special color mask color.
+     * @param maskColorB - The blue component of the special color mask color.
+     * @param options - The options for exporting the block type
+     * @returns A promise that resolves with an array of the exported image and mask or is rejected with an error.
+     */
+    exportWithColorMask(handle: DesignBlockId, mimeType: MimeType_2 | undefined, maskColorR: number, maskColorG: number, maskColorB: number, options?: ExportOptions): Promise<Blob[]>;
 
     /**
      * Loads existing blocks from the given string.
@@ -832,6 +855,20 @@ export declare class BlockAPI {
      * @returns The value of the property.
      */
     getFloat(id: DesignBlockId, property: string): number;
+    /**
+     * Set a double property of the given design block to the given value.
+     * @param id - The block whose property should be set.
+     * @param property - The name of the property to set.
+     * @param value - The value to set.
+     */
+    setDouble(id: DesignBlockId, property: string, value: number): void;
+    /**
+     * Get the value of a double property of the given design block.
+     * @param id - The block whose property should be queried.
+     * @param property - The name of the property to query.
+     * @returns The value of the property.
+     */
+    getDouble(id: DesignBlockId, property: string): number;
     /**
      * Set a string property of the given design block to the given value.
      * @param id - The block whose property should be set.
@@ -967,6 +1004,16 @@ export declare class BlockAPI {
      * @param minScaleRatio - The minimal crop scale ratio to go down to.
      */
     adjustCropToFillFrame(id: DesignBlockId, minScaleRatio: number): number;
+    /**
+     * Adjusts the crop in order to flip the content along its own horizontal axis.
+     * @param block - The block whose crop should be updated.
+     */
+    flipCropHorizontal(id: DesignBlockId): void;
+    /**
+     * Adjusts the crop in order to flip the content along its own vertical axis.
+     * @param block - The block whose crop should be updated.
+     */
+    flipCropVertical(id: DesignBlockId): void;
     /**
      * Query if the given block has an opacity.
      * @param id - The block to query.
@@ -1578,6 +1625,13 @@ export declare class BlockAPI {
      * @returns whether the key exists.
      */
     hasMetadata(id: DesignBlockId, key: string): boolean;
+    /**
+     * Query all metadata keys that exist on this block.
+     * @param id - The block whose metadata will be accessed.
+     * @returns A list of all metadata keys on this block or an error,
+     * if the block is invalid.
+     */
+    findAllMetadata(id: DesignBlockId): string[];
     /**
      * Remove metadata associated with the key from the given block.
      * If the key does not exist, this method will fail.
@@ -1606,6 +1660,141 @@ export declare class BlockAPI {
      * @returns whether the scope is allowed for the given block.
      */
     isAllowedByScope(id: DesignBlockId, key: string): boolean;
+    /**
+     * Returns whether the block has a duration property.
+     * @param id - The block to query.
+     * @returns true if the block has a duration property.
+     */
+    hasDuration(id: DesignBlockId): boolean;
+    /**
+     * Set the playback duration of the given block in seconds.
+     * The duration defines for how long the block is active in the scene during playback.
+     * The duration is ignored when the scene is not in "Video" mode.
+     * @param id - The block whose duration should be changed.
+     * @param duration - The new duration in seconds.
+     */
+    setDuration(id: DesignBlockId, duration: number): void;
+    /**
+     * Get the playback duration of the given block in seconds.
+     * @param id - The block whose duration should be returned.
+     * @returns The block's duration.
+     */
+    getDuration(id: DesignBlockId): number;
+    /**
+     * Returns whether the block has a time offset property.
+     * @param id - The block to query.
+     * @returns true, if the block has a time offset property.
+     */
+    hasTimeOffset(id: DesignBlockId): boolean;
+    /**
+     * Set the time offset of the given block in the scene.
+     * The time offset defines the point in time at which this block is first active in the scene.
+     * The time offset is not supported for page block or their children.
+     * @param id - The block whose time offset should be changed.
+     * @param offset - The new time offset in seconds.
+     */
+    setTimeOffset(id: DesignBlockId, offset: number): void;
+    /**
+     * Get the time offset of the given block in the scene.
+     * @param id - The block whose time offset should be queried.
+     * @returns the time offset of the block in the scene.
+     */
+    getTimeOffset(id: DesignBlockId): number;
+    /**
+     * Returns whether the block has trim properties.
+     * @param id - The block to query.
+     * @returns true, if the block has trim properties.
+     */
+    hasTrim(id: DesignBlockId): boolean;
+    /**
+     * Set the trim offset of the given block or fill.
+     * Sets the relative time within the fill at which playback of the audio or video clip should begin.
+     * This is a percentage value in the range [0, 1].
+     * @param id - The block whose trim should be updated.
+     * @param offset - The new trim offset.
+     */
+    setTrimOffset(id: DesignBlockId, offset: number): void;
+    /**
+     * Get the trim offset of this block.
+     * @param id - The block whose trim offset should be queried.
+     * @returns the trim offset.
+     */
+    getTrimOffset(id: DesignBlockId): number;
+    /**
+     * Set the trim length of the given block or fill.
+     * The trim length is the percentage of the audio or video clip that should be used for playback.
+     * @param id - The object whose trim length should be updated.
+     * @param length - The new trim length as a percentage of the clip duration in the range [0, 1].
+     */
+    setTrimLength(id: DesignBlockId, length: number): void;
+    /**
+     * Get the trim length of the given block or fill.
+     * @param id - The object whose trim length should be queried.
+     * @returns the trim length of the object.
+     */
+    getTrimLength(id: DesignBlockId): number;
+    /**
+     * Returns the total duration (in seconds) of a scene in video mode.
+     * The duration is defined by all blocks in the scene.
+     * @param scene - The scene whose duration is being queried.
+     * @returns the total scene duration.
+     */
+    getTotalSceneDuration(scene: DesignBlockId): number;
+    /**
+     * Set whether the block should be during active playback.
+     * @param id - The block that should be updated.
+     * @param enabled - Whether the block should be playing its contents.
+     */
+    setPlaying(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Returns whether the block is currently during active playback.
+     * @param id - The block to query.
+     * @returns whether the block is during playback.
+     */
+    isPlaying(id: DesignBlockId): boolean;
+    /**
+     * Returns whether the block has a playback time property.
+     * @param id - The block to query.
+     * @returns whether the block has a playback time property.
+     */
+    hasPlaybackTime(id: DesignBlockId): boolean;
+    /**
+     * Set the playback time of the given block.
+     * @param id - The block whose playback time should be updated.
+     * @param time - The new playback time of the block in seconds.
+     */
+    setPlaybackTime(id: DesignBlockId, time: number): void;
+    /**
+     * Get the playback time of the given block.
+     * @param id - The block to query.
+     * @returns the playback time of the block in seconds.
+     */
+    getPlaybackTime(id: DesignBlockId): number;
+    /**
+     * Set whether the given block or fill should play
+     * its contents while the rest of the scene remains paused.
+     * Setting this to true for one block will automatically set
+     * it to false on all other blocks.
+     * @param id - The block or fill to update.
+     * @param enabled - Whether the block's playback should progress as time moves on.
+     */
+    setSoloPlaybackEnabled(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Return whether the given block or fill is currently set to play
+     * its contents while the rest of the scene remains paused.
+     * @param id - The block or fill to query.
+     * @returns Whether solo playback is enabled for this block.
+     */
+    isSoloPlaybackEnabled(id: DesignBlockId): boolean;
+}
+
+/**
+ * This maintains a list of Blocks, ensuring that only one Block instance
+ * exists per id.
+ * @public
+ */
+export declare class BlockChannels extends EntityChannels<Block> {
+    getBlock(id: number): Block;
 }
 
 /** @public */
@@ -1632,6 +1821,33 @@ declare type Callbacks = {
     log?: Logger;
 };
 
+/**
+ * A Channel represents a reactive data source consisting of three elements:
+ *
+ * * A `subscribe` method to register a callback for values coming from the
+ *   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.
+ * @public
+ */
+export declare interface Channel<Out, In = Out> {
+    subscribe: Source<Out>;
+    update?: (v: In) => void;
+    value?: () => Out;
+}
+
+/**
+ * A {@link Channel} that is guaranteed to have a `value`
+ * @public
+ */
+export declare interface ChannelSync<Out, In = Out> extends Channel<Out, In> {
+    subscribe: Source<Out>;
+    update?: (v: In) => void;
+    value: () => Out;
+}
+
 /**
  * All components between 0 and 1
  * @public
@@ -1997,6 +2213,48 @@ export declare class EditorAPI {
     getGlobalScope(key: string): 'Allow' | 'Deny' | 'Defer';
 }
 
+/**
+ * Holds Channels for the different properties of an effect.
+ * Ensures that for each property, only one channel exists.
+ * @public
+ */
+export declare class Effect extends Entity {
+    enabled: ReadWriteChannelSync<boolean>;
+
+}
+
+/**
+ * This maintains a list of Effects, ensuring that only one Block instance
+ * exists per id.
+ * @public
+ */
+export declare class EffectChannels extends EntityChannels<Effect> {
+    getEffect(id: number): Effect;
+}
+
+/**
+ * @public
+ */
+export declare class Entity {
+    #private;
+
+
+
+    get id(): number;
+    Int(property: string): ReadWriteChannelSync<number>;
+    Float(property: string): ReadWriteChannelSync<number>;
+}
+
+/** @public */
+export declare class EntityChannels<T extends Entity> {
+    #private;
+
+
+
+    constant<V>(constantValue: V): ReadWriteChannelSync<V>;
+    dispose(): void;
+}
+
 /**
  * @public
  */
@@ -2140,6 +2398,12 @@ export declare type GradientType = 'Linear' | 'Radial' | 'Conical';
  */
 declare type Groups = string[];
 
+/**
+ * Will be called by a stream whenever a new value is available.
+ * @public
+ */
+declare type Handler<T> = (v: T) => void;
+
 /**
  * A hexadecimal color value (RGB or RGBA) that starts with a '#'
  * @example #6686FF or #6686FFFF
@@ -2162,6 +2426,7 @@ export declare class HTMLCreativeEngineCanvasElement extends HTMLElement {
     connectedCallback(): void;
     disconnectedCallback(): void;
 
+
 }
 
 /** @public */
@@ -2273,7 +2538,7 @@ declare type Presets = {
 };
 
 /** @public */
-export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct';
+export declare type PropertyType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color' | 'Enum' | 'Struct' | 'Double';
 
 /** @public */
 declare interface QueryData {
@@ -2290,6 +2555,26 @@ declare interface QueryData {
     page: number;
 }
 
+/**
+ * A {@link Channel} that is guaranteed to have an `update` method.
+ * @public
+ */
+export declare interface ReadWriteChannel<Out, In = Out> extends Channel<Out, In> {
+    subscribe: Source<Out>;
+    update: (v: In) => void;
+    value?: () => Out;
+}
+
+/**
+ * A {@link ReadWriteChannel} that is guaranteed to have a `value`
+ * @public
+ */
+export declare interface ReadWriteChannelSync<Out, In = Out> extends ChannelSync<Out, In>, ReadWriteChannel<Out, In> {
+    subscribe: Source<Out>;
+    update: (v: In) => void;
+    value: () => Out;
+}
+
 /**
  * Dispatched on the engine canvas right before the engine will refocus its text
  * input after a blur. Call `preventDefault()` to prevent the refocusing.
@@ -2337,7 +2622,6 @@ export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
  * @public
  */
 declare type Scene = {
-    maskSpotColor?: SpotColor;
     /**
      * 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).
@@ -2479,6 +2763,17 @@ export declare interface Size2 {
  */
 export declare type SizeMode = 'Absolute' | 'Percent' | 'Auto';
 
+/**
+ * A stream source.
+ *
+ * This is an ordinary function. Pass a handler to have that handler called by
+ * the source whenever a new value is available.
+ *
+ * Returns a function that unsubscribes the handler from the source
+ * @public
+ */
+declare type Source<T> = (handler: Handler<T>) => UnsubscribeFn;
+
 /** @public */
 export declare interface SpotColor {
     name: string;
@@ -2515,6 +2810,12 @@ declare type TypefaceDefinition = Preset & {
     }[];
 };
 
+/**
+ * Invoke to unsubscribe from a stream.
+ * @public
+ */
+declare type UnsubscribeFn = () => void;
+
 /**
  * @public
  */