@babylonjs/core 7.51.3 → 7.52.1

package/Audio/Interfaces/IAudioEngineOptions.d.ts

@@ -5,10 +5,12 @@
 export interface IAudioEngineOptions {
     /**
      * Specifies an existing Audio Context for the audio engine
+     * @deprecated Please use AudioEngineV2 instead
      */
     audioContext?: AudioContext;
     /**
      * Specifies a destination node for the audio engine
+     * @deprecated Please use AudioEngineV2 instead
      */
     audioDestination?: AudioDestinationNode | MediaStreamAudioDestinationNode;
 }

package/Audio/Interfaces/IAudioEngineOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAudioEngineOptions.js","sourceRoot":"","sources":["../../../../../dev/core/src/Audio/Interfaces/IAudioEngineOptions.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Interface used to define options for the Audio Engine\r\n * @since 5.0.0\r\n */\r\nexport interface IAudioEngineOptions {\r\n    /**\r\n     * Specifies an existing Audio Context for the audio engine\r\n     */\r\n    audioContext?: AudioContext;\r\n    /**\r\n     * Specifies a destination node for the audio engine\r\n     */\r\n    audioDestination?: AudioDestinationNode | MediaStreamAudioDestinationNode;\r\n}\r\n"]}
+{"version":3,"file":"IAudioEngineOptions.js","sourceRoot":"","sources":["../../../../../dev/core/src/Audio/Interfaces/IAudioEngineOptions.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Interface used to define options for the Audio Engine\r\n * @since 5.0.0\r\n */\r\nexport interface IAudioEngineOptions {\r\n    /**\r\n     * Specifies an existing Audio Context for the audio engine\r\n     * @deprecated Please use AudioEngineV2 instead\r\n     */\r\n    audioContext?: AudioContext;\r\n    /**\r\n     * Specifies a destination node for the audio engine\r\n     * @deprecated Please use AudioEngineV2 instead\r\n     */\r\n    audioDestination?: AudioDestinationNode | MediaStreamAudioDestinationNode;\r\n}\r\n"]}

package/AudioV2/abstractAudio/abstractAudioBus.d.ts

@@ -0,0 +1,22 @@
+import { AbstractNamedAudioNode } from "./abstractAudioNode";
+import type { AudioEngineV2 } from "./audioEngineV2";
+import type { _AbstractAudioSubGraph } from "./subNodes/abstractAudioSubGraph";
+/**
+ * Abstract class representing an audio bus with volume control.
+ *
+ * An audio bus is a node in the audio graph that can have multiple inputs and outputs. It is typically used to group
+ * sounds together and apply effects to them.
+ */
+export declare abstract class AbstractAudioBus extends AbstractNamedAudioNode {
+    protected abstract _subGraph: _AbstractAudioSubGraph;
+    protected constructor(name: string, engine: AudioEngineV2);
+    /**
+     * The output volume of the bus.
+     */
+    get volume(): number;
+    set volume(value: number);
+    /**
+     * Releases associated resources.
+     */
+    dispose(): void;
+}

package/AudioV2/abstractAudio/abstractAudioBus.js

@@ -0,0 +1,35 @@
+import { AbstractNamedAudioNode } from "./abstractAudioNode.js";
+import { _GetVolumeAudioProperty, _GetVolumeAudioSubNode } from "./subNodes/volumeAudioSubNode.js";
+/**
+ * Abstract class representing an audio bus with volume control.
+ *
+ * An audio bus is a node in the audio graph that can have multiple inputs and outputs. It is typically used to group
+ * sounds together and apply effects to them.
+ */
+export class AbstractAudioBus extends AbstractNamedAudioNode {
+    constructor(name, engine) {
+        super(name, engine, 3 /* AudioNodeType.HAS_INPUTS_AND_OUTPUTS */);
+    }
+    /**
+     * The output volume of the bus.
+     */
+    get volume() {
+        return _GetVolumeAudioProperty(this._subGraph, "volume");
+    }
+    set volume(value) {
+        // The volume subnode is created on initialization and should always exist.
+        const node = _GetVolumeAudioSubNode(this._subGraph);
+        if (!node) {
+            throw new Error("No volume subnode");
+        }
+        node.volume = value;
+    }
+    /**
+     * Releases associated resources.
+     */
+    dispose() {
+        super.dispose();
+        this._subGraph.dispose();
+    }
+}
+//# sourceMappingURL=abstractAudioBus.js.map

