@babylonjs/core 7.51.3 → 7.52.0

package/AudioV2/abstractAudio/audioEngineV2.js

@@ -0,0 +1,155 @@
+const Instances = [];
+/**
+ * Gets the most recently created v2 audio engine.
+ * @returns The most recently created v2 audio engine.
+ */
+export function LastCreatedAudioEngine() {
+    if (Instances.length === 0) {
+        return null;
+    }
+    return Instances[Instances.length - 1];
+}
+/**
+ * Abstract base class for v2 audio engines.
+ *
+ * A v2 audio engine based on the WebAudio API can be created with the {@link CreateAudioEngineAsync} function.
+ */
+export class AudioEngineV2 {
+    constructor(options) {
+        /** Not owned, but all items should be in `_nodes` container, too, which is owned. */
+        this._mainBuses = new Set();
+        /** Owned top-level sound and bus nodes. */
+        this._nodes = new Set();
+        this._defaultMainBus = null;
+        this._listenerAutoUpdate = true;
+        Instances.push(this);
+        if (typeof options.listenerAutoUpdate === "boolean") {
+            this._listenerAutoUpdate = options.listenerAutoUpdate;
+        }
+    }
+    /**
+     * The default main bus that will be used for audio buses and sounds if their `outBus` option is not set.
+     * @see {@link IAudioBusOptions.outBus}
+     * @see {@link IAbstractSoundOptions.outBus}
+     */
+    get defaultMainBus() {
+        if (this._mainBuses.size === 0) {
+            return null;
+        }
+        if (!this._defaultMainBus) {
+            this._defaultMainBus = Array.from(this._mainBuses)[0];
+        }
+        return this._defaultMainBus;
+    }
+    /**
+     * Releases associated resources.
+     */
+    dispose() {
+        if (Instances.includes(this)) {
+            Instances.splice(Instances.indexOf(this), 1);
+        }
+        const nodeIt = this._nodes.values();
+        for (let next = nodeIt.next(); !next.done; next = nodeIt.next()) {
+            next.value.dispose();
+        }
+        this._mainBuses.clear();
+        this._nodes.clear();
+        this._defaultMainBus = null;
+    }
+    /**
+     * Unlocks the audio engine if it is locked.
+     * - Note that the returned promise may already be resolved if the audio engine is already unlocked.
+     * @returns A promise that is resolved when the audio engine is unlocked.
+     */
+    unlock() {
+        return this.resume();
+    }
+    _addMainBus(mainBus) {
+        this._mainBuses.add(mainBus);
+        this._addNode(mainBus);
+    }
+    _removeMainBus(mainBus) {
+        this._mainBuses.delete(mainBus);
+        this._defaultMainBus = null;
+        this._removeNode(mainBus);
+    }
+    _addNode(node) {
+        this._nodes.add(node);
+    }
+    _removeNode(node) {
+        this._nodes.delete(node);
+    }
+}
+/**
+ * @internal
+ * @param engine - The given audio engine. If `null` then the last created audio engine is used.
+ * @returns the given audio engine or the last created audio engine.
+ * @throws An error if the resulting engine is `null`.
+ */
+export function _GetAudioEngine(engine) {
+    if (!engine) {
+        engine = LastCreatedAudioEngine();
+    }
+    if (engine) {
+        return engine;
+    }
+    throw new Error("No audio engine.");
+}
+/**
+ * Creates a new audio bus.
+ * @param name - The name of the audio bus.
+ * @param options - The options to use when creating the audio bus.
+ * @param engine - The audio engine.
+ * @returns A promise that resolves with the created audio bus.
+ */
+export function CreateAudioBusAsync(name, options = {}, engine = null) {
+    engine = _GetAudioEngine(engine);
+    return engine.createBusAsync(name, options);
+}
+/**
+ * Creates a new main audio bus.
+ * @param name - The name of the main audio bus.
+ * @param options - The options to use when creating the main audio bus.
+ * @param engine - The audio engine.
+ * @returns A promise that resolves with the created main audio bus.
+ */
+export function CreateMainAudioBusAsync(name, options = {}, engine = null) {
+    engine = _GetAudioEngine(engine);
+    return engine.createMainBusAsync(name, options);
+}
+/**
+ * Creates a new static sound.
+ * @param name - The name of the sound.
+ * @param source - The source of the sound.
+ * @param options - The options for the static sound.
+ * @param engine - The audio engine.
+ * @returns A promise that resolves to the created static sound.
+ */
+export function CreateSoundAsync(name, source, options = {}, engine = null) {
+    engine = _GetAudioEngine(engine);
+    return engine.createSoundAsync(name, source, options);
+}
+/**
+ * Creates a new static sound buffer.
+ * @param source - The source of the sound buffer.
+ * @param options - The options for the static sound buffer.
+ * @param engine - The audio engine.
+ * @returns A promise that resolves to the created static sound buffer.
+ */
+export async function CreateSoundBufferAsync(source, options = {}, engine = null) {
+    engine = _GetAudioEngine(engine);
+    return engine.createSoundBufferAsync(source, options);
+}
+/**
+ * Creates a new streaming sound.
+ * @param name - The name of the sound.
+ * @param source - The source of the sound.
+ * @param options - The options for the streaming sound.
+ * @param engine - The audio engine.
+ * @returns A promise that resolves to the created streaming sound.
+ */
+export function CreateStreamingSoundAsync(name, source, options = {}, engine = null) {
+    engine = _GetAudioEngine(engine);
+    return engine.createStreamingSoundAsync(name, source, options);
+}
+//# sourceMappingURL=audioEngineV2.js.map

