angry-pixel 2.0.12 → 2.0.14

package/lib/index.d.ts

@@ -1428,9 +1428,15 @@ type AnimationSlice = {
  * @category Components
  */
 interface AudioPlayerOptions {
+    /** The action to perform with the audio source. */
     action: AudioPlayerAction;
+    /** The audio source to play. */
     audioSource: HTMLAudioElement;
+    /** TRUE If the playback rate is fixed to the TimeManager time scale, default FALSE */
+    fixedToTimeScale: boolean;
+    /** TRUE If the audio source should loop. */
     loop: boolean;
+    /** The volume of the audio source. */
     volume: number;
 }
 /**
@@ -1438,14 +1444,34 @@ interface AudioPlayerOptions {
  * @category Components
  */
 declare class AudioPlayer {
+    /** The action to perform with the audio source. */
     action: AudioPlayerAction;
+    /** The audio source to play. */
     audioSource: HTMLAudioElement;
+    /** TRUE If the playback rate is fixed to the TimeManager time scale, default FALSE */
+    fixedToTimeScale: boolean;
+    /** TRUE If the audio source should loop. */
     loop: boolean;
+    /** READONLY, TRUE If the audio source is playing. */
     playing: boolean;
+    /** The volume of the audio source. */
     volume: number;
     /** @internal */
-    _currentAudio: string;
+    _currentAudioSrc: string;
+    _playPromisePendind: boolean;
     constructor(options?: Partial<AudioPlayerOptions>);
+    /**
+     * Play the audio source.
+     */
+    play(audioSource?: HTMLAudioElement): void;
+    /**
+     * Pause the audio source.
+     */
+    pause(): void;
+    /**
+     * Stop the audio source.
+     */
+    stop(): void;
 }
 /**
  * @public
@@ -2149,7 +2175,8 @@ interface RenderData {
  */
 declare enum MaskShape {
     Rectangle = 0,
-    Circumference = 1
+    Circumference = 1,
+    Polygon = 2
 }
 interface MaskRenderData extends RenderData {
     color: string;
@@ -2157,6 +2184,7 @@ interface MaskRenderData extends RenderData {
     width: number;
     height: number;
     radius: number;
+    vertices: Vector2[];
     rotation: number;
     opacity: number;
 }
@@ -2377,13 +2405,14 @@ interface MaskRendererOptions {
     width: number;
     height: number;
     radius: number;
+    vertexModel: Vector2[];
     offset: Vector2;
     rotation: number;
     opacity: number;
     layer: string;
 }
 /**
- * Renders a filled shape (rectangle or circumference)
+ * Renders a filled shape (rectangle, circumference or polygon)
  * @public
  * @category Components
  * @example
@@ -2406,16 +2435,27 @@ interface MaskRendererOptions {
  * maskRenderer.opacity  = 1;
  * maskRenderer.layer    = "Default";
  * ```
+ * @example
+ * ```js
+ * maskRenderer.shape       = MaskShape.Polygon;
+ * maskRenderer.vertexModel = [new Vector2(0, 0), new Vector2(32, 0), new Vector2(32, 32), new Vector2(0, 32)];
+ * maskRenderer.color       = "#000000";
+ * maskRenderer.offset      = new Vector2(0, 0);
+ * maskRenderer.opacity     = 1;
+ * maskRenderer.layer       = "Default";
+ * ```
  */
 declare class MaskRenderer {
-    /** Mask shape: Rectangle or Circumference */
+    /** Mask shape: Rectangle, Circumference or Polygon */
     shape: MaskShape;
-    /** Mask width in pixels */
+    /** Mask width in pixels (only for rectangle) */
     width: number;
-    /** Mask height in pixels */
+    /** Mask height in pixels (only for rectangle) */
     height: number;
     /** Mask radius in pixels (only for circumference) */
     radius: number;
+    /** Polygon vertices (only for polygon) */
+    vertexModel: Vector2[];
     /** The color of the mask */
     color: string;
     /** X-axis and Y-axis offset */
@@ -2709,23 +2749,23 @@ type Chunk = {
  * @category Components
  */
 interface VideoRendererOptions {
-    video: HTMLVideoElement;
-    width: number;
-    height: number;
-    offset: Vector2;
-    rotation: number;
+    action: "play" | "pause" | "stop";
+    fixedToTimeScale: boolean;
     flipHorizontally: boolean;
     flipVertically: boolean;
-    opacity: number;
+    height: number;
+    layer: string;
+    loop: boolean;
     maskColor: string;
     maskColorMix: number;
-    tintColor: string;
-    layer: string;
+    offset: Vector2;
+    opacity: number;
+    rotation: number;
     slice: Slice;
-    loop: boolean;
+    tintColor: string;
+    video: HTMLVideoElement;
     volume: number;
-    play: boolean;
-    pause: boolean;
+    width: number;
 }
 /**
  * The VideoRenderer component plays and renders a video element,
@@ -2749,48 +2789,63 @@ interface VideoRendererOptions {
  * videoRenderer.slice = {x: 0, y:0, width: 1920, height: 1080};
  * videoRenderer.volume = 1;
  * videoRenderer.loop = false;
- * videoRenderer.play = true;
- * videoRenderer.pause = false;
+ * videoRenderer.play();
  * ```
  */
 declare class VideoRenderer {
-    /**The video element to render */
-    video: HTMLVideoElement;
-    /** Overwrite the original video width */
-    width: number;
-    /** Overwrite the original video height */
-    height: number;
-    /** X-axis and Y-axis offset */
-    offset: Vector2;
-    /** Video rotation (degrees or radians) */
-    rotation: number;
+    /** The action to perform with the video */
+    action: "play" | "pause" | "stop";
+    /** TRUE If the playback rate is fixed to the TimeManager time scale, default FALSE */
+    fixedToTimeScale: boolean;
     /** Flip the video horizontally */
     flipHorizontally: boolean;
     /** Flip the video vertically */
     flipVertically: boolean;
-    /** Change the opacity between 1 and 0 */
-    opacity: number;
+    /** Overwrite the original video height */
+    height: number;
+    /** The render layer */
+    layer: string;
+    /** TRUE to play the video in loop */
+    loop: boolean;
     /** Define a mask color for the video */
     maskColor: string;
     /** Define the opacity of the mask color between 1 and 0 */
     maskColorMix: number;
-    /** Define a color for tinting the video */
-    tintColor: string;
-    /** The render layer */
-    layer: string;
+    /** X-axis and Y-axis offset */
+    offset: Vector2;
+    /** Change the opacity between 1 and 0 */
+    opacity: number;
+    /** READONLY, TRUE if the video is playing */
+    playing: boolean;
+    /** Video rotation (degrees or radians) */
+    rotation: number;
     /** Cut the video based on straight coordinates starting from the top left downward */
     slice?: Slice;
-    /** TRUE to play the video in loop */
-    loop: boolean;
+    /** Define a color for tinting the video */
+    tintColor: string;
+    /**The video element to render */
+    video: HTMLVideoElement;
     /** The volume of the video (between 1 and 0) */
     volume: number;
-    /** TRUE to play the video. If the video stops playing it becomes FALSE */
-    play: boolean;
-    /** TRUE to pause the video */
-    pause: boolean;
+    /** Overwrite the original video width */
+    width: number;
+    _currentVideoSrc: string;
+    _playPromisePendind: boolean;
     /** @internal */
     _renderData: VideoRenderData;
     constructor(options?: Partial<VideoRendererOptions>);
+    /**
+     * Play the video source.
+     */
+    play(videoSource?: HTMLVideoElement): void;
+    /**
+     * Pause the video source.
+     */
+    pause(): void;
+    /**
+     * Stop the video source.
+     */
+    stop(): void;
 }
 
 /**