package/AudioV2/abstractAudio/abstractAudioBus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractAudioBus.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/abstractAudioBus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAiB,MAAM,qBAAqB,CAAC;AAG5E,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAEhG;;;;;GAKG;AACH,MAAM,OAAgB,gBAAiB,SAAQ,sBAAsB;IAGjE,YAAsB,IAAY,EAAE,MAAqB;QACrD,KAAK,CAAC,IAAI,EAAE,MAAM,+CAAuC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACb,OAAO,uBAAuB,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,MAAM,CAAC,KAAa;QAC3B,2EAA2E;QAC3E,MAAM,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;OAEG;IACa,OAAO;QACnB,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;CACJ","sourcesContent":["import { AbstractNamedAudioNode, AudioNodeType } from \"./abstractAudioNode\";\nimport type { AudioEngineV2 } from \"./audioEngineV2\";\nimport type { _AbstractAudioSubGraph } from \"./subNodes/abstractAudioSubGraph\";\nimport { _GetVolumeAudioProperty, _GetVolumeAudioSubNode } from \"./subNodes/volumeAudioSubNode\";\n\n/**\n * Abstract class representing an audio bus with volume control.\n *\n * An audio bus is a node in the audio graph that can have multiple inputs and outputs. It is typically used to group\n * sounds together and apply effects to them.\n */\nexport abstract class AbstractAudioBus extends AbstractNamedAudioNode {\n    protected abstract _subGraph: _AbstractAudioSubGraph;\n\n    protected constructor(name: string, engine: AudioEngineV2) {\n        super(name, engine, AudioNodeType.HAS_INPUTS_AND_OUTPUTS);\n    }\n\n    /**\n     * The output volume of the bus.\n     */\n    public get volume(): number {\n        return _GetVolumeAudioProperty(this._subGraph, \"volume\");\n    }\n\n    public set volume(value: number) {\n        // The volume subnode is created on initialization and should always exist.\n        const node = _GetVolumeAudioSubNode(this._subGraph);\n        if (!node) {\n            throw new Error(\"No volume subnode\");\n        }\n\n        node.volume = value;\n    }\n\n    /**\n     * Releases associated resources.\n     */\n    public override dispose(): void {\n        super.dispose();\n        this._subGraph.dispose();\n    }\n}\n"]}

package/AudioV2/abstractAudio/abstractAudioNode.d.ts