package/AudioV2/abstractAudio/audioEngineV2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audioEngineV2.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/audioEngineV2.ts"],"names":[],"mappings":"AASA,MAAM,SAAS,GAAoB,EAAE,CAAC;AAEtC;;;GAGG;AACH,MAAM,UAAU,sBAAsB;IAClC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAkBD;;;;GAIG;AACH,MAAM,OAAgB,aAAa;IAW/B,YAAsB,OAAuC;QAV7D,qFAAqF;QACpE,eAAU,GAAG,IAAI,GAAG,EAAgB,CAAC;QAEtD,2CAA2C;QAC1B,WAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;QAEpD,oBAAe,GAA2B,IAAI,CAAC;QAE7C,wBAAmB,GAAY,IAAI,CAAC;QAG1C,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAErB,IAAI,OAAO,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAClD,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAC1D,CAAC;IACL,CAAC;IAOD;;;;OAIG;IACH,IAAW,cAAc;QACrB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IA+ED;;OAEG;IACI,OAAO;QACV,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,KAAK,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9D,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAEpB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAChC,CAAC;IAqBD;;;;OAIG;IACI,MAAM;QACT,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAES,WAAW,CAAC,OAAqB;QACvC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAES,cAAc,CAAC,OAAqB;QAC1C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAES,QAAQ,CAAC,IAA4B;QAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAES,WAAW,CAAC,IAA4B;QAC9C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAA+B;IAC3D,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,GAAG,sBAAsB,EAAE,CAAC;IACtC,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,UAAqC,EAAE,EAAE,SAAkC,IAAI;IAC7H,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAY,EAAE,UAAyC,EAAE,EAAE,SAAkC,IAAI;IACrI,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC5B,IAAY,EACZ,MAAyE,EACzE,UAAwC,EAAE,EAC1C,SAAkC,IAAI;IAEtC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CACxC,MAAyE,EACzE,UAA8C,EAAE,EAChD,SAAkC,IAAI;IAEtC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACrC,IAAY,EACZ,MAA4C,EAC5C,UAA2C,EAAE,EAC7C,SAAkC,IAAI;IAEtC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,MAAM,CAAC,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACnE,CAAC","sourcesContent":["import type { Nullable } from \"../../types\";\nimport type { AbstractAudioNode, AbstractNamedAudioNode } from \"./abstractAudioNode\";\nimport type { AudioBus, IAudioBusOptions } from \"./audioBus\";\nimport type { IMainAudioBusOptions, MainAudioBus } from \"./mainAudioBus\";\nimport type { IStaticSoundOptions, StaticSound } from \"./staticSound\";\nimport type { IStaticSoundBufferOptions, StaticSoundBuffer } from \"./staticSoundBuffer\";\nimport type { IStreamingSoundOptions, StreamingSound } from \"./streamingSound\";\nimport type { AbstractSpatialAudioListener, ISpatialAudioListenerOptions } from \"./subProperties/abstractSpatialAudioListener\";\n\nconst Instances: AudioEngineV2[] = [];\n\n/**\n * Gets the most recently created v2 audio engine.\n * @returns The most recently created v2 audio engine.\n */\nexport function LastCreatedAudioEngine(): Nullable<AudioEngineV2> {\n    if (Instances.length === 0) {\n        return null;\n    }\n\n    return Instances[Instances.length - 1];\n}\n\n/**\n * Options for creating a v2 audio engine.\n */\nexport interface IAudioEngineV2Options extends ISpatialAudioListenerOptions {\n    /**\n     * The initial output volume of the audio engine. Defaults to `1`.\n     */\n    volume: number;\n}\n\n/**\n * The state of a v2 audio engine.\n * @see {@link AudioEngineV2.state}\n */\nexport type AudioEngineV2State = \"closed\" | \"interrupted\" | \"running\" | \"suspended\";\n\n/**\n * Abstract base class for v2 audio engines.\n *\n * A v2 audio engine based on the WebAudio API can be created with the {@link CreateAudioEngineAsync} function.\n */\nexport abstract class AudioEngineV2 {\n    /** Not owned, but all items should be in `_nodes` container, too, which is owned. */\n    private readonly _mainBuses = new Set<MainAudioBus>();\n\n    /** Owned top-level sound and bus nodes. */\n    private readonly _nodes = new Set<AbstractNamedAudioNode>();\n\n    private _defaultMainBus: Nullable<MainAudioBus> = null;\n\n    protected _listenerAutoUpdate: boolean = true;\n\n    protected constructor(options: Partial<IAudioEngineV2Options>) {\n        Instances.push(this);\n\n        if (typeof options.listenerAutoUpdate === \"boolean\") {\n            this._listenerAutoUpdate = options.listenerAutoUpdate;\n        }\n    }\n\n    /**\n     * The elapsed time since the audio engine was started, in seconds.\n     */\n    public abstract readonly currentTime: number;\n\n    /**\n     * The default main bus that will be used for audio buses and sounds if their `outBus` option is not set.\n     * @see {@link IAudioBusOptions.outBus}\n     * @see {@link IAbstractSoundOptions.outBus}\n     */\n    public get defaultMainBus(): Nullable<MainAudioBus> {\n        if (this._mainBuses.size === 0) {\n            return null;\n        }\n\n        if (!this._defaultMainBus) {\n            this._defaultMainBus = Array.from(this._mainBuses)[0];\n        }\n\n        return this._defaultMainBus;\n    }\n\n    /**\n     * The spatial audio listener properties for the audio engine.\n     * - Each audio engine has exactly one listener.\n     */\n    public abstract readonly listener: AbstractSpatialAudioListener;\n\n    /**\n     * The main output node.\n     * - This is the last node in the audio graph before the audio is sent to the speakers.\n     */\n    public abstract readonly mainOut: AbstractAudioNode;\n\n    /**\n     * The current state of the audio engine.\n     *\n     * Possible values are:\n     * - `\"closed\"`: The audio engine has been closed.\n     * - `\"interrupted\"`: The audio engine has been interrupted and is not running.\n     * - `\"running\"`: The audio engine is running normally.\n     * - `\"suspended\"`: The audio engine is suspended and is not running.\n     */\n    public abstract readonly state: AudioEngineV2State;\n\n    /**\n     * The output volume of the audio engine.\n     */\n    public abstract volume: number;\n    /**\n     * Creates a new audio bus.\n     * @param name - The name of the audio bus.\n     * @param options - The options to use when creating the audio bus.\n     * @param engine - The audio engine.\n     * @returns A promise that resolves with the created audio bus.\n     */\n    public abstract createBusAsync(name: string, options?: Partial<IAudioBusOptions>): Promise<AudioBus>;\n\n    /**\n     * Creates a new main audio bus.\n     * @param name - The name of the main audio bus.\n     * @param options - The options to use when creating the main audio bus.\n     * @returns A promise that resolves with the created main audio bus.\n     */\n    public abstract createMainBusAsync(name: string, options?: Partial<IMainAudioBusOptions>): Promise<MainAudioBus>;\n    /**\n     * Creates a new static sound.\n     * @param name - The name of the sound.\n     * @param source - The source of the sound.\n     * @param options - The options for the static sound.\n     * @returns A promise that resolves to the created static sound.\n     */\n    public abstract createSoundAsync(\n        name: string,\n        source: ArrayBuffer | AudioBuffer | StaticSoundBuffer | string | string[],\n        options?: Partial<IStaticSoundOptions>\n    ): Promise<StaticSound>;\n\n    /**\n     * Creates a new static sound buffer.\n     * @param source - The source of the sound buffer.\n     * @param options - The options for the static sound buffer.\n     * @param engine - The audio engine.\n     * @returns A promise that resolves to the created static sound buffer.\n     */\n    public abstract createSoundBufferAsync(\n        source: ArrayBuffer | AudioBuffer | StaticSoundBuffer | string | string[],\n        options?: Partial<IStaticSoundBufferOptions>\n    ): Promise<StaticSoundBuffer>;\n\n    /**\n     * Creates a new streaming sound.\n     * @param name - The name of the sound.\n     * @param source - The source of the sound.\n     * @param options - The options for the streaming sound.\n     * @returns A promise that resolves to the created streaming sound.\n     */\n    public abstract createStreamingSoundAsync(name: string, source: HTMLMediaElement | string | string[], options?: Partial<IStreamingSoundOptions>): Promise<StreamingSound>;\n\n    /**\n     * Releases associated resources.\n     */\n    public dispose(): void {\n        if (Instances.includes(this)) {\n            Instances.splice(Instances.indexOf(this), 1);\n        }\n\n        const nodeIt = this._nodes.values();\n        for (let next = nodeIt.next(); !next.done; next = nodeIt.next()) {\n            next.value.dispose();\n        }\n\n        this._mainBuses.clear();\n        this._nodes.clear();\n\n        this._defaultMainBus = null;\n    }\n\n    /**\n     * Checks if the specified format is valid.\n     * @param format The format to check as an audio file extension like \"mp3\" or \"wav\".\n     * @returns `true` if the format is valid; otherwise `false`.\n     */\n    public abstract isFormatValid(format: string): boolean;\n\n    /**\n     * Pauses the audio engine if it is running.\n     * @returns A promise that resolves when the audio engine is paused.\n     */\n    public abstract pause(): Promise<void>;\n\n    /**\n     * Resumes the audio engine if it is not running.\n     * @returns A promise that resolves when the audio engine is running.\n     */\n    public abstract resume(): Promise<void>;\n\n    /**\n     * Unlocks the audio engine if it is locked.\n     * - Note that the returned promise may already be resolved if the audio engine is already unlocked.\n     * @returns A promise that is resolved when the audio engine is unlocked.\n     */\n    public unlock(): Promise<void> {\n        return this.resume();\n    }\n\n    protected _addMainBus(mainBus: MainAudioBus): void {\n        this._mainBuses.add(mainBus);\n\n        this._addNode(mainBus);\n    }\n\n    protected _removeMainBus(mainBus: MainAudioBus): void {\n        this._mainBuses.delete(mainBus);\n        this._defaultMainBus = null;\n\n        this._removeNode(mainBus);\n    }\n\n    protected _addNode(node: AbstractNamedAudioNode): void {\n        this._nodes.add(node);\n    }\n\n    protected _removeNode(node: AbstractNamedAudioNode): void {\n        this._nodes.delete(node);\n    }\n}\n\n/**\n * @internal\n * @param engine - The given audio engine. If `null` then the last created audio engine is used.\n * @returns the given audio engine or the last created audio engine.\n * @throws An error if the resulting engine is `null`.\n */\nexport function _GetAudioEngine(engine: Nullable<AudioEngineV2>): AudioEngineV2 {\n    if (!engine) {\n        engine = LastCreatedAudioEngine();\n    }\n\n    if (engine) {\n        return engine;\n    }\n\n    throw new Error(\"No audio engine.\");\n}\n\n/**\n * Creates a new audio bus.\n * @param name - The name of the audio bus.\n * @param options - The options to use when creating the audio bus.\n * @param engine - The audio engine.\n * @returns A promise that resolves with the created audio bus.\n */\nexport function CreateAudioBusAsync(name: string, options: Partial<IAudioBusOptions> = {}, engine: Nullable<AudioEngineV2> = null): Promise<AudioBus> {\n    engine = _GetAudioEngine(engine);\n    return engine.createBusAsync(name, options);\n}\n\n/**\n * Creates a new main audio bus.\n * @param name - The name of the main audio bus.\n * @param options - The options to use when creating the main audio bus.\n * @param engine - The audio engine.\n * @returns A promise that resolves with the created main audio bus.\n */\nexport function CreateMainAudioBusAsync(name: string, options: Partial<IMainAudioBusOptions> = {}, engine: Nullable<AudioEngineV2> = null): Promise<MainAudioBus> {\n    engine = _GetAudioEngine(engine);\n    return engine.createMainBusAsync(name, options);\n}\n\n/**\n * Creates a new static sound.\n * @param name - The name of the sound.\n * @param source - The source of the sound.\n * @param options - The options for the static sound.\n * @param engine - The audio engine.\n * @returns A promise that resolves to the created static sound.\n */\nexport function CreateSoundAsync(\n    name: string,\n    source: ArrayBuffer | AudioBuffer | StaticSoundBuffer | string | string[],\n    options: Partial<IStaticSoundOptions> = {},\n    engine: Nullable<AudioEngineV2> = null\n): Promise<StaticSound> {\n    engine = _GetAudioEngine(engine);\n    return engine.createSoundAsync(name, source, options);\n}\n\n/**\n * Creates a new static sound buffer.\n * @param source - The source of the sound buffer.\n * @param options - The options for the static sound buffer.\n * @param engine - The audio engine.\n * @returns A promise that resolves to the created static sound buffer.\n */\nexport async function CreateSoundBufferAsync(\n    source: ArrayBuffer | AudioBuffer | StaticSoundBuffer | string | string[],\n    options: Partial<IStaticSoundBufferOptions> = {},\n    engine: Nullable<AudioEngineV2> = null\n): Promise<StaticSoundBuffer> {\n    engine = _GetAudioEngine(engine);\n    return engine.createSoundBufferAsync(source, options);\n}\n\n/**\n * Creates a new streaming sound.\n * @param name - The name of the sound.\n * @param source - The source of the sound.\n * @param options - The options for the streaming sound.\n * @param engine - The audio engine.\n * @returns A promise that resolves to the created streaming sound.\n */\nexport function CreateStreamingSoundAsync(\n    name: string,\n    source: HTMLMediaElement | string | string[],\n    options: Partial<IStreamingSoundOptions> = {},\n    engine: Nullable<AudioEngineV2> = null\n): Promise<StreamingSound> {\n    engine = _GetAudioEngine(engine);\n    return engine.createStreamingSoundAsync(name, source, options);\n}\n"]}

