@pacem/pacem-media 1.0.0-bessel → 1.0.0-dirac

package/dist/esm/audio.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -11,6 +11,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { P, CustomElement, PacemEventTarget, Watch, PropertyConverters } from '@pacem/pacem-core';
 //namespace Pacem.Components.Media {
+/** Wraps a native `HTMLAudioElement`, exposing playback control and its readiness/lifecycle as reactive properties and events. */
 let PacemAudioElement = class PacemAudioElement extends PacemEventTarget {
     constructor() {
         super(...arguments);
@@ -60,6 +61,10 @@ let PacemAudioElement = class PacemAudioElement extends PacemEventTarget {
         a.removeEventListener('canplay', this._canPlayHandler, false);
         super.disconnectedCallback();
     }
+    /**
+     * Starts (or resumes) playback of the underlying `<audio>` element, dispatching a `start` event on success or an `error` event on failure.
+     * @returns A promise that resolves once playback has started, or rejects with `'disabled'` if the element is disabled.
+     */
     play() {
         // sudden exit when disabled
         if (this.disabled) {
@@ -71,9 +76,11 @@ let PacemAudioElement = class PacemAudioElement extends PacemEventTarget {
             this.dispatchEvent(new CustomEvent('error', { detail: e }));
         });
     }
+    /** Pauses playback. */
     pause() {
         this.#audio.pause();
     }
+    /** Reloads the underlying `<audio>` element, resetting its playback state. */
     reset() {
         this.#audio.load();
     }

package/dist/esm/index-components-media.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-components.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-iife.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/media-recorder.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-media v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-media v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -22,6 +22,7 @@ function isStream(obj) {
     }
     return 'captureStream' in obj && typeof obj['captureStream'] === 'function';
 }
+/** Wraps the native `MediaRecorder` API, capturing audio/video from a canvas, media element or media stream into a `Blob`. */
 let PacemMediaRecorderElement = class PacemMediaRecorderElement extends PacemEventTarget {
     constructor() {
         super(...arguments);
@@ -102,29 +103,34 @@ let PacemMediaRecorderElement = class PacemMediaRecorderElement extends PacemEve
             this.#recorder = null;
         }
     }
+    /** Concatenates the buffered data chunks recorded so far into a single `Blob` and assigns it to `output`, clearing the buffer. */
     flush() {
         const blob = new Blob(this.#chunks, { 'type': this.mimeType || DEFAULT_MIMETYPE });
         this.#chunks = [];
         this.output = blob;
     }
+    /** Starts recording, if the underlying recorder is currently inactive. */
     start() {
         const r = this.#recorder;
         if (!Utils.isNull(r) && r.state === 'inactive') {
             r.start();
         }
     }
+    /** Stops recording, if the underlying recorder is not already inactive. */
     stop() {
         const r = this.#recorder;
         if (!Utils.isNull(r) && r.state !== 'inactive') {
             r.stop();
         }
     }
+    /** Resumes a paused recording. */
     resume() {
         const r = this.#recorder;
         if (!Utils.isNull(r) && r.state === 'paused') {
             r.start();
         }
     }
+    /** Pauses an ongoing recording. */
     pause() {
         const r = this.#recorder;
         if (!Utils.isNull(r) && r.state !== 'paused') {

package/package.json

@@ -4,6 +4,7 @@
     "dist/browser/*.*",
     "dist/bundle/*.*",
     "dist/esm/*.*",
+    "dist/docs/*.*",
     "typings/*.*",
     "README.md",
     "LICENSE",
@@ -24,7 +25,7 @@
       "types": "./typings/index.d.ts"
     }
   },
-  "version": "1.0.0-bessel",
+  "version": "1.0.0-dirac",
   "author": {
     "name": "Pacem",
     "url": "https://pacem.it"

package/typings/index.d.ts

@@ -13,17 +13,27 @@ export declare namespace Media {
     }
 }
 
+/** Wraps a native `HTMLAudioElement`, exposing playback control and its readiness/lifecycle as reactive properties and events. */
 declare class PacemAudioElement extends PacemEventTarget {
     #private;
+    /** Gets or sets the media source URL for the underlying `<audio>` element. */
     src: string;
+    /** Gets or sets whether the source is a live stream (playback is considered ready as soon as it *can* play, rather than waiting for it to play through). */
     stream: boolean;
+    /** Gets or sets whether playback should start automatically as soon as the media is ready. */
     autoplay: boolean;
     connectedCallback(): void;
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
     viewActivatedCallback(): void;
     disconnectedCallback(): void;
+    /**
+     * Starts (or resumes) playback of the underlying `<audio>` element, dispatching a `start` event on success or an `error` event on failure.
+     * @returns A promise that resolves once playback has started, or rejects with `'disabled'` if the element is disabled.
+     */
     play(): Promise<void>;
+    /** Pauses playback. */
     pause(): void;
+    /** Reloads the underlying `<audio>` element, resetting its playback state. */
     reset(): void;
     private get _canPlay();
     private _endedHandler;
@@ -33,14 +43,22 @@ declare class PacemAudioElement extends PacemEventTarget {
     private _init;
 }
 
+/** Wraps the native `MediaRecorder` API, capturing audio/video from a canvas, media element or media stream into a `Blob`. */
 declare class PacemMediaRecorderElement extends PacemEventTarget {
     #private;
+    /** Gets or sets the source to record: a `HTMLCanvasElement` (captured via `captureStream`), a `HTMLMediaElement`, or a `MediaStream`. */
     source: HTMLCanvasElement | HTMLMediaElement | MediaStream;
+    /** Gets or sets the frame rate (frames per second) used when capturing a stream from a canvas source. */
     fps: number;
+    /** Gets or sets the MIME type used to encode the recorded output. */
     mimeType: string;
+    /** Gets or sets the target audio bitrate, in bits per second. */
     audioBitsPerSecond: number;
+    /** Gets or sets the target video bitrate, in bits per second. */
     videoBitsPerSecond: number;
+    /** @readonly Gets the current state of the underlying `MediaRecorder` (`'inactive'`, `'recording'` or `'paused'`). */
     state: RecordingState;
+    /** @readonly Gets the recorded output as a `Blob`, populated whenever the buffered chunks are flushed (typically on `stop`). */
     output: Blob;
     viewActivatedCallback(): void;
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
@@ -48,10 +66,15 @@ declare class PacemMediaRecorderElement extends PacemEventTarget {
     private _recorderLifecycleHandler;
     private _setupMediaRecorder;
     private _closeMediaRecorder;
+    /** Concatenates the buffered data chunks recorded so far into a single `Blob` and assigns it to `output`, clearing the buffer. */
     flush(): void;
+    /** Starts recording, if the underlying recorder is currently inactive. */
     start(): void;
+    /** Stops recording, if the underlying recorder is not already inactive. */
     stop(): void;
+    /** Resumes a paused recording. */
     resume(): void;
+    /** Pauses an ongoing recording. */
     pause(): void;
 }