-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclass_player.html
More file actions
621 lines (593 loc) · 23.9 KB
/
Copy pathclass_player.html
File metadata and controls
621 lines (593 loc) · 23.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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
<!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">
<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.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FastLink: Player Class Reference</title>
<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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.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="projectalign">
<div id="projectname">FastLink<span id="projectnumber"> 2.3.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_player-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Player Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa44e3c3bb9c680aa993953ebc0498dbb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#aa44e3c3bb9c680aa993953ebc0498dbb">constructor</a> (guildId)</td></tr>
<tr class="separator:aa44e3c3bb9c680aa993953ebc0498dbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acad78b62bbe7ca65cbcbcb5594facfa2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#acad78b62bbe7ca65cbcbcb5594facfa2">createPlayer</a> ()</td></tr>
<tr class="separator:acad78b62bbe7ca65cbcbcb5594facfa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3f98211ed034feb0ffb5c040d36258c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#aa3f98211ed034feb0ffb5c040d36258c">playerCreated</a> ()</td></tr>
<tr class="separator:aa3f98211ed034feb0ffb5c040d36258c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af475e1f90f786efd3e5c5edb0730c9ff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#af475e1f90f786efd3e5c5edb0730c9ff">connect</a> (voiceId, options, sendPayload)</td></tr>
<tr class="separator:af475e1f90f786efd3e5c5edb0730c9ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b6ac7a3a6542d7ae590078637ffafd3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a3b6ac7a3a6542d7ae590078637ffafd3">loadTrack</a> (search)</td></tr>
<tr class="separator:a3b6ac7a3a6542d7ae590078637ffafd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8885936c2849c0d09b9ff0670f069151"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a8885936c2849c0d09b9ff0670f069151">loadCaptions</a> (track, lang)</td></tr>
<tr class="separator:a8885936c2849c0d09b9ff0670f069151"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3237b15576c59b02f97b539d3bdc829"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#ab3237b15576c59b02f97b539d3bdc829">update</a> (body, noReplace)</td></tr>
<tr class="separator:ab3237b15576c59b02f97b539d3bdc829"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26b86a1c58c0e71f7907266eb7229b11"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a26b86a1c58c0e71f7907266eb7229b11">destroy</a> ()</td></tr>
<tr class="separator:a26b86a1c58c0e71f7907266eb7229b11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0810a83214fd92f31570bfa5357f13e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a0810a83214fd92f31570bfa5357f13e5">updateSession</a> (data)</td></tr>
<tr class="separator:a0810a83214fd92f31570bfa5357f13e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedfcff6b2ae50a368ba01622affc76f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#aedfcff6b2ae50a368ba01622affc76f9">getQueue</a> ()</td></tr>
<tr class="separator:aedfcff6b2ae50a368ba01622affc76f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af59bd53d7459c593066a1d6c918be78e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#af59bd53d7459c593066a1d6c918be78e">skipTrack</a> ()</td></tr>
<tr class="separator:af59bd53d7459c593066a1d6c918be78e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dfde35ff1d6bbb9841bb804e2728649"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a3dfde35ff1d6bbb9841bb804e2728649">decodeTrack</a> (track)</td></tr>
<tr class="separator:a3dfde35ff1d6bbb9841bb804e2728649"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2de045793a0c45a6d3a35afd0e026d8a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_player.html#a2de045793a0c45a6d3a35afd0e026d8a">decodeTracks</a> (tracks)</td></tr>
<tr class="separator:a2de045793a0c45a6d3a35afd0e026d8a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Represents a player for an audio streaming service. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af475e1f90f786efd3e5c5edb0730c9ff" name="af475e1f90f786efd3e5c5edb0730c9ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af475e1f90f786efd3e5c5edb0730c9ff">◆ </a></span>connect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::connect </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>voiceId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>sendPayload</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Connects to a voice channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">voiceId</td><td>The ID of the voice channel to connect to. </td></tr>
<tr><td class="paramname">options</td><td>Options for the connection, deaf or mute. </td></tr>
<tr><td class="paramname">sendPayload</td><td>A function for sending payload data. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the voiceId or sendPayload is not provided, or if they are of invalid type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa44e3c3bb9c680aa993953ebc0498dbb" name="aa44e3c3bb9c680aa993953ebc0498dbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa44e3c3bb9c680aa993953ebc0498dbb">◆ </a></span>constructor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::constructor </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>guildId</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Constructs a <a class="el" href="class_player.html">Player</a> object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">guildId</td><td>The ID of the guild that will be associated with the player. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the guildId is not provided, or if they are of invalid type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acad78b62bbe7ca65cbcbcb5594facfa2" name="acad78b62bbe7ca65cbcbcb5594facfa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acad78b62bbe7ca65cbcbcb5594facfa2">◆ </a></span>createPlayer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::createPlayer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Creates a player for the guild.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If a player already exists for the guild. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3dfde35ff1d6bbb9841bb804e2728649" name="a3dfde35ff1d6bbb9841bb804e2728649"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dfde35ff1d6bbb9841bb804e2728649">◆ </a></span>decodeTrack()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::decodeTrack </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>track</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Decodes a track.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">track</td><td>The array to decode. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If a track is not provided or if track is not a string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the decoded data. </dd></dl>
</div>
</div>
<a id="a2de045793a0c45a6d3a35afd0e026d8a" name="a2de045793a0c45a6d3a35afd0e026d8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2de045793a0c45a6d3a35afd0e026d8a">◆ </a></span>decodeTracks()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::decodeTracks </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>tracks</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Decodes an array of tracks.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tracks</td><td>The array of tracks to decode. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If no tracks are provided or if tracks is not an array. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the decoded data. </dd></dl>
</div>
</div>
<a id="a26b86a1c58c0e71f7907266eb7229b11" name="a26b86a1c58c0e71f7907266eb7229b11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26b86a1c58c0e71f7907266eb7229b11">◆ </a></span>destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::destroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Destroys the player. </p>
</div>
</div>
<a id="aedfcff6b2ae50a368ba01622affc76f9" name="aedfcff6b2ae50a368ba01622affc76f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedfcff6b2ae50a368ba01622affc76f9">◆ </a></span>getQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::getQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Gets the queue of tracks.</p>
<dl class="section return"><dt>Returns</dt><dd>The queue of tracks. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the queue is disabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8885936c2849c0d09b9ff0670f069151" name="a8885936c2849c0d09b9ff0670f069151"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8885936c2849c0d09b9ff0670f069151">◆ </a></span>loadCaptions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::loadCaptions </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>lang</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Loads captions for a given track.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">track</td><td>The track to load captions for. </td></tr>
<tr><td class="paramname">lang</td><td>The language to load captions for. Optional. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the track is not provided or is of invalid type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Promise that resolves to the loaded captions data. </dd></dl>
</div>
</div>
<a id="a3b6ac7a3a6542d7ae590078637ffafd3" name="a3b6ac7a3a6542d7ae590078637ffafd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b6ac7a3a6542d7ae590078637ffafd3">◆ </a></span>loadTrack()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::loadTrack </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>search</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Loads a track.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">search</td><td>The search query for the track. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The loaded track data. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the search is not provided or is of invalid type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa3f98211ed034feb0ffb5c040d36258c" name="aa3f98211ed034feb0ffb5c040d36258c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3f98211ed034feb0ffb5c040d36258c">◆ </a></span>playerCreated()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::playerCreated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Verifies if a player exists for the guild.</p>
<dl class="section return"><dt>Returns</dt><dd>The boolean if the player exists or not. </dd></dl>
</div>
</div>
<a id="af59bd53d7459c593066a1d6c918be78e" name="af59bd53d7459c593066a1d6c918be78e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af59bd53d7459c593066a1d6c918be78e">◆ </a></span>skipTrack()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::skipTrack </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Skips the currently playing track.</p>
<dl class="section return"><dt>Returns</dt><dd>The queue of tracks, or null if there is no queue. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the queue is disabled </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab3237b15576c59b02f97b539d3bdc829" name="ab3237b15576c59b02f97b539d3bdc829"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3237b15576c59b02f97b539d3bdc829">◆ </a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::update </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>body</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>noReplace</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Updates the player state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">body</td><td>The body of the update request. </td></tr>
<tr><td class="paramname">noReplace</td><td>Flag to specify whether to replace the existing track or not. Optional. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the body is not provided or is of invalid type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0810a83214fd92f31570bfa5357f13e5" name="a0810a83214fd92f31570bfa5357f13e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0810a83214fd92f31570bfa5357f13e5">◆ </a></span>updateSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Player::updateSession </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Updates the session data for the player.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The session data to update. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>If the data is not provided or is of invalid type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="index_8js.html">index.js</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>