package/AudioV2/abstractAudio/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./abstractAudioBus";
+export * from "./abstractAudioNode";
+export * from "./abstractSound";
+export * from "./audioBus";
+export * from "./audioEngineV2";
+export * from "./mainAudioBus";
+export * from "./staticSound";
+export * from "./staticSoundBuffer";
+export * from "./streamingSound";
+export * from "./subProperties/index";

package/AudioV2/abstractAudio/index.js

@@ -0,0 +1,12 @@
+/* eslint-disable import/no-internal-modules */
+export * from "./abstractAudioBus.js";
+export * from "./abstractAudioNode.js";
+export * from "./abstractSound.js";
+export * from "./audioBus.js";
+export * from "./audioEngineV2.js";
+export * from "./mainAudioBus.js";
+export * from "./staticSound.js";
+export * from "./staticSoundBuffer.js";
+export * from "./streamingSound.js";
+export * from "./subProperties/index.js";
+//# sourceMappingURL=index.js.map

package/AudioV2/abstractAudio/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC","sourcesContent":["/* eslint-disable import/no-internal-modules */\nexport * from \"./abstractAudioBus\";\nexport * from \"./abstractAudioNode\";\nexport * from \"./abstractSound\";\nexport * from \"./audioBus\";\nexport * from \"./audioEngineV2\";\nexport * from \"./mainAudioBus\";\nexport * from \"./staticSound\";\nexport * from \"./staticSoundBuffer\";\nexport * from \"./streamingSound\";\nexport * from \"./subProperties/index\";\n"]}

