duckengine

Version:

A 2D Game Engine for the web.

59 lines • 41.8 kB

HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SoundPlayer | DuckEngine - v2.1.0</title><meta name="description" content="Documentation for DuckEngine - v2.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">DuckEngine - v2.1.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">DuckEngine - v2.1.0</a></li><li><a href="../modules/core_sound_soundPlayer.html">core/sound/soundPlayer</a></li><li><a href="core_sound_soundPlayer.SoundPlayer.html">SoundPlayer</a></li></ul><h1>Class SoundPlayer</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>classdesc</dt><dd><p>Creates a SoundPlayer class.</p> </dd><dt>description</dt><dd><p>The SoundPlayer Class. Plays audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SoundPlayer</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#element" class="tsd-kind-icon">element</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_sound_soundPlayer.SoundPlayer.html#sprites" class="tsd-kind-icon">sprites</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#duration" class="tsd-kind-icon">duration</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#isMuted" class="tsd-kind-icon">is<wbr/>Muted</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#isPlaying" class="tsd-kind-icon">is<wbr/>Playing</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#volume" class="tsd-kind-icon">volume</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#loop" class="tsd-kind-icon">loop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#mute" class="tsd-kind-icon">mute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#play" class="tsd-kind-icon">play</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#playSprite" class="tsd-kind-icon">play<wbr/>Sprite</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#restart" class="tsd-kind-icon">restart</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#seek" class="tsd-kind-icon">seek</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#setPath" class="tsd-kind-icon">set<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#setVolume" class="tsd-kind-icon">set<wbr/>Volume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#unmute" class="tsd-kind-icon">unmute</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sound<wbr/>Player<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Sound.html" class="tsd-signature-type" data-tsd-kind="Namespace">Sound</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Sound.Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_sound_soundPlayer.SoundPlayer.html" class="tsd-signature-type" data-tsd-kind="Class">SoundPlayer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L22">core/sound/soundPlayer.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Creates a SoundPlayer instance</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Path to sound file</p> </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Sound.html" class="tsd-signature-type" data-tsd-kind="Namespace">Sound</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Sound.Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="core_sound_soundPlayer.SoundPlayer.html" class="tsd-signature-type" data-tsd-kind="Class">SoundPlayer</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="element" class="tsd-anchor"></a><h3>element</h3><div class="tsd-signature tsd-kind-icon">element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLAudioElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L12">core/sound/soundPlayer.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="path" class="tsd-anchor"></a><h3>path</h3><div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L11">core/sound/soundPlayer.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="sprites" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> sprites</h3><div class="tsd-signature tsd-kind-icon">sprites<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Sound.html" class="tsd-signature-type" data-tsd-kind="Namespace">Sound</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Sound.Sprite.html" class="tsd-signature-type" data-tsd-kind="Interface">Sprite</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L13">core/sound/soundPlayer.ts:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="duration" class="tsd-anchor"></a><h3>duration</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> duration<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L130">core/sound/soundPlayer.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Gets the duration of the sound</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="isMuted" class="tsd-anchor"></a><h3>is<wbr/>Muted</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isMuted<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L157">core/sound/soundPlayer.ts:157</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Gets the mute state of the sound</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="isPlaying" class="tsd-anchor"></a><h3>is<wbr/>Playing</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isPlaying<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L139">core/sound/soundPlayer.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Gets the playing state of the sound</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="volume" class="tsd-anchor"></a><h3>volume</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> volume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L148">core/sound/soundPlayer.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Gets the volume of the sound</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loop" class="tsd-anchor"></a><h3>loop</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">loop<span class="tsd-signature-symbol">(</span>loop<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L93">core/sound/soundPlayer.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Sets the loop of the audio</p> </dd><dt>since</dt><dd><p>2.1.0</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>loop: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mute" class="tsd-anchor"></a><h3>mute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mute<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L66">core/sound/soundPlayer.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Mutes the audio</p> </dd><dt>since</dt><dd><p>1.1.0</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L57">core/sound/soundPlayer.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Pauses the audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="play" class="tsd-anchor"></a><h3>play</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L48">core/sound/soundPlayer.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Plays the audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="playSprite" class="tsd-anchor"></a><h3>play<wbr/>Sprite</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">play<wbr/>Sprite<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L167">core/sound/soundPlayer.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Plays a sound sprite based on the key</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Key of the sound sprite</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="restart" class="tsd-anchor"></a><h3>restart</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">restart<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L112">core/sound/soundPlayer.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Restarts the audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="seek" class="tsd-anchor"></a><h3>seek</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">seek<span class="tsd-signature-symbol">(</span>timeInSeconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L103">core/sound/soundPlayer.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Seeks the audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>timeInSeconds: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Time in seconds to seek to</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setPath" class="tsd-anchor"></a><h3>set<wbr/>Path</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Path<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L197">core/sound/soundPlayer.ts:197</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Sets the audio src/path</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Audio src/path</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setVolume" class="tsd-anchor"></a><h3>set<wbr/>Volume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Volume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L121">core/sound/soundPlayer.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Sets the volume of the audio</p> </dd><dt>since</dt><dd><p>1.0.0-beta</p> </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>volume: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stop" class="tsd-anchor"></a><h3>stop</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L84">core/sound/soundPlayer.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Pauses the audio, alias to SoundPlayer.pause</p> </dd><dt>since</dt><dd><p>2.1.0</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unmute" class="tsd-anchor"></a><h3>unmute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">unmute<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/sound/soundPlayer.ts#L75">core/sound/soundPlayer.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Sound</p> </dd><dt>description</dt><dd><p>Unmutes the audio</p> </dd><dt>since</dt><dd><p>1.1.0</p> </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animation.html">core/animation/animation</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationFrame.html">core/animation/animation<wbr/>Frame</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationManager.html">core/animation/animation<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationState.html">core/animation/animation<wbr/>State</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_stateMachine.html">core/animation/state<wbr/>Machine</a></li><li class=" tsd-kind-module"><a href="../modules/core_camera_camera.html">core/camera/camera</a></li><li class=" tsd-kind-module"><a href="../modules/core_cutscene_cutscene.html">core/cutscene/cutscene</a></li><li class=" tsd-kind-module"><a href="../modules/core_debug_debug.html">core/debug/debug</a></li><li class=" tsd-kind-module"><a href="../modules/core_display_displayManager.html">core/display/display<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_effect.html">core/effect/effect</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_explosion.html">core/effect/preset/explosion</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_smoke.html">core/effect/preset/smoke</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_eventEmitter.html">core/events/event<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_events.html">core/events/events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_displayEvents.html">core/events/main/display<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_gameEvents.html">core/events/main/game<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_rendererEvents.html">core/events/main/renderer<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_buttonEvents.html">core/events/other/button<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_cutsceneEvents.html">core/events/other/cutscene<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_groupEvents.html">core/events/other/group<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_game.html">core/game</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_circle.html">core/gameobjects/circle</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_gameObject.html">core/gameobjects/game<wbr/>Object</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_misc_canvasModulate.html">core/gameobjects/misc/canvas<wbr/>Modulate</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_particles_particle.html">core/gameobjects/particles/particle</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_particles_particleEmitter.html">core/gameobjects/particles/particle<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_rect.html">core/gameobjects/rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_roundrect.html">core/gameobjects/roundrect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_sprite.html">core/gameobjects/sprite</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_button.html">core/gameobjects/ui/button</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_imageRect.html">core/gameobjects/ui/image<wbr/>Rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_panel.html">core/gameobjects/ui/panel</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_text.html">core/gameobjects/ui/text</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_ui.html">core/gameobjects/ui/ui</a></li><li class=" tsd-kind-module"><a href="../modules/core_group_group.html">core/group/group</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_input.html">core/input/input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_keyboardInput.html">core/input/keyboard<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_key.html">core/input/models/key</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_mouse.html">core/input/models/mouse</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_mouseInput.html">core/input/mouse<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_lights_staticLight.html">core/lights/static<wbr/>Light</a></li><li class=" tsd-kind-module"><a href="../modules/core_loader_loader.html">core/loader/loader</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_map.html">core/map/map</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tile.html">core/map/tile</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilelayer.html">core/map/tilelayer</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilemap.html">core/map/tilemap</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tileset.html">core/map/tileset</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_clamp.html">core/math/clamp</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_lerp.html">core/math/lerp</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_randomFloat.html">core/math/random<wbr/>Float</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_randomInt.html">core/math/random<wbr/>Int</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_vector2.html">core/math/vector2</a></li><li class=" tsd-kind-module"><a href="../modules/core_misc_pluginManager.html">core/misc/plugin<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_models_displayList.html">core/models/display<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/core_models_physicsList.html">core/models/physics<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_area.html">core/physics/models/area</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_collider.html">core/physics/models/collider</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_hitbox.html">core/physics/models/hitbox</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_physicsBody.html">core/physics/physics<wbr/>Body</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_server_physicsServer.html">core/physics/server/physics<wbr/>Server</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_circleToRectIntersect.html">core/physics/utils/circle<wbr/>To<wbr/>Rect<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_hitboxFaceIntersect.html">core/physics/utils/hitbox<wbr/>Face<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_rectToRectIntersect.html">core/physics/utils/rect<wbr/>To<wbr/>Rect<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_baseRenderer.html">core/renderer/base<wbr/>Renderer</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_canvasRenderer.html">core/renderer/canvas/canvas<wbr/>Renderer</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_const_blendModes.html">core/renderer/canvas/const/blend<wbr/>Modes</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_pipeline_rendererPipeline.html">core/renderer/canvas/pipeline/renderer<wbr/>Pipeline</a></li><li class=" tsd-kind-module"><a href="../modules/core_scene.html">core/scene</a></li><li class="current tsd-kind-module"><a href="../modules/core_sound_soundPlayer.html">core/sound/sound<wbr/>Player</a></li><li class=" tsd-kind-module"><a href="../modules/core_storage_cacheManager.html">core/storage/cache<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_texture.html">core/texture/texture</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureAtlas.html">core/texture/texture<wbr/>Atlas</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureBase.html">core/texture/texture<wbr/>Base</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureSheet.html">core/texture/texture<wbr/>Sheet</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="core_sound_soundPlayer.SoundPlayer.html" class="tsd-kind-icon">Sound<wbr/>Player</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#element" class="tsd-kind-icon">element</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_sound_soundPlayer.SoundPlayer.html#sprites" class="tsd-kind-icon">sprites</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#duration" class="tsd-kind-icon">duration</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#isMuted" class="tsd-kind-icon">is<wbr/>Muted</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#isPlaying" class="tsd-kind-icon">is<wbr/>Playing</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#volume" class="tsd-kind-icon">volume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#loop" class="tsd-kind-icon">loop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#mute" class="tsd-kind-icon">mute</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#play" class="tsd-kind-icon">play</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#playSprite" class="tsd-kind-icon">play<wbr/>Sprite</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#restart" class="tsd-kind-icon">restart</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#seek" class="tsd-kind-icon">seek</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#setPath" class="tsd-kind-icon">set<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#setVolume" class="tsd-kind-icon">set<wbr/>Volume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_sound_soundPlayer.SoundPlayer.html#unmute" class="tsd-kind-icon">unmute</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>