@@ -0,0 +1,99 @@
+import { Observable } from "../../Misc/observable";
+import type { AudioEngineV2 } from "./audioEngineV2";
+export declare enum AudioNodeType {
+    HAS_INPUTS = 1,
+    HAS_OUTPUTS = 2,
+    HAS_INPUTS_AND_OUTPUTS = 3
+}
+/**
+ * Abstract class for an audio node.
+ *
+ * An audio node is a processing unit that can receive audio data from an upstream node and/or send audio data to a
+ * downstream node.
+ *
+ * Nodes can be connected to other nodes to create an audio graph. The audio graph represents the flow of audio data.
+ *
+ * There are 3 types of audio nodes:
+ * 1. Input: Receives audio data from upstream nodes.
+ * 2. Output: Sends audio data to downstream nodes.
+ * 3. Input/Output: Receives audio data from upstream nodes and sends audio data to downstream nodes.
+ */
+export declare abstract class AbstractAudioNode {
+    /**
+     * The connected downstream audio nodes.
+     * - Undefined for input nodes.
+     */
+    protected readonly _downstreamNodes?: Set<AbstractAudioNode>;
+    /**
+     * The connected upstream audio nodes.
+     * - Undefined for output nodes.
+     */
+    protected readonly _upstreamNodes?: Set<AbstractAudioNode>;
+    /**
+     * The audio engine this node belongs to.
+     */
+    readonly engine: AudioEngineV2;
+    /**
+     * Observable for when the audio node is disposed.
+     */
+    readonly onDisposeObservable: Observable<AbstractAudioNode>;
+    protected constructor(engine: AudioEngineV2, nodeType: AudioNodeType);
+    /**
+     * Releases associated resources.
+     * - Triggers `onDisposeObservable`.
+     * @see {@link onDisposeObservable}
+     */
+    dispose(): void;
+    /**
+     * Gets a string identifying the name of the class
+     * @returns the class's name as a string
+     */
+    abstract getClassName(): string;
+    /**
+     * Connect to a downstream audio input node.
+     * @param node - The downstream audio input node to connect
+     * @returns `true` if the node is successfully connected; otherwise `false`
+     */
+    protected _connect(node: AbstractAudioNode): boolean;
+    /**
+     * Disconnects a downstream audio input node.
+     * @param node - The downstream audio input node to disconnect
+     * @returns `true` if the node is successfully disconnected; otherwise `false`
+     */
+    protected _disconnect(node: AbstractAudioNode): boolean;
+    /**
+     * Called when an upstream audio output node is connecting.
+     * @param node - The connecting upstream audio node
+     * @returns `true` if the node is successfully connected; otherwise `false`
+     */
+    private _onConnect;
+    /**
+     * Called when an upstream audio output node disconnects.
+     * @param node - The disconnecting upstream audio node
+     * @returns `true` if node is sucessfully disconnected; otherwise `false`
+     */
+    private _onDisconnect;
+}
+/**
+ * Abstract class for a named audio node.
+ */
+export declare abstract class AbstractNamedAudioNode extends AbstractAudioNode {
+    private _name;
+    /**
+     * Observable for when the audio node is renamed.
+     */
+    readonly onNameChangedObservable: Observable<{
+        newName: string;
+        oldName: string;
+        node: AbstractNamedAudioNode;
+    }>;
+    protected constructor(name: string, engine: AudioEngineV2, nodeType: AudioNodeType);
+    /**
+     * The name of the audio node.
+     * - Triggers `onNameChangedObservable` when changed.
+     * @see {@link onNameChangedObservable}
+     */
+    get name(): string;
+    set name(newName: string);
+    dispose(): void;
+}

package/AudioV2/abstractAudio/abstractAudioNode.js