package/AudioV2/abstractAudio/mainAudioBus.d.ts

@@ -0,0 +1,22 @@
+import { AbstractAudioBus } from "./abstractAudioBus";
+import type { AudioEngineV2 } from "./audioEngineV2";
+import type { IVolumeAudioOptions } from "./subNodes/volumeAudioSubNode";
+/**
+ * Options for creating a main audio bus.
+ */
+export interface IMainAudioBusOptions extends IVolumeAudioOptions {
+}
+/**
+ * Abstract class representing a main audio bus.
+ *
+ * Main audio buses are the last bus in the audio graph.
+ *
+ * Unlike {@link AudioBus} instances, `MainAudioBus` instances have no spatial audio and stereo output capabilities,
+ * and they cannot be connected downstream to another audio bus. They only connect downstream to the audio engine's
+ * main output.
+ *
+ * Main audio buses are created by the {@link CreateMainAudioBusAsync} function.
+ */
+export declare abstract class MainAudioBus extends AbstractAudioBus {
+    protected constructor(name: string, engine: AudioEngineV2);
+}

package/AudioV2/abstractAudio/mainAudioBus.js

@@ -0,0 +1,18 @@
+import { AbstractAudioBus } from "./abstractAudioBus.js";
+/**
+ * Abstract class representing a main audio bus.
+ *
+ * Main audio buses are the last bus in the audio graph.
+ *
+ * Unlike {@link AudioBus} instances, `MainAudioBus` instances have no spatial audio and stereo output capabilities,
+ * and they cannot be connected downstream to another audio bus. They only connect downstream to the audio engine's
+ * main output.
+ *
+ * Main audio buses are created by the {@link CreateMainAudioBusAsync} function.
+ */
+export class MainAudioBus extends AbstractAudioBus {
+    constructor(name, engine) {
+        super(name, engine);
+    }
+}
+//# sourceMappingURL=mainAudioBus.js.map

package/AudioV2/abstractAudio/mainAudioBus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mainAudioBus.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/mainAudioBus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAStD;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,YAAa,SAAQ,gBAAgB;IACvD,YAAsB,IAAY,EAAE,MAAqB;QACrD,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACJ","sourcesContent":["import { AbstractAudioBus } from \"./abstractAudioBus\";\nimport type { AudioEngineV2 } from \"./audioEngineV2\";\nimport type { IVolumeAudioOptions } from \"./subNodes/volumeAudioSubNode\";\n\n/**\n * Options for creating a main audio bus.\n */\nexport interface IMainAudioBusOptions extends IVolumeAudioOptions {}\n\n/**\n * Abstract class representing a main audio bus.\n *\n * Main audio buses are the last bus in the audio graph.\n *\n * Unlike {@link AudioBus} instances, `MainAudioBus` instances have no spatial audio and stereo output capabilities,\n * and they cannot be connected downstream to another audio bus. They only connect downstream to the audio engine's\n * main output.\n *\n * Main audio buses are created by the {@link CreateMainAudioBusAsync} function.\n */\nexport abstract class MainAudioBus extends AbstractAudioBus {\n    protected constructor(name: string, engine: AudioEngineV2) {\n        super(name, engine);\n    }\n}\n"]}

package/AudioV2/abstractAudio/mainAudioOut.d.ts

