playcanvas
Version:
Open-source WebGL/WebGPU 3D engine for the web
61 lines (60 loc) • 1.5 kB
TypeScript
/**
* The SoundManager is used to load and play audio. It also applies system-wide settings like
* global volume, suspend and resume.
*
* @category Sound
*/
export class SoundManager extends EventHandler {
/**
* @type {AudioContext|null}
* @private
*/
private _context;
/**
* @type {() => void}
* @private
*/
private _unlockHandlerFunc;
/** @private */
private _userSuspended;
/**
* The listener associated with this manager.
*
* @type {Listener}
*/
listener: Listener;
/** @private */
private _volume;
/**
* Sets the global volume for the manager. All {@link SoundInstance}s will scale their volume
* with this volume. Valid between [0, 1].
*
* @type {number}
*/
set volume(volume: number);
/**
* Gets the global volume for the manager.
*
* @type {number}
*/
get volume(): number;
get suspended(): boolean;
/**
* Get the Web Audio API context. Returns null if the environment does not support the Web
* Audio API.
*
* @type {AudioContext|null}
* @ignore
*/
get context(): AudioContext | null;
suspend(): void;
resume(): void;
destroy(): void;
_resume(): void;
_suspend(): void;
_unlockHandler(): void;
_registerUnlockListeners(): void;
_removeUnlockListeners(): void;
}
import { EventHandler } from '../../core/event-handler.js';
import { Listener } from './listener.js';