@@ -0,0 +1,149 @@
+import { Observable } from "../../Misc/observable.js";
+export var AudioNodeType;
+(function (AudioNodeType) {
+    AudioNodeType[AudioNodeType["HAS_INPUTS"] = 1] = "HAS_INPUTS";
+    AudioNodeType[AudioNodeType["HAS_OUTPUTS"] = 2] = "HAS_OUTPUTS";
+    AudioNodeType[AudioNodeType["HAS_INPUTS_AND_OUTPUTS"] = 3] = "HAS_INPUTS_AND_OUTPUTS";
+})(AudioNodeType || (AudioNodeType = {}));
+/**
+ * Abstract class for an audio node.
+ *
+ * An audio node is a processing unit that can receive audio data from an upstream node and/or send audio data to a
+ * downstream node.
+ *
+ * Nodes can be connected to other nodes to create an audio graph. The audio graph represents the flow of audio data.
+ *
+ * There are 3 types of audio nodes:
+ * 1. Input: Receives audio data from upstream nodes.
+ * 2. Output: Sends audio data to downstream nodes.
+ * 3. Input/Output: Receives audio data from upstream nodes and sends audio data to downstream nodes.
+ */
+export class AbstractAudioNode {
+    constructor(engine, nodeType) {
+        /**
+         * Observable for when the audio node is disposed.
+         */
+        this.onDisposeObservable = new Observable();
+        this.engine = engine;
+        if (nodeType & 1 /* AudioNodeType.HAS_INPUTS */) {
+            this._upstreamNodes = new Set();
+        }
+        if (nodeType & 2 /* AudioNodeType.HAS_OUTPUTS */) {
+            this._downstreamNodes = new Set();
+        }
+    }
+    /**
+     * Releases associated resources.
+     * - Triggers `onDisposeObservable`.
+     * @see {@link onDisposeObservable}
+     */
+    dispose() {
+        if (this._downstreamNodes) {
+            for (const node of Array.from(this._downstreamNodes)) {
+                if (!this._disconnect(node)) {
+                    throw new Error("Disconnect failed");
+                }
+            }
+            this._downstreamNodes.clear();
+        }
+        if (this._upstreamNodes) {
+            for (const node of Array.from(this._upstreamNodes)) {
+                if (!node._disconnect(this)) {
+                    throw new Error("Disconnect failed");
+                }
+            }
+            this._upstreamNodes.clear();
+        }
+        this.onDisposeObservable.notifyObservers(this);
+        this.onDisposeObservable.clear();
+    }
+    /**
+     * Connect to a downstream audio input node.
+     * @param node - The downstream audio input node to connect
+     * @returns `true` if the node is successfully connected; otherwise `false`
+     */
+    _connect(node) {
+        if (!this._downstreamNodes) {
+            return false;
+        }
+        if (this._downstreamNodes.has(node)) {
+            return false;
+        }
+        if (!node._onConnect(this)) {
+            return false;
+        }
+        this._downstreamNodes.add(node);
+        return true;
+    }
+    /**
+     * Disconnects a downstream audio input node.
+     * @param node - The downstream audio input node to disconnect
+     * @returns `true` if the node is successfully disconnected; otherwise `false`
+     */
+    _disconnect(node) {
+        if (!this._downstreamNodes) {
+            return false;
+        }
+        if (!this._downstreamNodes.delete(node)) {
+            return false;
+        }
+        return node._onDisconnect(this);
+    }
+    /**
+     * Called when an upstream audio output node is connecting.
+     * @param node - The connecting upstream audio node
+     * @returns `true` if the node is successfully connected; otherwise `false`
+     */
+    _onConnect(node) {
+        if (!this._upstreamNodes) {
+            return false;
+        }
+        if (this._upstreamNodes.has(node)) {
+            return false;
+        }
+        this._upstreamNodes.add(node);
+        return true;
+    }
+    /**
+     * Called when an upstream audio output node disconnects.
+     * @param node - The disconnecting upstream audio node
+     * @returns `true` if node is sucessfully disconnected; otherwise `false`
+     */
+    _onDisconnect(node) {
+        return this._upstreamNodes?.delete(node) ?? false;
+    }
+}
+/**
+ * Abstract class for a named audio node.
+ */
+export class AbstractNamedAudioNode extends AbstractAudioNode {
+    constructor(name, engine, nodeType) {
+        super(engine, nodeType);
+        /**
+         * Observable for when the audio node is renamed.
+         */
+        this.onNameChangedObservable = new Observable();
+        this._name = name;
+    }
+    /**
+     * The name of the audio node.
+     * - Triggers `onNameChangedObservable` when changed.
+     * @see {@link onNameChangedObservable}
+     */
+    get name() {
+        return this._name;
+    }
+    set name(newName) {
+        if (this._name === newName) {
+            return;
+        }
+        const oldName = this._name;
+        this._name = newName;
+        this.onNameChangedObservable.notifyObservers({ newName, oldName, node: this });
+    }
+    dispose() {
+        super.dispose();
+        this.onNameChangedObservable.clear();
+    }
+}
+//# sourceMappingURL=abstractAudioNode.js.map