@@ -0,0 +1,13 @@
+import { AbstractAudioNode } from "./abstractAudioNode";
+import type { AudioEngineV2 } from "./audioEngineV2";
+/**
+ * Abstract class for the main audio output node.
+ *
+ * A main audio output is the last audio node in the audio graph before the audio is sent to the speakers.
+ *
+ * @see {@link AudioEngineV2.mainOut}
+ * @internal
+ */
+export declare abstract class _MainAudioOut extends AbstractAudioNode {
+    protected constructor(engine: AudioEngineV2);
+}

package/AudioV2/abstractAudio/mainAudioOut.js

@@ -0,0 +1,15 @@
+import { AbstractAudioNode } from "./abstractAudioNode.js";
+/**
+ * Abstract class for the main audio output node.
+ *
+ * A main audio output is the last audio node in the audio graph before the audio is sent to the speakers.
+ *
+ * @see {@link AudioEngineV2.mainOut}
+ * @internal
+ */
+export class _MainAudioOut extends AbstractAudioNode {
+    constructor(engine) {
+        super(engine, 1 /* AudioNodeType.HAS_INPUTS */);
+    }
+}
+//# sourceMappingURL=mainAudioOut.js.map

package/AudioV2/abstractAudio/mainAudioOut.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mainAudioOut.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/mainAudioOut.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGvE;;;;;;;GAOG;AACH,MAAM,OAAgB,aAAc,SAAQ,iBAAiB;IACzD,YAAsB,MAAqB;QACvC,KAAK,CAAC,MAAM,mCAA2B,CAAC;IAC5C,CAAC;CACJ","sourcesContent":["import { AudioNodeType, AbstractAudioNode } from \"./abstractAudioNode\";\nimport type { AudioEngineV2 } from \"./audioEngineV2\";\n\n/**\n * Abstract class for the main audio output node.\n *\n * A main audio output is the last audio node in the audio graph before the audio is sent to the speakers.\n *\n * @see {@link AudioEngineV2.mainOut}\n * @internal\n */\nexport abstract class _MainAudioOut extends AbstractAudioNode {\n    protected constructor(engine: AudioEngineV2) {\n        super(engine, AudioNodeType.HAS_INPUTS);\n    }\n}\n"]}

package/AudioV2/abstractAudio/staticSound.d.ts

@@ -0,0 +1,134 @@
+import type { IAbstractSoundOptions, IAbstractSoundPlayOptions, IAbstractSoundStoredOptions } from "./abstractSound";
+import { AbstractSound } from "./abstractSound";
+import type { AudioEngineV2 } from "./audioEngineV2";
+import type { IStaticSoundBufferOptions, StaticSoundBuffer } from "./staticSoundBuffer";
+import type { _StaticSoundInstance } from "./staticSoundInstance";
+/** @internal */
+export interface IStaticSoundOptionsBase {
+    /**
+     * The amount of time to play the sound for, in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the sound plays for its full duration.
+     */
+    duration: number;
+    /**
+     * The end of the loop range in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop plays for the sound's full duration.
+     * - Has no effect if {@link loop} is `false`.
+     */
+    loopEnd: number;
+    /**
+     * The start of the loop range in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop starts at the beginning of the sound.
+     * - Has no effect if {@link loop} is `false`.
+     *
+     */
+    loopStart: number;
+    /**
+     * The pitch of the sound, in cents. Defaults to `0`.
+     * - Can be combined with {@link playbackRate}.
+     */
+    pitch: number;
+    /**
+     * The playback rate of the sound. Defaults to `1`.
+     * - Can be combined with {@link pitch}.
+     */
+    playbackRate: number;
+}
+/** @internal */
+export interface IStaticSoundPlayOptionsBase {
+    /**
+     * The time to wait before playing the sound, in seconds.
+     */
+    waitTime: number;
+}
+/**
+ * Options for creating a static sound.
+ */
+export interface IStaticSoundOptions extends IAbstractSoundOptions, IStaticSoundBufferOptions, IStaticSoundStoredOptions {
+}
+/**
+ * Options for playing a static sound.
+ */
+export interface IStaticSoundPlayOptions extends IAbstractSoundPlayOptions, IStaticSoundOptionsBase, IStaticSoundPlayOptionsBase {
+}
+/**
+ * Options for stopping a static sound.
+ */
+export interface IStaticSoundStopOptions {
+    /**
+     * The time to wait before stopping the sound, in seconds.
+     */
+    waitTime: number;
+}
+/**
+ * Options stored in a static sound.
+ * @internal
+ */
+export interface IStaticSoundStoredOptions extends IAbstractSoundStoredOptions, IStaticSoundOptionsBase {
+}
+/**
+ * Abstract class representing a static sound.
+ *
+ * A static sound has a sound buffer that is loaded into memory all at once. This allows it to have more capabilities
+ * than a streaming sound, such as loop points and playback rate changes, but it also means that the sound must be
+ * fully downloaded and decoded before it can be played, which may take a long time for sounds with long durations.
+ *
+ * To prevent downloading and decoding a sound multiple times, a sound's buffer can be shared with other sounds.
+ * See {@link CreateSoundBufferAsync}, {@link StaticSoundBuffer} and {@link StaticSound.buffer} for more information.
+ *
+ * Static sounds are created by the {@link CreateSoundAsync} function.
+ */
+export declare abstract class StaticSound extends AbstractSound {
+    protected _instances: Set<_StaticSoundInstance>;
+    protected abstract readonly _options: IStaticSoundStoredOptions;
+    /**
+     * The sound buffer that the sound uses.
+     *
+     * This buffer can be shared with other static sounds.
+     */
+    abstract readonly buffer: StaticSoundBuffer;
+    protected constructor(name: string, engine: AudioEngineV2, options: Partial<IStaticSoundOptions>);
+    /**
+     * The amount of time to play the sound for, in seconds.
+     * - If less than or equal to `0`, the sound plays for its full duration.
+     */
+    get duration(): number;
+    set duration(value: number);
+    /**
+     * The start of the loop range, in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop starts at the beginning of the sound.
+     */
+    get loopStart(): number;
+    set loopStart(value: number);
+    /**
+     * The end of the loop range, in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop plays for the sound's full duration.
+     */
+    get loopEnd(): number;
+    set loopEnd(value: number);
+    /**
+     * The pitch of the sound, in cents.
+     * - Gets combined with {@link playbackRate} to determine the final pitch.
+     */
+    get pitch(): number;
+    set pitch(value: number);
+    /**
+     * The playback rate of the sound.
+     * - Gets combined with {@link pitch} to determine the final playback rate.
+     */
+    get playbackRate(): number;
+    set playbackRate(value: number);
+    protected abstract _createInstance(): _StaticSoundInstance;
+    /**
+     * 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.
+     */
+    play(options?: Partial<IStaticSoundPlayOptions>): void;
+    /**
+     * Stops the sound.
+     * - Triggers `onEndedObservable` if the sound is playing.
+     * @param options - The options to use when stopping the sound.
+     */
+    stop(options?: Partial<IStaticSoundStopOptions>): void;
+}

