capacitor-plugin-playlist 0.2.3 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/docs.json DELETED
@@ -1,782 +0,0 @@
1
- {
2
- "api": {
3
- "name": "PlaylistPlugin",
4
- "slug": "playlistplugin",
5
- "docs": "",
6
- "tags": [],
7
- "methods": [
8
- {
9
- "name": "addListener",
10
- "signature": "(eventName: 'status', listenerFunc: PlaylistStatusChangeCallback) => PluginListenerHandle",
11
- "parameters": [
12
- {
13
- "name": "eventName",
14
- "docs": "",
15
- "type": "\"status\""
16
- },
17
- {
18
- "name": "listenerFunc",
19
- "docs": "",
20
- "type": "(data: PlaylistStatusChangeCallbackArg) => void"
21
- }
22
- ],
23
- "returns": "PluginListenerHandle",
24
- "tags": [],
25
- "docs": "Listen for screen reader state change (on/off)",
26
- "complexTypes": [
27
- "PluginListenerHandle",
28
- "PlaylistStatusChangeCallback"
29
- ],
30
- "slug": "addlistener"
31
- },
32
- {
33
- "name": "setOptions",
34
- "signature": "(options: AudioPlayerOptions) => any",
35
- "parameters": [
36
- {
37
- "name": "options",
38
- "docs": "",
39
- "type": "AudioPlayerOptions"
40
- }
41
- ],
42
- "returns": "any",
43
- "tags": [],
44
- "docs": "",
45
- "complexTypes": [
46
- "AudioPlayerOptions"
47
- ],
48
- "slug": "setoptions"
49
- },
50
- {
51
- "name": "initialize",
52
- "signature": "() => any",
53
- "parameters": [],
54
- "returns": "any",
55
- "tags": [],
56
- "docs": "",
57
- "complexTypes": [],
58
- "slug": "initialize"
59
- },
60
- {
61
- "name": "release",
62
- "signature": "() => any",
63
- "parameters": [],
64
- "returns": "any",
65
- "tags": [],
66
- "docs": "",
67
- "complexTypes": [],
68
- "slug": "release"
69
- },
70
- {
71
- "name": "setPlaylistItems",
72
- "signature": "(options: PlaylistOptions) => any",
73
- "parameters": [
74
- {
75
- "name": "options",
76
- "docs": "",
77
- "type": "PlaylistOptions"
78
- }
79
- ],
80
- "returns": "any",
81
- "tags": [],
82
- "docs": "",
83
- "complexTypes": [
84
- "PlaylistOptions"
85
- ],
86
- "slug": "setplaylistitems"
87
- },
88
- {
89
- "name": "addItem",
90
- "signature": "(options: AddItemOptions) => any",
91
- "parameters": [
92
- {
93
- "name": "options",
94
- "docs": "",
95
- "type": "AddItemOptions"
96
- }
97
- ],
98
- "returns": "any",
99
- "tags": [],
100
- "docs": "",
101
- "complexTypes": [
102
- "AddItemOptions"
103
- ],
104
- "slug": "additem"
105
- },
106
- {
107
- "name": "addAllItems",
108
- "signature": "(options: AddAllItemOptions) => any",
109
- "parameters": [
110
- {
111
- "name": "options",
112
- "docs": "",
113
- "type": "AddAllItemOptions"
114
- }
115
- ],
116
- "returns": "any",
117
- "tags": [],
118
- "docs": "",
119
- "complexTypes": [
120
- "AddAllItemOptions"
121
- ],
122
- "slug": "addallitems"
123
- },
124
- {
125
- "name": "removeItem",
126
- "signature": "(options: RemoveItemOptions) => any",
127
- "parameters": [
128
- {
129
- "name": "options",
130
- "docs": "",
131
- "type": "RemoveItemOptions"
132
- }
133
- ],
134
- "returns": "any",
135
- "tags": [],
136
- "docs": "",
137
- "complexTypes": [
138
- "RemoveItemOptions"
139
- ],
140
- "slug": "removeitem"
141
- },
142
- {
143
- "name": "removeItems",
144
- "signature": "(options: RemoveItemsOptions) => any",
145
- "parameters": [
146
- {
147
- "name": "options",
148
- "docs": "",
149
- "type": "RemoveItemsOptions"
150
- }
151
- ],
152
- "returns": "any",
153
- "tags": [],
154
- "docs": "",
155
- "complexTypes": [
156
- "RemoveItemsOptions"
157
- ],
158
- "slug": "removeitems"
159
- },
160
- {
161
- "name": "clearAllItems",
162
- "signature": "() => any",
163
- "parameters": [],
164
- "returns": "any",
165
- "tags": [],
166
- "docs": "",
167
- "complexTypes": [],
168
- "slug": "clearallitems"
169
- },
170
- {
171
- "name": "play",
172
- "signature": "() => any",
173
- "parameters": [],
174
- "returns": "any",
175
- "tags": [],
176
- "docs": "",
177
- "complexTypes": [],
178
- "slug": "play"
179
- },
180
- {
181
- "name": "pause",
182
- "signature": "() => any",
183
- "parameters": [],
184
- "returns": "any",
185
- "tags": [],
186
- "docs": "",
187
- "complexTypes": [],
188
- "slug": "pause"
189
- },
190
- {
191
- "name": "skipForward",
192
- "signature": "() => any",
193
- "parameters": [],
194
- "returns": "any",
195
- "tags": [],
196
- "docs": "",
197
- "complexTypes": [],
198
- "slug": "skipforward"
199
- },
200
- {
201
- "name": "skipBack",
202
- "signature": "() => any",
203
- "parameters": [],
204
- "returns": "any",
205
- "tags": [],
206
- "docs": "",
207
- "complexTypes": [],
208
- "slug": "skipback"
209
- },
210
- {
211
- "name": "seekTo",
212
- "signature": "(options: SeekToOptions) => any",
213
- "parameters": [
214
- {
215
- "name": "options",
216
- "docs": "",
217
- "type": "SeekToOptions"
218
- }
219
- ],
220
- "returns": "any",
221
- "tags": [],
222
- "docs": "",
223
- "complexTypes": [
224
- "SeekToOptions"
225
- ],
226
- "slug": "seekto"
227
- },
228
- {
229
- "name": "playTrackByIndex",
230
- "signature": "(options: PlayByIndexOptions) => any",
231
- "parameters": [
232
- {
233
- "name": "options",
234
- "docs": "",
235
- "type": "PlayByIndexOptions"
236
- }
237
- ],
238
- "returns": "any",
239
- "tags": [],
240
- "docs": "",
241
- "complexTypes": [
242
- "PlayByIndexOptions"
243
- ],
244
- "slug": "playtrackbyindex"
245
- },
246
- {
247
- "name": "playTrackById",
248
- "signature": "(options: PlayByIdOptions) => any",
249
- "parameters": [
250
- {
251
- "name": "options",
252
- "docs": "",
253
- "type": "PlayByIdOptions"
254
- }
255
- ],
256
- "returns": "any",
257
- "tags": [],
258
- "docs": "",
259
- "complexTypes": [
260
- "PlayByIdOptions"
261
- ],
262
- "slug": "playtrackbyid"
263
- },
264
- {
265
- "name": "selectTrackByIndex",
266
- "signature": "(options: SelectByIndexOptions) => any",
267
- "parameters": [
268
- {
269
- "name": "options",
270
- "docs": "",
271
- "type": "SelectByIndexOptions"
272
- }
273
- ],
274
- "returns": "any",
275
- "tags": [],
276
- "docs": "",
277
- "complexTypes": [
278
- "SelectByIndexOptions"
279
- ],
280
- "slug": "selecttrackbyindex"
281
- },
282
- {
283
- "name": "selectTrackById",
284
- "signature": "(options: SelectByIdOptions) => any",
285
- "parameters": [
286
- {
287
- "name": "options",
288
- "docs": "",
289
- "type": "SelectByIdOptions"
290
- }
291
- ],
292
- "returns": "any",
293
- "tags": [],
294
- "docs": "",
295
- "complexTypes": [
296
- "SelectByIdOptions"
297
- ],
298
- "slug": "selecttrackbyid"
299
- },
300
- {
301
- "name": "setPlaybackVolume",
302
- "signature": "(options: SetPlaybackVolumeOptions) => any",
303
- "parameters": [
304
- {
305
- "name": "options",
306
- "docs": "",
307
- "type": "SetPlaybackVolumeOptions"
308
- }
309
- ],
310
- "returns": "any",
311
- "tags": [],
312
- "docs": "",
313
- "complexTypes": [
314
- "SetPlaybackVolumeOptions"
315
- ],
316
- "slug": "setplaybackvolume"
317
- },
318
- {
319
- "name": "setLoop",
320
- "signature": "(options: SetLoopOptions) => any",
321
- "parameters": [
322
- {
323
- "name": "options",
324
- "docs": "",
325
- "type": "SetLoopOptions"
326
- }
327
- ],
328
- "returns": "any",
329
- "tags": [],
330
- "docs": "",
331
- "complexTypes": [
332
- "SetLoopOptions"
333
- ],
334
- "slug": "setloop"
335
- },
336
- {
337
- "name": "setPlaybackRate",
338
- "signature": "(options: SetPlaybackRateOptions) => any",
339
- "parameters": [
340
- {
341
- "name": "options",
342
- "docs": "",
343
- "type": "SetPlaybackRateOptions"
344
- }
345
- ],
346
- "returns": "any",
347
- "tags": [],
348
- "docs": "",
349
- "complexTypes": [
350
- "SetPlaybackRateOptions"
351
- ],
352
- "slug": "setplaybackrate"
353
- }
354
- ],
355
- "properties": []
356
- },
357
- "interfaces": [
358
- {
359
- "name": "PluginListenerHandle",
360
- "slug": "pluginlistenerhandle",
361
- "docs": "",
362
- "tags": [],
363
- "methods": [],
364
- "properties": [
365
- {
366
- "name": "remove",
367
- "tags": [],
368
- "docs": "",
369
- "complexTypes": [],
370
- "type": "() => any"
371
- }
372
- ]
373
- },
374
- {
375
- "name": "AudioPlayerOptions",
376
- "slug": "audioplayeroptions",
377
- "docs": "Options governing the overall behavior of the audio player plugin",
378
- "tags": [],
379
- "methods": [],
380
- "properties": [
381
- {
382
- "name": "verbose",
383
- "tags": [],
384
- "docs": "Should the plugin's javascript dump the status message stream to the javascript console?",
385
- "complexTypes": [],
386
- "type": "boolean | undefined"
387
- },
388
- {
389
- "name": "resetStreamOnPause",
390
- "tags": [],
391
- "docs": "If true, when pausing a live stream, play will continue from the LIVE POSITION (e.g. the stream\njumps forward to the current point in time, rather than picking up where it left off when you paused).\nIf false, the stream will continue where you paused. The drawback of doing this is that when the audio\nbuffer fills, it will jump forward to the current point in time, cause a disjoint in playback.\n\nDefault is true.",
392
- "complexTypes": [],
393
- "type": "boolean | undefined"
394
- },
395
- {
396
- "name": "options",
397
- "tags": [],
398
- "docs": "Further options for notifications",
399
- "complexTypes": [
400
- "NotificationOptions"
401
- ],
402
- "type": "NotificationOptions | undefined"
403
- }
404
- ]
405
- },
406
- {
407
- "name": "NotificationOptions",
408
- "slug": "notificationoptions",
409
- "docs": "",
410
- "tags": [],
411
- "methods": [],
412
- "properties": [
413
- {
414
- "name": "icon",
415
- "tags": [],
416
- "docs": "",
417
- "complexTypes": [],
418
- "type": "string | undefined"
419
- }
420
- ]
421
- },
422
- {
423
- "name": "PlaylistOptions",
424
- "slug": "playlistoptions",
425
- "docs": "",
426
- "tags": [],
427
- "methods": [],
428
- "properties": [
429
- {
430
- "name": "items",
431
- "tags": [],
432
- "docs": "",
433
- "complexTypes": [
434
- "Array",
435
- "AudioTrack"
436
- ],
437
- "type": "any"
438
- },
439
- {
440
- "name": "options",
441
- "tags": [],
442
- "docs": "",
443
- "complexTypes": [
444
- "PlaylistItemOptions"
445
- ],
446
- "type": "PlaylistItemOptions"
447
- }
448
- ]
449
- },
450
- {
451
- "name": "AudioTrack",
452
- "slug": "audiotrack",
453
- "docs": "An audio track for playback by the playlist.",
454
- "tags": [],
455
- "methods": [],
456
- "properties": [
457
- {
458
- "name": "isStream",
459
- "tags": [],
460
- "docs": "This item is a streaming asset. Make sure this is set to true for stream URLs,\notherwise you will get odd behavior when the asset is paused.",
461
- "complexTypes": [],
462
- "type": "boolean | undefined"
463
- },
464
- {
465
- "name": "trackId",
466
- "tags": [],
467
- "docs": "trackId is optional and if not passed in, an auto-generated UUID will be used.",
468
- "complexTypes": [],
469
- "type": "string | undefined"
470
- },
471
- {
472
- "name": "assetUrl",
473
- "tags": [],
474
- "docs": "URL of the asset; can be local, a URL, or a streaming URL.\nIf the asset is a stream, make sure that isStream is set to true,\notherwise the plugin can't properly handle the item's buffer.",
475
- "complexTypes": [],
476
- "type": "string"
477
- },
478
- {
479
- "name": "albumArt",
480
- "tags": [],
481
- "docs": "The local or remote URL to an image asset to be shown for this track.\nIf this is null, the plugin's default image is used.",
482
- "complexTypes": [],
483
- "type": "string | undefined"
484
- },
485
- {
486
- "name": "artist",
487
- "tags": [],
488
- "docs": "The track's artist",
489
- "complexTypes": [],
490
- "type": "string"
491
- },
492
- {
493
- "name": "album",
494
- "tags": [],
495
- "docs": "Album the track belongs to",
496
- "complexTypes": [],
497
- "type": "string"
498
- },
499
- {
500
- "name": "title",
501
- "tags": [],
502
- "docs": "Title of the track",
503
- "complexTypes": [],
504
- "type": "string"
505
- }
506
- ]
507
- },
508
- {
509
- "name": "PlaylistItemOptions",
510
- "slug": "playlistitemoptions",
511
- "docs": "Options governing how the items are managed when using setPlaylistItems\nto update the playlist. This is typically useful if you are retaining items\nthat were in the previous list.",
512
- "tags": [],
513
- "methods": [],
514
- "properties": [
515
- {
516
- "name": "retainPosition",
517
- "tags": [],
518
- "docs": "If true, the plugin will continue playback from the current playback position after\nsetting the items to the playlist.",
519
- "complexTypes": [],
520
- "type": "boolean | undefined"
521
- },
522
- {
523
- "name": "playFromPosition",
524
- "tags": [],
525
- "docs": "If retainPosition is true, this value will tell the plugin the exact time to start from,\nrather than letting the plugin decide based on current playback.",
526
- "complexTypes": [],
527
- "type": "number | undefined"
528
- },
529
- {
530
- "name": "playFromId",
531
- "tags": [],
532
- "docs": "If retainPosition is true, this value will tell the plugin the uid of the \"current\" item to start from,\nrather than letting the plugin decide based on current playback.",
533
- "complexTypes": [],
534
- "type": "string | undefined"
535
- },
536
- {
537
- "name": "startPaused",
538
- "tags": [],
539
- "docs": "If playback should immediately begin when calling setPlaylistItems on the plugin.\nDefault is false;",
540
- "complexTypes": [],
541
- "type": "boolean | undefined"
542
- }
543
- ]
544
- },
545
- {
546
- "name": "AddItemOptions",
547
- "slug": "additemoptions",
548
- "docs": "",
549
- "tags": [],
550
- "methods": [],
551
- "properties": [
552
- {
553
- "name": "item",
554
- "tags": [],
555
- "docs": "",
556
- "complexTypes": [
557
- "AudioTrack"
558
- ],
559
- "type": "AudioTrack"
560
- }
561
- ]
562
- },
563
- {
564
- "name": "AddAllItemOptions",
565
- "slug": "addallitemoptions",
566
- "docs": "",
567
- "tags": [],
568
- "methods": [],
569
- "properties": [
570
- {
571
- "name": "items",
572
- "tags": [],
573
- "docs": "",
574
- "complexTypes": [
575
- "Array",
576
- "AudioTrack"
577
- ],
578
- "type": "any"
579
- }
580
- ]
581
- },
582
- {
583
- "name": "RemoveItemOptions",
584
- "slug": "removeitemoptions",
585
- "docs": "",
586
- "tags": [],
587
- "methods": [],
588
- "properties": [
589
- {
590
- "name": "id",
591
- "tags": [],
592
- "docs": "",
593
- "complexTypes": [],
594
- "type": "string | undefined"
595
- },
596
- {
597
- "name": "index",
598
- "tags": [],
599
- "docs": "",
600
- "complexTypes": [],
601
- "type": "number | undefined"
602
- }
603
- ]
604
- },
605
- {
606
- "name": "RemoveItemsOptions",
607
- "slug": "removeitemsoptions",
608
- "docs": "",
609
- "tags": [],
610
- "methods": [],
611
- "properties": [
612
- {
613
- "name": "items",
614
- "tags": [],
615
- "docs": "",
616
- "complexTypes": [
617
- "Array",
618
- "RemoveItemOptions"
619
- ],
620
- "type": "any"
621
- }
622
- ]
623
- },
624
- {
625
- "name": "SeekToOptions",
626
- "slug": "seektooptions",
627
- "docs": "",
628
- "tags": [],
629
- "methods": [],
630
- "properties": [
631
- {
632
- "name": "position",
633
- "tags": [],
634
- "docs": "",
635
- "complexTypes": [],
636
- "type": "number"
637
- }
638
- ]
639
- },
640
- {
641
- "name": "PlayByIndexOptions",
642
- "slug": "playbyindexoptions",
643
- "docs": "",
644
- "tags": [],
645
- "methods": [],
646
- "properties": [
647
- {
648
- "name": "index",
649
- "tags": [],
650
- "docs": "",
651
- "complexTypes": [],
652
- "type": "number"
653
- },
654
- {
655
- "name": "position",
656
- "tags": [],
657
- "docs": "",
658
- "complexTypes": [],
659
- "type": "number | undefined"
660
- }
661
- ]
662
- },
663
- {
664
- "name": "PlayByIdOptions",
665
- "slug": "playbyidoptions",
666
- "docs": "",
667
- "tags": [],
668
- "methods": [],
669
- "properties": [
670
- {
671
- "name": "id",
672
- "tags": [],
673
- "docs": "",
674
- "complexTypes": [],
675
- "type": "string"
676
- },
677
- {
678
- "name": "position",
679
- "tags": [],
680
- "docs": "",
681
- "complexTypes": [],
682
- "type": "number | undefined"
683
- }
684
- ]
685
- },
686
- {
687
- "name": "SelectByIndexOptions",
688
- "slug": "selectbyindexoptions",
689
- "docs": "",
690
- "tags": [],
691
- "methods": [],
692
- "properties": [
693
- {
694
- "name": "index",
695
- "tags": [],
696
- "docs": "",
697
- "complexTypes": [],
698
- "type": "number"
699
- },
700
- {
701
- "name": "position",
702
- "tags": [],
703
- "docs": "",
704
- "complexTypes": [],
705
- "type": "number | undefined"
706
- }
707
- ]
708
- },
709
- {
710
- "name": "SelectByIdOptions",
711
- "slug": "selectbyidoptions",
712
- "docs": "",
713
- "tags": [],
714
- "methods": [],
715
- "properties": [
716
- {
717
- "name": "id",
718
- "tags": [],
719
- "docs": "",
720
- "complexTypes": [],
721
- "type": "string"
722
- },
723
- {
724
- "name": "position",
725
- "tags": [],
726
- "docs": "",
727
- "complexTypes": [],
728
- "type": "number | undefined"
729
- }
730
- ]
731
- },
732
- {
733
- "name": "SetPlaybackVolumeOptions",
734
- "slug": "setplaybackvolumeoptions",
735
- "docs": "",
736
- "tags": [],
737
- "methods": [],
738
- "properties": [
739
- {
740
- "name": "volume",
741
- "tags": [],
742
- "docs": "",
743
- "complexTypes": [],
744
- "type": "number"
745
- }
746
- ]
747
- },
748
- {
749
- "name": "SetLoopOptions",
750
- "slug": "setloopoptions",
751
- "docs": "",
752
- "tags": [],
753
- "methods": [],
754
- "properties": [
755
- {
756
- "name": "loop",
757
- "tags": [],
758
- "docs": "",
759
- "complexTypes": [],
760
- "type": "boolean"
761
- }
762
- ]
763
- },
764
- {
765
- "name": "SetPlaybackRateOptions",
766
- "slug": "setplaybackrateoptions",
767
- "docs": "",
768
- "tags": [],
769
- "methods": [],
770
- "properties": [
771
- {
772
- "name": "rate",
773
- "tags": [],
774
- "docs": "",
775
- "complexTypes": [],
776
- "type": "number"
777
- }
778
- ]
779
- }
780
- ],
781
- "enums": []
782
- }