-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassMusic.html
More file actions
439 lines (409 loc) · 22.9 KB
/
classMusic.html
File metadata and controls
439 lines (409 loc) · 22.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<!-- HTML header for doxygen 1.15.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hatch Game Engine Documentation: Music Class Reference</title>
<link rel="icon" href="favicon.ico" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.svg" width="55" height="55"/></td>
<td id="projectalign">
<div id="projectname">Hatch Game Engine Documentation<span id="projectnumber"> v1.4.0</span>
</div>
<div id="projectbrief">The documentation for the Hatch Game Engine</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('classMusic.html','','classMusic-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Music Class Reference<div class="ingroups"><a class="el" href="group__hsl.html">HSL</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Music playback.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a30769970f98141382c0cb895d3bd274f" id="r_a30769970f98141382c0cb895d3bd274f"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a30769970f98141382c0cb895d3bd274f">Play</a> (integer music, integer loopPoint, decimal panning=0.0, decimal speed=1.0, decimal volume=1.0, decimal startPoint=0.0, decimal fadeInAfterFinished=0.0)</td></tr>
<tr class="memdesc:a30769970f98141382c0cb895d3bd274f"><td class="mdescLeft"> </td><td class="mdescRight">Places the music onto the music stack and plays it. <br /></td></tr>
<tr class="memitem:aa18f6fe8b3d1b88a26189bab91d48768" id="r_aa18f6fe8b3d1b88a26189bab91d48768"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#aa18f6fe8b3d1b88a26189bab91d48768">Stop</a> (integer music)</td></tr>
<tr class="memdesc:aa18f6fe8b3d1b88a26189bab91d48768"><td class="mdescLeft"> </td><td class="mdescRight">Removes the music from the music stack, stopping it if currently playing. <br /></td></tr>
<tr class="memitem:af90f5c068b152cd18026d13b0c286467" id="r_af90f5c068b152cd18026d13b0c286467"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#af90f5c068b152cd18026d13b0c286467">StopWithFadeOut</a> (decimal seconds)</td></tr>
<tr class="memdesc:af90f5c068b152cd18026d13b0c286467"><td class="mdescLeft"> </td><td class="mdescRight">Removes the music at the top of the music stack, fading it out over a time period. <br /></td></tr>
<tr class="memitem:ae5a3d5c1fb040ab499461d2e18d8e2c2" id="r_ae5a3d5c1fb040ab499461d2e18d8e2c2"><td class="memItemLeft"><a id="ae5a3d5c1fb040ab499461d2e18d8e2c2" name="ae5a3d5c1fb040ab499461d2e18d8e2c2"></a>
void </td><td class="memItemRight"><b>Pause</b> ()</td></tr>
<tr class="memdesc:ae5a3d5c1fb040ab499461d2e18d8e2c2"><td class="mdescLeft"> </td><td class="mdescRight">Pauses the music at the top of the music stack. <br /></td></tr>
<tr class="memitem:ab3f06cb63b858e5abd5b84dced0b2490" id="r_ab3f06cb63b858e5abd5b84dced0b2490"><td class="memItemLeft"><a id="ab3f06cb63b858e5abd5b84dced0b2490" name="ab3f06cb63b858e5abd5b84dced0b2490"></a>
void </td><td class="memItemRight"><b>Resume</b> ()</td></tr>
<tr class="memdesc:ab3f06cb63b858e5abd5b84dced0b2490"><td class="mdescLeft"> </td><td class="mdescRight">Resumes the music at the top of the music stack. <br /></td></tr>
<tr class="memitem:af1ddeeeda69d6515f83ceed5665d268b" id="r_af1ddeeeda69d6515f83ceed5665d268b"><td class="memItemLeft"><a id="af1ddeeeda69d6515f83ceed5665d268b" name="af1ddeeeda69d6515f83ceed5665d268b"></a>
void </td><td class="memItemRight"><b>Clear</b> ()</td></tr>
<tr class="memdesc:af1ddeeeda69d6515f83ceed5665d268b"><td class="mdescLeft"> </td><td class="mdescRight">Completely clears the music stack, stopping all music. <br /></td></tr>
<tr class="memitem:ac54cddc2c4ae58033976d0de42dbfb21" id="r_ac54cddc2c4ae58033976d0de42dbfb21"><td class="memItemLeft">boolean </td><td class="memItemRight"><a class="el" href="#ac54cddc2c4ae58033976d0de42dbfb21">IsPlaying</a> (integer music)</td></tr>
<tr class="memdesc:ac54cddc2c4ae58033976d0de42dbfb21"><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if the specified music is currently playing. <br /></td></tr>
<tr class="memitem:a60f57a4af90705db95969fc92e8be4df" id="r_a60f57a4af90705db95969fc92e8be4df"><td class="memItemLeft">decimal </td><td class="memItemRight"><a class="el" href="#a60f57a4af90705db95969fc92e8be4df">GetDuration</a> (integer music)</td></tr>
<tr class="memdesc:a60f57a4af90705db95969fc92e8be4df"><td class="mdescLeft"> </td><td class="mdescRight">Gets the duration of the current track playing. <br /></td></tr>
<tr class="memitem:a3d83556cf252e6fab118e33ceb0c83fa" id="r_a3d83556cf252e6fab118e33ceb0c83fa"><td class="memItemLeft">decimal </td><td class="memItemRight"><a class="el" href="#a3d83556cf252e6fab118e33ceb0c83fa">GetPosition</a> (integer music)</td></tr>
<tr class="memdesc:a3d83556cf252e6fab118e33ceb0c83fa"><td class="mdescLeft"> </td><td class="mdescRight">Gets the position of the current track playing. <br /></td></tr>
<tr class="memitem:a5532bd00338ada729b5c598d8643eb27" id="r_a5532bd00338ada729b5c598d8643eb27"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a5532bd00338ada729b5c598d8643eb27">Alter</a> (decimal panning, decimal speed, decimal volume)</td></tr>
<tr class="memdesc:a5532bd00338ada729b5c598d8643eb27"><td class="mdescLeft"> </td><td class="mdescRight">Alters the playback conditions of the current track playing. <br /></td></tr>
<tr class="memitem:a46ea18ce785fb8bc4416ce8997b2a1d3" id="r_a46ea18ce785fb8bc4416ce8997b2a1d3"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#a46ea18ce785fb8bc4416ce8997b2a1d3">GetLoopPoint</a> (integer music)</td></tr>
<tr class="memdesc:a46ea18ce785fb8bc4416ce8997b2a1d3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop point of a music index, if it has one. <br /></td></tr>
<tr class="memitem:a8c80d48db5558108cd8db068007ea1b4" id="r_a8c80d48db5558108cd8db068007ea1b4"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a8c80d48db5558108cd8db068007ea1b4">SetLoopPoint</a> (integer music, integer loopPoint)</td></tr>
<tr class="memdesc:a8c80d48db5558108cd8db068007ea1b4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the loop point of a music index. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Music playback. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a5532bd00338ada729b5c598d8643eb27" name="a5532bd00338ada729b5c598d8643eb27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5532bd00338ada729b5c598d8643eb27">◆ </a></span>Alter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Music.Alter </td>
<td>(</td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>panning</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>speed</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>volume</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Alters the playback conditions of the current track playing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">panning</td><td>Control the panning of the audio. -1.0 makes it sound in left ear only, 1.0 makes it sound in right ear, and closer to 0.0 centers it. </td></tr>
<tr><td class="paramname">speed</td><td>Control the speed of the audio. Higher than 1.0 makes it faster, lesser than 1.0 is slower, 1.0 is normal speed. </td></tr>
<tr><td class="paramname">volume</td><td>Controls the volume of the audio. 0.0 is muted, 1.0 is normal volume. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a60f57a4af90705db95969fc92e8be4df" name="a60f57a4af90705db95969fc92e8be4df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60f57a4af90705db95969fc92e8be4df">◆ </a></span>GetDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decimal Music.GetDuration </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the duration of the current track playing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to get the duration (in seconds) of. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a decimal value. </dd></dl>
</div>
</div>
<a id="a46ea18ce785fb8bc4416ce8997b2a1d3" name="a46ea18ce785fb8bc4416ce8997b2a1d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46ea18ce785fb8bc4416ce8997b2a1d3">◆ </a></span>GetLoopPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer Music.GetLoopPoint </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the loop point of a music index, if it has one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to get the loop point. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the loop point in samples, as an integer value, or <span class="tt">null</span> if the audio does not have one. </dd></dl>
</div>
</div>
<a id="a3d83556cf252e6fab118e33ceb0c83fa" name="a3d83556cf252e6fab118e33ceb0c83fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d83556cf252e6fab118e33ceb0c83fa">◆ </a></span>GetPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decimal Music.GetPosition </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the position of the current track playing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to get the current position (in seconds) of. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a decimal value. </dd></dl>
</div>
</div>
<a id="ac54cddc2c4ae58033976d0de42dbfb21" name="ac54cddc2c4ae58033976d0de42dbfb21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac54cddc2c4ae58033976d0de42dbfb21">◆ </a></span>IsPlaying()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Music.IsPlaying </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks to see if the specified music is currently playing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to play. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a boolean value. </dd></dl>
</div>
</div>
<a id="a30769970f98141382c0cb895d3bd274f" name="a30769970f98141382c0cb895d3bd274f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30769970f98141382c0cb895d3bd274f">◆ </a></span>Play()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Music.Play </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>loopPoint</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>panning</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0.0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>speed</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1.0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>volume</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1.0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>startPoint</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0.0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>fadeInAfterFinished</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0.0</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Places the music onto the music stack and plays it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to play. </td></tr>
<tr><td class="paramname">loopPoint</td><td>Loop point in samples. Use <a class="el" href="group__hsl.html#ggaca972f3e6f3928099285283d328f0037a8720a4074b1eaebab4d1293cd00d2e63" title="AUDIO_LOOP_NONE">AUDIO_LOOP_NONE</a> to play the track once or <a class="el" href="group__hsl.html#ggaca972f3e6f3928099285283d328f0037a6b6fdbb786ff3b66ae2aa9c051a2406d" title="AUDIO_LOOP_DEFAULT">AUDIO_LOOP_DEFAULT</a> to use the audio file's metadata. (default: <a class="el" href="group__hsl.html#ggaca972f3e6f3928099285283d328f0037a6b6fdbb786ff3b66ae2aa9c051a2406d" title="AUDIO_LOOP_DEFAULT">AUDIO_LOOP_DEFAULT</a>) </td></tr>
<tr><td class="paramname">panning</td><td>Control the panning of the audio. -1.0 makes it sound in left ear only, 1.0 makes it sound in right ear, and closer to 0.0 centers it. </td></tr>
<tr><td class="paramname">speed</td><td>Control the speed of the audio. Higher than 1.0 makes it faster, lesser than 1.0 is slower, 1.0 is normal speed. </td></tr>
<tr><td class="paramname">volume</td><td>Controls the volume of the audio. 0.0 is muted, 1.0 is normal volume. </td></tr>
<tr><td class="paramname">startPoint</td><td>The time (in seconds) to start the music at. </td></tr>
<tr><td class="paramname">fadeInAfterFinished</td><td>The time period to fade in the previous music track after the currently playing track finishes playing, in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8c80d48db5558108cd8db068007ea1b4" name="a8c80d48db5558108cd8db068007ea1b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c80d48db5558108cd8db068007ea1b4">◆ </a></span>SetLoopPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Music.SetLoopPoint </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>loopPoint</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the loop point of a music index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to set the loop point. </td></tr>
<tr><td class="paramname">loopPoint</td><td>The loop point in samples, or <span class="tt">null</span> to remove the audio's loop point. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa18f6fe8b3d1b88a26189bab91d48768" name="aa18f6fe8b3d1b88a26189bab91d48768"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa18f6fe8b3d1b88a26189bab91d48768">◆ </a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Music.Stop </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>music</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the music from the music stack, stopping it if currently playing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">music</td><td>The music index to stop. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af90f5c068b152cd18026d13b0c286467" name="af90f5c068b152cd18026d13b0c286467"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af90f5c068b152cd18026d13b0c286467">◆ </a></span>StopWithFadeOut()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Music.StopWithFadeOut </td>
<td>(</td>
<td class="paramtype">decimal</td> <td class="paramname"><span class="paramname"><em>seconds</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the music at the top of the music stack, fading it out over a time period. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>The time period to fade out the music, in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="classMusic.html">Music</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.0 </li>
</ul>
</div>
</body>
</html>