package/AudioV2/abstractAudio/staticSound.js

@@ -0,0 +1,113 @@
+import { AbstractSound } from "./abstractSound.js";
+/**
+ * Abstract class representing a static sound.
+ *
+ * A static sound has a sound buffer that is loaded into memory all at once. This allows it to have more capabilities
+ * than a streaming sound, such as loop points and playback rate changes, but it also means that the sound must be
+ * fully downloaded and decoded before it can be played, which may take a long time for sounds with long durations.
+ *
+ * To prevent downloading and decoding a sound multiple times, a sound's buffer can be shared with other sounds.
+ * See {@link CreateSoundBufferAsync}, {@link StaticSoundBuffer} and {@link StaticSound.buffer} for more information.
+ *
+ * Static sounds are created by the {@link CreateSoundAsync} function.
+ */
+export class StaticSound extends AbstractSound {
+    constructor(name, engine, options) {
+        super(name, engine, options);
+    }
+    /**
+     * The amount of time to play the sound for, in seconds.
+     * - If less than or equal to `0`, the sound plays for its full duration.
+     */
+    get duration() {
+        return this._options.duration;
+    }
+    set duration(value) {
+        this._options.duration = value;
+    }
+    /**
+     * The start of the loop range, in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop starts at the beginning of the sound.
+     */
+    get loopStart() {
+        return this._options.loopStart;
+    }
+    set loopStart(value) {
+        this._options.loopStart = value;
+    }
+    /**
+     * The end of the loop range, in seconds. Defaults to `0`.
+     * - If less than or equal to `0`, the loop plays for the sound's full duration.
+     */
+    get loopEnd() {
+        return this._options.loopEnd;
+    }
+    set loopEnd(value) {
+        this._options.loopEnd = value;
+    }
+    /**
+     * The pitch of the sound, in cents.
+     * - Gets combined with {@link playbackRate} to determine the final pitch.
+     */
+    get pitch() {
+        return this._options.pitch;
+    }
+    set pitch(value) {
+        this._options.pitch = value;
+    }
+    /**
+     * The playback rate of the sound.
+     * - Gets combined with {@link pitch} to determine the final playback rate.
+     */
+    get playbackRate() {
+        return this._options.playbackRate;
+    }
+    set playbackRate(value) {
+        this._options.playbackRate = value;
+    }
+    /**
+     * 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.
+     */
+    play(options = {}) {
+        if (this.state === 5 /* SoundState.Paused */) {
+            this.resume();
+            return;
+        }
+        options.duration ?? (options.duration = this.duration);
+        options.loop ?? (options.loop = this.loop);
+        options.loopStart ?? (options.loopStart = this.loopStart);
+        options.loopEnd ?? (options.loopEnd = this.loopEnd);
+        options.pitch ?? (options.pitch = this.pitch);
+        options.playbackRate ?? (options.playbackRate = this.playbackRate);
+        options.startOffset ?? (options.startOffset = this.startOffset);
+        options.volume ?? (options.volume = 1);
+        options.waitTime ?? (options.waitTime = 0);
+        const instance = this._createInstance();
+        this._beforePlay(instance);
+        instance.play(options);
+        this._afterPlay(instance);
+        this._stopExcessInstances();
+    }
+    /**
+     * Stops the sound.
+     * - Triggers `onEndedObservable` if the sound is playing.
+     * @param options - The options to use when stopping the sound.
+     */
+    stop(options = {}) {
+        if (options.waitTime && 0 < options.waitTime) {
+            this._setState(0 /* SoundState.Stopping */);
+        }
+        else {
+            this._setState(1 /* SoundState.Stopped */);
+        }
+        if (!this._instances) {
+            return;
+        }
+        for (const instance of Array.from(this._instances)) {
+            instance.stop(options);
+        }
+    }
+}
+//# sourceMappingURL=staticSound.js.map