package/AudioV2/abstractAudio/abstractAudioNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractAudioNode.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/abstractAudioNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,MAAM,CAAN,IAAkB,aAIjB;AAJD,WAAkB,aAAa;IAC3B,6DAAc,CAAA;IACd,+DAAe,CAAA;IACf,qFAA0B,CAAA;AAC9B,CAAC,EAJiB,aAAa,KAAb,aAAa,QAI9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,iBAAiB;IAuBnC,YAAsB,MAAqB,EAAE,QAAuB;QALpE;;WAEG;QACa,wBAAmB,GAAG,IAAI,UAAU,EAAqB,CAAC;QAGtE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,QAAQ,mCAA2B,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAqB,CAAC;QACvD,CAAC;QAED,IAAI,QAAQ,oCAA4B,EAAE,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,EAAqB,CAAC;QACzD,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,OAAO;QACV,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACzC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAClC,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACzC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAQD;;;;OAIG;IACO,QAAQ,CAAC,IAAuB;QACtC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEhC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,IAAuB;QACzC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,IAAuB;QACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,IAAuB;QACzC,OAAO,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;IACtD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAgB,sBAAuB,SAAQ,iBAAiB;IAQlE,YAAsB,IAAY,EAAE,MAAqB,EAAE,QAAuB;QAC9E,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAN5B;;WAEG;QACa,4BAAuB,GAAG,IAAI,UAAU,EAAsE,CAAC;QAK3H,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAW,IAAI,CAAC,OAAe;QAC3B,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YACzB,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QAErB,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IAEe,OAAO;QACnB,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC;IACzC,CAAC;CACJ","sourcesContent":["import { Observable } from \"../../Misc/observable\";\nimport type { AudioEngineV2 } from \"./audioEngineV2\";\n\nexport const enum AudioNodeType {\n    HAS_INPUTS = 1,\n    HAS_OUTPUTS = 2,\n    HAS_INPUTS_AND_OUTPUTS = 3,\n}\n\n/**\n * Abstract class for an audio node.\n *\n * An audio node is a processing unit that can receive audio data from an upstream node and/or send audio data to a\n * downstream node.\n *\n * Nodes can be connected to other nodes to create an audio graph. The audio graph represents the flow of audio data.\n *\n * There are 3 types of audio nodes:\n * 1. Input: Receives audio data from upstream nodes.\n * 2. Output: Sends audio data to downstream nodes.\n * 3. Input/Output: Receives audio data from upstream nodes and sends audio data to downstream nodes.\n */\nexport abstract class AbstractAudioNode {\n    /**\n     * The connected downstream audio nodes.\n     * - Undefined for input nodes.\n     */\n    protected readonly _downstreamNodes?: Set<AbstractAudioNode>;\n\n    /**\n     * The connected upstream audio nodes.\n     * - Undefined for output nodes.\n     */\n    protected readonly _upstreamNodes?: Set<AbstractAudioNode>;\n\n    /**\n     * The audio engine this node belongs to.\n     */\n    public readonly engine: AudioEngineV2;\n\n    /**\n     * Observable for when the audio node is disposed.\n     */\n    public readonly onDisposeObservable = new Observable<AbstractAudioNode>();\n\n    protected constructor(engine: AudioEngineV2, nodeType: AudioNodeType) {\n        this.engine = engine;\n\n        if (nodeType & AudioNodeType.HAS_INPUTS) {\n            this._upstreamNodes = new Set<AbstractAudioNode>();\n        }\n\n        if (nodeType & AudioNodeType.HAS_OUTPUTS) {\n            this._downstreamNodes = new Set<AbstractAudioNode>();\n        }\n    }\n\n    /**\n     * Releases associated resources.\n     * - Triggers `onDisposeObservable`.\n     * @see {@link onDisposeObservable}\n     */\n    public dispose(): void {\n        if (this._downstreamNodes) {\n            for (const node of Array.from(this._downstreamNodes)) {\n                if (!this._disconnect(node)) {\n                    throw new Error(\"Disconnect failed\");\n                }\n            }\n            this._downstreamNodes.clear();\n        }\n\n        if (this._upstreamNodes) {\n            for (const node of Array.from(this._upstreamNodes)) {\n                if (!node._disconnect(this)) {\n                    throw new Error(\"Disconnect failed\");\n                }\n            }\n            this._upstreamNodes.clear();\n        }\n\n        this.onDisposeObservable.notifyObservers(this);\n        this.onDisposeObservable.clear();\n    }\n\n    /**\n     * Gets a string identifying the name of the class\n     * @returns the class's name as a string\n     */\n    public abstract getClassName(): string;\n\n    /**\n     * Connect to a downstream audio input node.\n     * @param node - The downstream audio input node to connect\n     * @returns `true` if the node is successfully connected; otherwise `false`\n     */\n    protected _connect(node: AbstractAudioNode): boolean {\n        if (!this._downstreamNodes) {\n            return false;\n        }\n\n        if (this._downstreamNodes.has(node)) {\n            return false;\n        }\n\n        if (!node._onConnect(this)) {\n            return false;\n        }\n\n        this._downstreamNodes.add(node);\n\n        return true;\n    }\n\n    /**\n     * Disconnects a downstream audio input node.\n     * @param node - The downstream audio input node to disconnect\n     * @returns `true` if the node is successfully disconnected; otherwise `false`\n     */\n    protected _disconnect(node: AbstractAudioNode): boolean {\n        if (!this._downstreamNodes) {\n            return false;\n        }\n\n        if (!this._downstreamNodes.delete(node)) {\n            return false;\n        }\n\n        return node._onDisconnect(this);\n    }\n\n    /**\n     * Called when an upstream audio output node is connecting.\n     * @param node - The connecting upstream audio node\n     * @returns `true` if the node is successfully connected; otherwise `false`\n     */\n    private _onConnect(node: AbstractAudioNode): boolean {\n        if (!this._upstreamNodes) {\n            return false;\n        }\n\n        if (this._upstreamNodes.has(node)) {\n            return false;\n        }\n\n        this._upstreamNodes.add(node);\n\n        return true;\n    }\n\n    /**\n     * Called when an upstream audio output node disconnects.\n     * @param node - The disconnecting upstream audio node\n     * @returns `true` if node is sucessfully disconnected; otherwise `false`\n     */\n    private _onDisconnect(node: AbstractAudioNode): boolean {\n        return this._upstreamNodes?.delete(node) ?? false;\n    }\n}\n\n/**\n * Abstract class for a named audio node.\n */\nexport abstract class AbstractNamedAudioNode extends AbstractAudioNode {\n    private _name: string;\n\n    /**\n     * Observable for when the audio node is renamed.\n     */\n    public readonly onNameChangedObservable = new Observable<{ newName: string; oldName: string; node: AbstractNamedAudioNode }>();\n\n    protected constructor(name: string, engine: AudioEngineV2, nodeType: AudioNodeType) {\n        super(engine, nodeType);\n\n        this._name = name;\n    }\n\n    /**\n     * The name of the audio node.\n     * - Triggers `onNameChangedObservable` when changed.\n     * @see {@link onNameChangedObservable}\n     */\n    public get name(): string {\n        return this._name;\n    }\n\n    public set name(newName: string) {\n        if (this._name === newName) {\n            return;\n        }\n\n        const oldName = this._name;\n\n        this._name = newName;\n\n        this.onNameChangedObservable.notifyObservers({ newName, oldName, node: this });\n    }\n\n    public override dispose(): void {\n        super.dispose();\n\n        this.onNameChangedObservable.clear();\n    }\n}\n"]}

