oxygen-core

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/systems/AudioSystem.js | oxygen-core</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="Oxygen game engine (Xenon Core for browsers)"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="oxygen-core"><meta property="twitter:description" content="Oxygen game engine (Xenon Core for browsers)"></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/PsichiX/Oxygen"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">C<a href="class/src/index.js~EventsController.html">EventsController</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-lazyInitialization">lazyInitialization</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#asset-loaders">asset-loaders</a>C<a href="class/src/asset-loaders/AssemblyAsset.js~AssemblyAsset.html">AssemblyAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/AtlasAsset.js~AtlasAsset.html">AtlasAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/BinaryAsset.js~BinaryAsset.html">BinaryAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/FontAsset.js~FontAsset.html">FontAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/ImageAsset.js~ImageAsset.html">ImageAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/JSONAsset.js~JSONAsset.html">JSONAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/MusicAsset.js~MusicAsset.html">MusicAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/PackAsset.js~PackAsset.html">PackAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/ParticleSystemAsset.js~ParticleSystemAsset.html">ParticleSystemAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/PostprocessRackEffectAsset.js~PostprocessRackEffectAsset.html">PostprocessRackEffectAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/SVGAsset.js~SVGAsset.html">SVGAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/SceneAsset.js~SceneAsset.html">SceneAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/SetAsset.js~SetAsset.html">SetAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/ShaderAsset.js~ShaderAsset.html">ShaderAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/SkeletonAsset.js~SkeletonAsset.html">SkeletonAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/SoundAsset.js~SoundAsset.html">SoundAsset</a></li> <li data-ice="doc">C<a href="class/src/asset-loaders/TextAsset.js~TextAsset.html">TextAsset</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#components">components</a>C<a href="class/src/components/AtlasSprite.js~AtlasSprite.html">AtlasSprite</a></li> <li data-ice="doc">C<a href="class/src/components/Camera.js~Camera.html">Camera</a></li> <li data-ice="doc">C<a href="class/src/components/Camera.js~PostprocessPass.html">PostprocessPass</a></li> <li data-ice="doc">C<a href="class/src/components/Camera2D.js~Camera2D.html">Camera2D</a></li> <li data-ice="doc">C<a href="class/src/components/CameraDirector2D.js~CameraDirector2D.html">CameraDirector2D</a></li> <li data-ice="doc">C<a href="class/src/components/CircleShape.js~CircleShape.html">CircleShape</a></li> <li data-ice="doc">C<a href="class/src/components/Container.js~Container.html">Container</a></li> <li data-ice="doc">C<a href="class/src/components/DeferredRenderer.js~DeferredPipeline.html">DeferredPipeline</a></li> <li data-ice="doc">C<a href="class/src/components/DeferredRenderer.js~DeferredRenderer.html">DeferredRenderer</a></li> <li data-ice="doc">C<a href="class/src/components/GestureListener.js~GestureListener.html">GestureListener</a></li> <li data-ice="doc">C<a href="class/src/components/InputHandler.js~InputHandler.html">InputHandler</a></li> <li data-ice="doc">C<a href="class/src/components/MultipassRenderer.js~MultipassPipeline.html">MultipassPipeline</a></li> <li data-ice="doc">C<a href="class/src/components/MultipassRenderer.js~MultipassRenderer.html">MultipassRenderer</a></li> <li data-ice="doc">C<a href="class/src/components/Particles.js~Particles.html">Particles</a></li> <li data-ice="doc">C<a href="class/src/components/PhysicsBody.js~PhysicsBody.html">PhysicsBody</a></li> <li data-ice="doc">C<a href="class/src/components/PhysicsWorld.js~PhysicsWorld.html">PhysicsWorld</a></li> <li data-ice="doc">C<a href="class/src/components/PolygonShape.js~PolygonShape.html">PolygonShape</a></li> <li data-ice="doc">C<a href="class/src/components/PostprocessRack.js~PostprocessRack.html">PostprocessRack</a></li> <li data-ice="doc">C<a href="class/src/components/PostprocessRack.js~PostprocessRackPass.html">PostprocessRackPass</a></li> <li data-ice="doc">C<a href="class/src/components/PostprocessRack.js~PostprocessRackRawEffectPass.html">PostprocessRackRawEffectPass</a></li> <li data-ice="doc">C<a href="class/src/components/PrefabInstance.js~PrefabInstance.html">PrefabInstance</a></li> <li data-ice="doc">C<a href="class/src/components/RectangleRenderer.js~RectangleRenderer.html">RectangleRenderer</a></li> <li data-ice="doc">C<a href="class/src/components/RectangleShape.js~RectangleShape.html">RectangleShape</a></li> <li data-ice="doc">C<a href="class/src/components/Script.js~Script.html">Script</a></li> <li data-ice="doc">C<a href="class/src/components/Shape.js~Shape.html">Shape</a></li> <li data-ice="doc">C<a href="class/src/components/Skeleton.js~Skeleton.html">Skeleton</a></li> <li data-ice="doc">C<a href="class/src/components/SortedActions.js~SortedActions.html">SortedActions</a></li> <li data-ice="doc">C<a href="class/src/components/Sprite.js~Sprite.html">Sprite</a></li> <li data-ice="doc">C<a href="class/src/components/TextRenderer.js~TextRenderer.html">TextRenderer</a></li> <li data-ice="doc">C<a href="class/src/components/UiLayout.js~UiLayout.html">UiLayout</a></li> <li data-ice="doc">C<a href="class/src/components/UiSprite.js~UiSprite.html">UiSprite</a></li> <li data-ice="doc">C<a href="class/src/components/VerticesRenderer.js~VerticesRenderer.html">VerticesRenderer</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#systems">systems</a>C<a href="class/src/systems/AssemblySystem.js~AssemblySystem.html">AssemblySystem</a></li> <li data-ice="doc">C<a href="class/src/systems/AudioSystem.js~AudioSystem.html">AudioSystem</a></li> <li data-ice="doc">C<a href="class/src/systems/InputSystem.js~InputSystem.html">InputSystem</a></li> <li data-ice="doc">C<a href="class/src/systems/RenderSystem.js~Command.html">Command</a></li> <li data-ice="doc">C<a href="class/src/systems/RenderSystem.js~Pipeline.html">Pipeline</a></li> <li data-ice="doc">C<a href="class/src/systems/RenderSystem.js~RenderFullscreenCommand.html">RenderFullscreenCommand</a></li> <li data-ice="doc">C<a href="class/src/systems/RenderSystem.js~RenderSystem.html">RenderSystem</a></li> <li data-ice="doc">C<a href="class/src/systems/RenderSystem.js~RenderTargetWrapper.html">RenderTargetWrapper</a></li> <li data-ice="doc">C<a href="class/src/systems/StorageSystem.js~StorageSystem.html">StorageSystem</a></li> <li data-ice="doc">C<a href="class/src/systems/System.js~System.html">System</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#systems-assetsystem">systems/AssetSystem</a>C<a href="class/src/systems/AssetSystem/Asset.js~Asset.html">Asset</a></li> <li data-ice="doc">C<a href="class/src/systems/AssetSystem/index.js~AssetSystem.html">AssetSystem</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#systems-entitysystem">systems/EntitySystem</a>C<a href="class/src/systems/EntitySystem/Component.js~Component.html">Component</a></li> <li data-ice="doc">C<a href="class/src/systems/EntitySystem/Entity.js~Entity.html">Entity</a></li> <li data-ice="doc">C<a href="class/src/systems/EntitySystem/index.js~EntitySystem.html">EntitySystem</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#utils">utils</a>C<a href="class/src/utils/Events.js~Events.html">Events</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-angleDifference">angleDifference</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-bezierCubic">bezierCubic</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-convertGlobalPointToLocalPoint">convertGlobalPointToLocalPoint</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-convertLocalPointToGlobalPoint">convertLocalPointToGlobalPoint</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-findMapKeyOfValue">findMapKeyOfValue</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMipmapScale">getMipmapScale</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getPOT">getPOT</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isGlobalPointInGlobalBoundingBox">isGlobalPointInGlobalBoundingBox</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isLocalPointInLocalBoundingBox">isLocalPointInLocalBoundingBox</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isPOT">isPOT</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-propsEnumStringify">propsEnumStringify</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-stringToRGBA">stringToRGBA</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-waitForSeconds">waitForSeconds</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-Box2D">Box2D</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/systems/AudioSystem.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import System from './System'; import Events from '../utils/Events'; const audioContext = window.AudioContext || window.webkitAudioContext; /** * System used to manage audio. * * @example * const system = new AudioSystem(); */ export default class AudioSystem extends System { /** @type {AudioContext} */ get context() { return this._context; } /** @type {Events} */ get events() { return this._events; } static createAudioContext() { return new audioContext(); } /** * Constructor. */ constructor() { super(); this._context = AudioSystem.createAudioContext(); this._events = new Events(); this._sounds = new Map(); this._musics = new Map(); } /** * Destructor (dispose internal resources). * * @example * system.dispose(); * system = null; */ dispose() { for (const key of this._sounds.keys()) { this.unregisterSound(key); } for (const key of this._musics.keys()) { this.unregisterMusic(key); } this._context.close(); this._events.dispose(); this._context = null; this._events = null; this._sounds = null; this._musics = null; super.dispose(); } /** * Register new sound. * * @param {string} id - Sound id. * @param {ArrayBuffer|AudioBuffer} data - Sound data. */ registerSound(id, data) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } if (data instanceof ArrayBuffer) { this._context.decodeAudioData(data, buffer => this._sounds.set(id, buffer)); this._sounds.set(id, null); } else if (data instanceof AudioBuffer) { this._sounds.set(id, data); } else { throw new Error('`data` is not type of either ArrayBuffer or AudioBuffer!'); } } /** * Unregister existing sound. * * @param {string} id - Sound id. */ unregisterSound(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } this._sounds.delete(id); } /** * Tells if there is registered given sound. * * @param {string} id - Sound id. * * @return {boolean} True if sound exists, false otherwise. */ hasSound(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } return this._sounds.has(id); } /** * Gets given sound instance. * * @param {string} id - Sound id. * * @return {AudioBufferSourceNode|null} Sound audio buffer source node if found or null if not. */ getSound(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } const { _sounds } = this; if (_sounds.has(id)) { return _sounds.get(id); } return null; } /** * Play given sound. * * @param {string} id - Sound id. * @param {boolean} autoDestination - Tells if sound should be automaticaly bound with context destination. * * @return {AudioBufferSourceNode} Sound audio buffer source node. */ playSound(id, autoDestination = true) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } if (typeof autoDestination !== 'boolean') { throw new Error('`boolean` is not type of Boolean!'); } const { _context, _sounds } = this; if (!_sounds.has(id)) { throw new Error(`There is no registered sound: ${id}`); } const buffer = _sounds.get(id); if (!buffer) { throw new Error(`Sound is not yet ready: ${id}`); } const source = _context.createBufferSource(); source.buffer = buffer; const onended = () => { source.disconnect(); source.removeEventListener('ended', onended); }; source.addEventListener('ended', onended); source.start(); if (autoDestination) { source.connect(_context.destination); } return source; } /** * Produces promise that resolves when sound is decoded into memory (decoding is done asynchronously). * * @param {string} id - Sound id. * * @return {Promise} Produced promise. * * @example * system.whenSoundIsReady('fire').then(() => system.playSound('fire')); */ whenSoundIsReady(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } const { _context, _sounds } = this; if (!_sounds.has(id)) { throw new Error(`There is no registered sound: ${id}`); } return new Promise((resolve, reject) => { let request = 0; const checkSound = () => { if (!_sounds.has(id)) { reject(new Error(`There is no registered sound: ${id}`)); return; } const sound = _sounds.get(id); if (!!sound) { cancelAnimationFrame(request); resolve(sound); } else { request = requestAnimationFrame(checkSound); } }; checkSound(); }); } /** * Register new music. * * @param {string} id - Music id. * @param {HTMLAudioElement} audio - HTML audio element. * * @example * system.registerMusic('ambient', document.getElementById('ambient')); */ registerMusic(id, audio) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } if (!(audio instanceof HTMLAudioElement)) { throw new Error('`audio` is not type of HTMLAudioElement'); } this._musics.set(id, audio); } /** * Unregister existing music. * * @param {string} id - Music id. */ unregisterMusic(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } this._musics.delete(id); } /** * Tells if given music is registered. * * @param {string} id - Music id. * * @return {boolean} True if music exists, false otherwise. */ hasMusic(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } return this._musics.has(id); } /** * Gets music instance. * * @param {string} id - Music id. * * @return {HTMLAudioElement|null} Music instance if found, null otherwise. */ getMusic(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } const { _musics } = this; if (_musics.has(id)) { return _musics.get(id); } return null; } /** * Play given music. * Mostly you will be able to play only one music at the same time. * * @param {string} id - Music id. * * @return {HTMLAudioElement} Music instance. */ playMusic(id) { if (typeof id !== 'string') { throw new Error('`id` is not type of String!'); } const { _context, _musics } = this; if (!_musics.has(id)) { throw new Error(`There is no registered music: ${id}`); } const music = _musics.get(id); let source = null; if (music.__source instanceof MediaElementAudioSourceNode) { source = music.__source; } else { source = _context.createMediaElementSource(music); music.__source = source; } const onended = () => { source.disconnect(); source.removeEventListener('ended', onended); }; source.addEventListener('ended', onended); music.currentTime = 0; music.play(); return source; } } </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>