package/AudioV2/abstractAudio/staticSound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticSound.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/staticSound.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAuEhD;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,WAAY,SAAQ,aAAa;IAWnD,YAAsB,IAAY,EAAE,MAAqB,EAAE,OAAqC;QAC5F,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED,IAAW,QAAQ,CAAC,KAAa;QAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,IAAW,SAAS,CAAC,KAAa;QAC9B,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,KAAK,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,IAAW,OAAO,CAAC,KAAa;QAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED,IAAW,KAAK,CAAC,KAAa;QAC1B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACtC,CAAC;IAED,IAAW,YAAY,CAAC,KAAa;QACjC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC;IACvC,CAAC;IAID;;;;OAIG;IACI,IAAI,CAAC,UAA4C,EAAE;QACtD,IAAI,IAAI,CAAC,KAAK,8BAAsB,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,OAAO;QACX,CAAC;QAED,OAAO,CAAC,QAAQ,KAAhB,OAAO,CAAC,QAAQ,GAAK,IAAI,CAAC,QAAQ,EAAC;QACnC,OAAO,CAAC,IAAI,KAAZ,OAAO,CAAC,IAAI,GAAK,IAAI,CAAC,IAAI,EAAC;QAC3B,OAAO,CAAC,SAAS,KAAjB,OAAO,CAAC,SAAS,GAAK,IAAI,CAAC,SAAS,EAAC;QACrC,OAAO,CAAC,OAAO,KAAf,OAAO,CAAC,OAAO,GAAK,IAAI,CAAC,OAAO,EAAC;QACjC,OAAO,CAAC,KAAK,KAAb,OAAO,CAAC,KAAK,GAAK,IAAI,CAAC,KAAK,EAAC;QAC7B,OAAO,CAAC,YAAY,KAApB,OAAO,CAAC,YAAY,GAAK,IAAI,CAAC,YAAY,EAAC;QAC3C,OAAO,CAAC,WAAW,KAAnB,OAAO,CAAC,WAAW,GAAK,IAAI,CAAC,WAAW,EAAC;QACzC,OAAO,CAAC,MAAM,KAAd,OAAO,CAAC,MAAM,GAAK,CAAC,EAAC;QACrB,OAAO,CAAC,QAAQ,KAAhB,OAAO,CAAC,QAAQ,GAAK,CAAC,EAAC;QAEvB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,UAA4C,EAAE;QACtD,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,SAAS,6BAAqB,CAAC;QACxC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,SAAS,4BAAoB,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,OAAO;QACX,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACjD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;CACJ","sourcesContent":["import { SoundState } from \"../soundState\";\nimport type { IAbstractSoundOptions, IAbstractSoundPlayOptions, IAbstractSoundStoredOptions } from \"./abstractSound\";\nimport { AbstractSound } from \"./abstractSound\";\nimport type { AudioEngineV2 } from \"./audioEngineV2\";\nimport type { IStaticSoundBufferOptions, StaticSoundBuffer } from \"./staticSoundBuffer\";\nimport type { _StaticSoundInstance } from \"./staticSoundInstance\";\n\n/** @internal */\nexport interface IStaticSoundOptionsBase {\n    /**\n     * The amount of time to play the sound for, in seconds. Defaults to `0`.\n     * - If less than or equal to `0`, the sound plays for its full duration.\n     */\n    duration: number;\n    /**\n     * The end of the loop range in seconds. Defaults to `0`.\n     * - If less than or equal to `0`, the loop plays for the sound's full duration.\n     * - Has no effect if {@link loop} is `false`.\n     */\n    loopEnd: number;\n    /**\n     * The start of the loop range in seconds. Defaults to `0`.\n     * - If less than or equal to `0`, the loop starts at the beginning of the sound.\n     * - Has no effect if {@link loop} is `false`.\n     *\n     */\n    loopStart: number;\n    /**\n     * The pitch of the sound, in cents. Defaults to `0`.\n     * - Can be combined with {@link playbackRate}.\n     */\n    pitch: number;\n    /**\n     * The playback rate of the sound. Defaults to `1`.\n     * - Can be combined with {@link pitch}.\n     */\n    playbackRate: number;\n}\n\n/** @internal */\nexport interface IStaticSoundPlayOptionsBase {\n    /**\n     * The time to wait before playing the sound, in seconds.\n     */\n    waitTime: number;\n}\n\n/**\n * Options for creating a static sound.\n */\nexport interface IStaticSoundOptions extends IAbstractSoundOptions, IStaticSoundBufferOptions, IStaticSoundStoredOptions {}\n\n/**\n * Options for playing a static sound.\n */\nexport interface IStaticSoundPlayOptions extends IAbstractSoundPlayOptions, IStaticSoundOptionsBase, IStaticSoundPlayOptionsBase {}\n\n/**\n * Options for stopping a static sound.\n */\nexport interface IStaticSoundStopOptions {\n    /**\n     * The time to wait before stopping the sound, in seconds.\n     */\n    waitTime: number;\n}\n\n/**\n * Options stored in a static sound.\n * @internal\n */\nexport interface IStaticSoundStoredOptions extends IAbstractSoundStoredOptions, IStaticSoundOptionsBase {}\n\n/**\n * Abstract class representing a static sound.\n *\n * A static sound has a sound buffer that is loaded into memory all at once. This allows it to have more capabilities\n * than a streaming sound, such as loop points and playback rate changes, but it also means that the sound must be\n * fully downloaded and decoded before it can be played, which may take a long time for sounds with long durations.\n *\n * To prevent downloading and decoding a sound multiple times, a sound's buffer can be shared with other sounds.\n * See {@link CreateSoundBufferAsync}, {@link StaticSoundBuffer} and {@link StaticSound.buffer} for more information.\n *\n * Static sounds are created by the {@link CreateSoundAsync} function.\n */\nexport abstract class StaticSound extends AbstractSound {\n    protected override _instances: Set<_StaticSoundInstance>;\n    protected abstract override readonly _options: IStaticSoundStoredOptions;\n\n    /**\n     * The sound buffer that the sound uses.\n     *\n     * This buffer can be shared with other static sounds.\n     */\n    public abstract readonly buffer: StaticSoundBuffer;\n\n    protected constructor(name: string, engine: AudioEngineV2, options: Partial<IStaticSoundOptions>) {\n        super(name, engine, options);\n    }\n\n    /**\n     * The amount of time to play the sound for, in seconds.\n     * - If less than or equal to `0`, the sound plays for its full duration.\n     */\n    public get duration(): number {\n        return this._options.duration;\n    }\n\n    public set duration(value: number) {\n        this._options.duration = value;\n    }\n\n    /**\n     * The start of the loop range, in seconds. Defaults to `0`.\n     * - If less than or equal to `0`, the loop starts at the beginning of the sound.\n     */\n    public get loopStart(): number {\n        return this._options.loopStart;\n    }\n\n    public set loopStart(value: number) {\n        this._options.loopStart = value;\n    }\n\n    /**\n     * The end of the loop range, in seconds. Defaults to `0`.\n     * - If less than or equal to `0`, the loop plays for the sound's full duration.\n     */\n    public get loopEnd(): number {\n        return this._options.loopEnd;\n    }\n\n    public set loopEnd(value: number) {\n        this._options.loopEnd = value;\n    }\n\n    /**\n     * The pitch of the sound, in cents.\n     * - Gets combined with {@link playbackRate} to determine the final pitch.\n     */\n    public get pitch(): number {\n        return this._options.pitch;\n    }\n\n    public set pitch(value: number) {\n        this._options.pitch = value;\n    }\n\n    /**\n     * The playback rate of the sound.\n     * - Gets combined with {@link pitch} to determine the final playback rate.\n     */\n    public get playbackRate(): number {\n        return this._options.playbackRate;\n    }\n\n    public set playbackRate(value: number) {\n        this._options.playbackRate = value;\n    }\n\n    protected abstract override _createInstance(): _StaticSoundInstance;\n\n    /**\n     * Plays the sound.\n     * - Triggers `onEndedObservable` if played for the full duration and the `loop` option is not set.\n     * @param options The options to use when playing the sound. Options set here override the sound's options.\n     */\n    public play(options: Partial<IStaticSoundPlayOptions> = {}): void {\n        if (this.state === SoundState.Paused) {\n            this.resume();\n            return;\n        }\n\n        options.duration ??= this.duration;\n        options.loop ??= this.loop;\n        options.loopStart ??= this.loopStart;\n        options.loopEnd ??= this.loopEnd;\n        options.pitch ??= this.pitch;\n        options.playbackRate ??= this.playbackRate;\n        options.startOffset ??= this.startOffset;\n        options.volume ??= 1;\n        options.waitTime ??= 0;\n\n        const instance = this._createInstance();\n        this._beforePlay(instance);\n        instance.play(options);\n        this._afterPlay(instance);\n\n        this._stopExcessInstances();\n    }\n\n    /**\n     * Stops the sound.\n     * - Triggers `onEndedObservable` if the sound is playing.\n     * @param options - The options to use when stopping the sound.\n     */\n    public stop(options: Partial<IStaticSoundStopOptions> = {}): void {\n        if (options.waitTime && 0 < options.waitTime) {\n            this._setState(SoundState.Stopping);\n        } else {\n            this._setState(SoundState.Stopped);\n        }\n\n        if (!this._instances) {\n            return;\n        }\n\n        for (const instance of Array.from(this._instances)) {\n            instance.stop(options);\n        }\n    }\n}\n"]}

