wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-10 12:30:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation.

Browse Source
This commit is contained in:
photonstorm
2013-11-28 15:57:09 +00:00
parent 8da9b67c18
commit f22159e257
193 changed files with 68905 additions and 93104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.SoundManager.html
+515 -38
View File
@@ -54,6 +54,10 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
@@ -138,6 +142,10 @@
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -302,6 +310,26 @@
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
@@ -310,6 +338,10 @@
<a href="Phaser.Time.html">Time</a>
</li>
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -356,6 +388,14 @@
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#render">render</a>
</li>
<li>
<a href="global.html#renderXY">renderXY</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
@@ -406,7 +446,9 @@
<div class="description">
<p>Sound Manager constructor.</p>
<p>Sound Manager constructor.
The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it.
Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files.</p>
</div>
@@ -488,7 +530,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-15">line 15</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-17">line 17</a>
</li></ul></dd>
@@ -587,7 +629,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The number of audio channels to use in playback.</p></td>
</tr>
@@ -619,7 +661,112 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-89">line 89</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-97">line 97</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="connectToMaster"><span class="type-signature"></span>connectToMaster<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>connectToMaster</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Used in conjunction with Sound.externalNode this allows you to stop a Sound node being connected to the SoundManager master gain node.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-85">line 85</a>
</li></ul></dd>
@@ -682,7 +829,7 @@
<td class="type">
<span class="param-type">Description</span>
<span class="param-type">AudioContext</span>
@@ -692,7 +839,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The AudioContext being used for playback.</p></td>
</tr>
@@ -724,7 +871,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-59">line 59</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-61">line 61</a>
</li></ul></dd>
@@ -826,7 +973,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-20">line 20</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-22">line 22</a>
</li></ul></dd>
@@ -928,7 +1075,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-341">line 341</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-372">line 372</a>
</li></ul></dd>
@@ -1001,7 +1148,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>Has audio been disabled via the PhaserGlobal object? Useful if you need to use a 3rd party audio library instead.</p></td>
</tr>
@@ -1033,7 +1180,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-77">line 77</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-79">line 79</a>
</li></ul></dd>
@@ -1106,7 +1253,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The event dispatched when a sound decodes (typically only for mp3 files)</p></td>
</tr>
@@ -1135,7 +1282,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-25">line 25</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
@@ -1208,7 +1355,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>true if the audio system is currently locked awaiting a touch event.</p></td>
</tr>
@@ -1240,7 +1387,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-83">line 83</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-91">line 91</a>
</li></ul></dd>
@@ -1258,7 +1405,7 @@
<dt>
<h4 class="name" id="usingAudioTag"><span class="type-signature"></span>usingAudioTag<span class="type-signature"></span></h4>
<h4 class="name" id="usingAudioTag"><span class="type-signature">&lt;readonly> </span>usingAudioTag<span class="type-signature"></span></h4>
</dt>
@@ -1313,7 +1460,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>true if the sound is being played via the Audio tag.</p></td>
</tr>
@@ -1338,14 +1485,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-71">line 71</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-73">line 73</a>
</li></ul></dd>
@@ -1363,7 +1507,7 @@
<dt>
<h4 class="name" id="usingWebAudio"><span class="type-signature"></span>usingWebAudio<span class="type-signature"></span></h4>
<h4 class="name" id="usingWebAudio"><span class="type-signature">&lt;readonly> </span>usingWebAudio<span class="type-signature"></span></h4>
</dt>
@@ -1418,7 +1562,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>true if this sound is being played with Web Audio.</p></td>
</tr>
@@ -1443,14 +1587,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-65">line 65</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-67">line 67</a>
</li></ul></dd>
@@ -1552,7 +1693,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-408">line 408</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-439">line 439</a>
</li></ul></dd>
@@ -1576,7 +1717,7 @@
<dl>
<dt>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(key, <span class="optional">volume</span>, <span class="optional">loop</span>)</span><span class="type-signature"></span></h4>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(key, <span class="optional">volume</span>, <span class="optional">loop</span>, <span class="optional">connect</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
@@ -1732,6 +1873,45 @@
</tr>
<tr>
<td class="name"><code>connect</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.</p></td>
</tr>
</tbody>
</table>
@@ -1760,7 +1940,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-319">line 319</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-326">line 326</a>
</li></ul></dd>
@@ -1781,6 +1961,29 @@
<h5>Returns:</h5>
<div class="param-desc">
<p>The new sound instance.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
</dd>
</dl>
</dd>
@@ -1829,7 +2032,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-95">line 95</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-103">line 103</a>
</li></ul></dd>
@@ -1990,7 +2193,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-260">line 260</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-267">line 267</a>
</li></ul></dd>
@@ -2059,7 +2262,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-228">line 228</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-235">line 235</a>
</li></ul></dd>
@@ -2082,6 +2285,280 @@
</dd>
<dt>
<h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(key, <span class="optional">volume</span>, <span class="optional">loop</span>, <span class="optional">destroyOnComplete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a new Sound into the SoundManager and starts it playing.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
<tr>
<td class="name"><code>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>Default value for the volume.</p></td>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Whether or not the sound will loop.</p></td>
</tr>
<tr>
<td class="name"><code>destroyOnComplete</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true the Sound will destroy itself once it has finished playing, or is stopped.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-349">line 349</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The new sound instance.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
</dd>
</dl>
</dd>
@@ -2128,7 +2605,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-244">line 244</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-251">line 251</a>
</li></ul></dd>
@@ -2197,7 +2674,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-212">line 212</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-219">line 219</a>
</li></ul></dd>
@@ -2266,7 +2743,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-178">line 178</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-185">line 185</a>
</li></ul></dd>
@@ -2335,7 +2812,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-292">line 292</a>
<a href="SoundManager.js.html">sound/SoundManager.js</a>, <a href="SoundManager.js.html#sunlight-1-line-299">line 299</a>
</li></ul></dd>
@@ -2386,7 +2863,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Nov 07 2013 06:07:40 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>