package/AudioV2/abstractAudio/abstractSound.d.ts

@@ -0,0 +1,152 @@
+import { Observable } from "../../Misc/observable";
+import type { Nullable } from "../../types";
+import { SoundState } from "../soundState";
+import { AbstractNamedAudioNode } from "./abstractAudioNode";
+import type { _AbstractSoundInstance } from "./abstractSoundInstance";
+import type { PrimaryAudioBus } from "./audioBus";
+import type { AudioEngineV2 } from "./audioEngineV2";
+import type { _AbstractAudioSubGraph } from "./subNodes/abstractAudioSubGraph";
+import type { IVolumeAudioOptions } from "./subNodes/volumeAudioSubNode";
+import type { AbstractSpatialAudio, ISpatialAudioOptions } from "./subProperties/abstractSpatialAudio";
+import type { AbstractStereoAudio, IStereoAudioOptions } from "./subProperties/abstractStereoAudio";
+/** @internal */
+export interface IAbstractSoundOptionsBase {
+    /**
+     * Whether the sound should start playing automatically. Defaults to `false`.
+     */
+    autoplay: boolean;
+    /**
+     * The maximum number of instances that can play at the same time. Defaults to `Infinity`.
+     */
+    maxInstances: number;
+}
+/** @internal */
+export interface IAbstractSoundPlayOptionsBase {
+    /**
+     * Whether the sound should loop. Defaults to `false`.
+     */
+    loop: boolean;
+    /**
+     * The time within the sound buffer to start playing at, in seconds. Defaults to `0`.
+     */
+    startOffset: number;
+}
+/**
+ * Options for creating a sound.
+ */
+export interface IAbstractSoundOptions extends IAbstractSoundOptionsBase, IAbstractSoundPlayOptions, ISpatialAudioOptions, IStereoAudioOptions {
+    /**
+     * The output bus for the sound. Defaults to `null`.
+     * - If not set or `null`, the sound is automatically connected to the audio engine's default main bus.
+     * @see {@link AudioEngineV2.defaultMainBus}
+     */
+    outBus: Nullable<PrimaryAudioBus>;
+}
+/**
+ * Options for playing a sound.
+ */
+export interface IAbstractSoundPlayOptions extends IAbstractSoundPlayOptionsBase, IVolumeAudioOptions {
+}
+/**
+ * Options stored in a sound.
+ * @internal
+ */
+export interface IAbstractSoundStoredOptions extends IAbstractSoundOptionsBase, IAbstractSoundPlayOptionsBase {
+}
+/**
+ * Abstract class representing a sound in the audio engine.
+ */
+export declare abstract class AbstractSound extends AbstractNamedAudioNode {
+    private _newestInstance;
+    private _outBus;
+    private _privateInstances;
+    private _state;
+    protected _instances: ReadonlySet<_AbstractSoundInstance>;
+    protected abstract readonly _options: IAbstractSoundStoredOptions;
+    protected _spatialAutoUpdate: boolean;
+    protected abstract _subGraph: _AbstractAudioSubGraph;
+    /**
+     * Observable for when the sound stops playing.
+     */
+    readonly onEndedObservable: Observable<AbstractSound>;
+    protected constructor(name: string, engine: AudioEngineV2, options: Partial<IAbstractSoundOptions>);
+    /**
+     * Whether the sound should start playing automatically. Defaults to `false`.
+     */
+    get autoplay(): boolean;
+    /**
+     * The current playback time of the sound, in seconds.
+     */
+    get currentTime(): number;
+    set currentTime(value: number);
+    /**
+     * Whether the sound should loop. Defaults to `false`.
+     */
+    get loop(): boolean;
+    set loop(value: boolean);
+    /**
+     * The maximum number of instances that can play at the same time. Defaults to `Infinity`.
+     */
+    get maxInstances(): number;
+    set maxInstances(value: number);
+    /**
+     * The output bus for the sound. Defaults to `null`.
+     * - If not set or `null`, the sound is automatically connected to the audio engine's default main bus.
+     * @see {@link AudioEngineV2.defaultMainBus}
+     */
+    get outBus(): Nullable<PrimaryAudioBus>;
+    set outBus(outBus: Nullable<PrimaryAudioBus>);
+    /**
+     * The spatial properties of the sound.
+     */
+    abstract spatial: AbstractSpatialAudio;
+    /**
+     * The time within the sound buffer to start playing at, in seconds. Defaults to `0`.
+     */
+    get startOffset(): number;
+    set startOffset(value: number);
+    /**
+     * The state of the sound.
+     */
+    get state(): SoundState;
+    /**
+     * The stereo properties of the sound.
+     */
+    abstract stereo: AbstractStereoAudio;
+    /**
+     * The output volume of the sound.
+     */
+    get volume(): number;
+    set volume(value: number);
+    /**
+     * Releases associated resources.
+     */
+    dispose(): void;
+    /**
+     * Plays the sound.
+     * - Triggers `onEndedObservable` if played for the full duration and the `loop` option is not set.
+     * @param options The options to use when playing the sound. Options set here override the sound's options.
+     */
+    abstract play(options?: Partial<IAbstractSoundPlayOptions>): void;
+    /**
+     * Pauses the sound.
+     */
+    pause(): void;
+    /**
+     * Resumes the sound.
+     */
+    resume(): void;
+    /**
+     * Stops the sound.
+     * - Triggers `onEndedObservable` if the sound is playing.
+     */
+    abstract stop(): void;
+    protected _beforePlay(instance: _AbstractSoundInstance): void;
+    protected _afterPlay(instance: _AbstractSoundInstance): void;
+    protected _setState(state: SoundState): void;
+    protected abstract _createInstance(): _AbstractSoundInstance;
+    protected _stopExcessInstances(): void;
+    private _getNewestInstance;
+    private _onInstanceEnded;
+    private _onOutBusDisposed;
+}