package/AudioV2/abstractAudio/staticSoundBuffer.d.ts

@@ -0,0 +1,46 @@
+import type { AudioEngineV2 } from "./audioEngineV2";
+/**
+ * Options for creating a static sound buffer.
+ */
+export interface IStaticSoundBufferOptions {
+    /**
+     * Whether to skip codec checking before attempting to load each source URL when `source` is a string array. Defaults to `false`.
+     * - Has no effect if the sound's source is not a string array.
+     * @see {@link CreateSoundAsync} `source` parameter.
+     */
+    skipCodecCheck: boolean;
+}
+/**
+ * Abstract class representing a static sound buffer.
+ *
+ * A static sound buffer is a fully downloaded and decoded array of audio data that is ready to be played.
+ *
+ * Static sound buffers can be reused multiple times by different {@link StaticSound} instances.
+ *
+ * Static sound buffers are created by the {@link CreateSoundBufferAsync} function.
+ *
+ * @see {@link StaticSound.buffer}
+ */
+export declare abstract class StaticSoundBuffer {
+    /**
+     * The engine that the sound buffer belongs to.
+     */
+    readonly engine: AudioEngineV2;
+    protected constructor(engine: AudioEngineV2);
+    /**
+     * The sample rate of the sound buffer.
+     */
+    abstract readonly sampleRate: number;
+    /**
+     * The length of the sound buffer, in sample frames.
+     */
+    abstract readonly length: number;
+    /**
+     * The duration of the sound buffer, in seconds.
+     */
+    abstract readonly duration: number;
+    /**
+     * The number of channels in the sound buffer.
+     */
+    abstract readonly channelCount: number;
+}

package/AudioV2/abstractAudio/staticSoundBuffer.js

@@ -0,0 +1,17 @@
+/**
+ * Abstract class representing a static sound buffer.
+ *
+ * A static sound buffer is a fully downloaded and decoded array of audio data that is ready to be played.
+ *
+ * Static sound buffers can be reused multiple times by different {@link StaticSound} instances.
+ *
+ * Static sound buffers are created by the {@link CreateSoundBufferAsync} function.
+ *
+ * @see {@link StaticSound.buffer}
+ */
+export class StaticSoundBuffer {
+    constructor(engine) {
+        this.engine = engine;
+    }
+}
+//# sourceMappingURL=staticSoundBuffer.js.map

package/AudioV2/abstractAudio/staticSoundBuffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticSoundBuffer.js","sourceRoot":"","sources":["../../../../../dev/core/src/AudioV2/abstractAudio/staticSoundBuffer.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,iBAAiB;IAMnC,YAAsB,MAAqB;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CAqBJ","sourcesContent":["import type { AudioEngineV2 } from \"./audioEngineV2\";\n\n/**\n * Options for creating a static sound buffer.\n */\nexport interface IStaticSoundBufferOptions {\n    /**\n     * Whether to skip codec checking before attempting to load each source URL when `source` is a string array. Defaults to `false`.\n     * - Has no effect if the sound's source is not a string array.\n     * @see {@link CreateSoundAsync} `source` parameter.\n     */\n    skipCodecCheck: boolean;\n}\n\n/**\n * Abstract class representing a static sound buffer.\n *\n * A static sound buffer is a fully downloaded and decoded array of audio data that is ready to be played.\n *\n * Static sound buffers can be reused multiple times by different {@link StaticSound} instances.\n *\n * Static sound buffers are created by the {@link CreateSoundBufferAsync} function.\n *\n * @see {@link StaticSound.buffer}\n */\nexport abstract class StaticSoundBuffer {\n    /**\n     * The engine that the sound buffer belongs to.\n     */\n    public readonly engine: AudioEngineV2;\n\n    protected constructor(engine: AudioEngineV2) {\n        this.engine = engine;\n    }\n\n    /**\n     * The sample rate of the sound buffer.\n     */\n    public abstract readonly sampleRate: number;\n\n    /**\n     * The length of the sound buffer, in sample frames.\n     */\n    public abstract readonly length: number;\n\n    /**\n     * The duration of the sound buffer, in seconds.\n     */\n    public abstract readonly duration: number;\n\n    /**\n     * The number of channels in the sound buffer.\n     */\n    public abstract readonly channelCount: number;\n}\n"]}