videojs-mobile-ui 1.2.0-alpha.0 → 1.2.1

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.
Files changed (53) hide show
  1. package/README.md +104 -53
  2. package/dist/lang/de.js +1 -3
  3. package/dist/lang/en.js +1 -3
  4. package/dist/lang/it.js +1 -3
  5. package/dist/videojs-mobile-ui.cjs.js +195 -43
  6. package/dist/videojs-mobile-ui.css +104 -2
  7. package/dist/videojs-mobile-ui.es.js +195 -43
  8. package/dist/videojs-mobile-ui.js +204 -53
  9. package/dist/videojs-mobile-ui.min.js +2 -2
  10. package/docs/api/TouchOverlay.html +964 -0
  11. package/docs/api/fonts/OpenSans-Bold-webfont.eot +0 -0
  12. package/docs/api/fonts/OpenSans-Bold-webfont.svg +1830 -0
  13. package/docs/api/fonts/OpenSans-Bold-webfont.woff +0 -0
  14. package/docs/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  15. package/docs/api/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  16. package/docs/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  17. package/docs/api/fonts/OpenSans-Italic-webfont.eot +0 -0
  18. package/docs/api/fonts/OpenSans-Italic-webfont.svg +1830 -0
  19. package/docs/api/fonts/OpenSans-Italic-webfont.woff +0 -0
  20. package/docs/api/fonts/OpenSans-Light-webfont.eot +0 -0
  21. package/docs/api/fonts/OpenSans-Light-webfont.svg +1831 -0
  22. package/docs/api/fonts/OpenSans-Light-webfont.woff +0 -0
  23. package/docs/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  24. package/docs/api/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  25. package/docs/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  26. package/docs/api/fonts/OpenSans-Regular-webfont.eot +0 -0
  27. package/docs/api/fonts/OpenSans-Regular-webfont.svg +1831 -0
  28. package/docs/api/fonts/OpenSans-Regular-webfont.woff +0 -0
  29. package/docs/api/global.html +957 -0
  30. package/docs/api/index.html +159 -0
  31. package/docs/api/plugin.js.html +221 -0
  32. package/docs/api/scripts/linenumber.js +25 -0
  33. package/docs/api/scripts/prettify/Apache-License-2.0.txt +202 -0
  34. package/docs/api/scripts/prettify/lang-css.js +2 -0
  35. package/docs/api/scripts/prettify/prettify.js +28 -0
  36. package/docs/api/styles/jsdoc-default.css +358 -0
  37. package/docs/api/styles/prettify-jsdoc.css +111 -0
  38. package/docs/api/styles/prettify-tomorrow.css +132 -0
  39. package/docs/api/swipeFullscreen.js.html +173 -0
  40. package/docs/api/touchOverlay.js.html +211 -0
  41. package/index.html +238 -170
  42. package/package.json +23 -13
  43. package/scripts/lang.js +24 -0
  44. package/scripts/netlify.js +16 -0
  45. package/scripts/postcss.config.js +29 -5
  46. package/scripts/readme-options.js +370 -0
  47. package/scripts/rollup.config.js +0 -8
  48. package/src/plugin.css +6 -0
  49. package/src/plugin.js +65 -39
  50. package/src/swipeFullscreen.js +122 -0
  51. package/src/touchOverlay.js +7 -3
  52. package/test/plugin.test.js +125 -18
  53. package/test/swipeFullscreen.test.js +365 -0
@@ -0,0 +1,957 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Global</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Global</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2></h2>
32
+
33
+
34
+ </header>
35
+
36
+ <article>
37
+ <div class="container-overview">
38
+
39
+
40
+
41
+
42
+
43
+
44
+ <dl class="details">
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
+ </dl>
78
+
79
+
80
+
81
+
82
+ </div>
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h3 class="subsection-title">Methods</h3>
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ <h4 class="name" id="mobileUi"><span class="type-signature"></span>mobileUi<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
108
+
109
+
110
+
111
+
112
+
113
+
114
+ <div class="description">
115
+ <p>A video.js plugin.</p>
116
+ <p>Adds a monile UI for player control, and fullscreen orientation control</p>
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <h5>Parameters:</h5>
128
+
129
+
130
+ <table class="params">
131
+ <thead>
132
+ <tr>
133
+
134
+ <th>Name</th>
135
+
136
+
137
+ <th>Type</th>
138
+
139
+
140
+ <th>Attributes</th>
141
+
142
+
143
+
144
+ <th>Default</th>
145
+
146
+
147
+ <th class="last">Description</th>
148
+ </tr>
149
+ </thead>
150
+
151
+ <tbody>
152
+
153
+
154
+ <tr>
155
+
156
+ <td class="name"><code>options</code></td>
157
+
158
+
159
+ <td class="type">
160
+
161
+
162
+ <span class="param-type">Object</span>
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+ <td class="attributes">
170
+
171
+ &lt;optional><br>
172
+
173
+
174
+
175
+
176
+
177
+ </td>
178
+
179
+
180
+
181
+ <td class="default">
182
+
183
+ {}
184
+
185
+ </td>
186
+
187
+
188
+ <td class="description last"><p>Plugin options.</p>
189
+ <h6>Properties</h6>
190
+
191
+
192
+ <table class="params">
193
+ <thead>
194
+ <tr>
195
+
196
+ <th>Name</th>
197
+
198
+
199
+ <th>Type</th>
200
+
201
+
202
+ <th>Attributes</th>
203
+
204
+
205
+
206
+ <th>Default</th>
207
+
208
+
209
+ <th class="last">Description</th>
210
+ </tr>
211
+ </thead>
212
+
213
+ <tbody>
214
+
215
+
216
+ <tr>
217
+
218
+ <td class="name"><code>forceForTesting</code></td>
219
+
220
+
221
+ <td class="type">
222
+
223
+
224
+ <span class="param-type">boolean</span>
225
+
226
+
227
+
228
+ </td>
229
+
230
+
231
+ <td class="attributes">
232
+
233
+ &lt;optional><br>
234
+
235
+
236
+
237
+
238
+
239
+ </td>
240
+
241
+
242
+
243
+ <td class="default">
244
+
245
+ false
246
+
247
+ </td>
248
+
249
+
250
+ <td class="description last"><p>Enables the display regardless of user agent, for testing purposes</p></td>
251
+ </tr>
252
+
253
+
254
+
255
+ <tr>
256
+
257
+ <td class="name"><code>fullscreen</code></td>
258
+
259
+
260
+ <td class="type">
261
+
262
+
263
+ <span class="param-type">Object</span>
264
+
265
+
266
+
267
+ </td>
268
+
269
+
270
+ <td class="attributes">
271
+
272
+ &lt;optional><br>
273
+
274
+
275
+
276
+
277
+
278
+ </td>
279
+
280
+
281
+
282
+ <td class="default">
283
+
284
+ {}
285
+
286
+ </td>
287
+
288
+
289
+ <td class="description last"><p>Fullscreen options.</p>
290
+ <h6>Properties</h6>
291
+
292
+
293
+ <table class="params">
294
+ <thead>
295
+ <tr>
296
+
297
+ <th>Name</th>
298
+
299
+
300
+ <th>Type</th>
301
+
302
+
303
+ <th>Attributes</th>
304
+
305
+
306
+
307
+ <th>Default</th>
308
+
309
+
310
+ <th class="last">Description</th>
311
+ </tr>
312
+ </thead>
313
+
314
+ <tbody>
315
+
316
+
317
+ <tr>
318
+
319
+ <td class="name"><code>enterOnRotate</code></td>
320
+
321
+
322
+ <td class="type">
323
+
324
+
325
+ <span class="param-type">boolean</span>
326
+
327
+
328
+
329
+ </td>
330
+
331
+
332
+ <td class="attributes">
333
+
334
+ &lt;optional><br>
335
+
336
+
337
+
338
+
339
+
340
+ </td>
341
+
342
+
343
+
344
+ <td class="default">
345
+
346
+ true
347
+
348
+ </td>
349
+
350
+
351
+ <td class="description last"><p>Whether to go fullscreen when rotating to landscape</p></td>
352
+ </tr>
353
+
354
+
355
+
356
+ <tr>
357
+
358
+ <td class="name"><code>exitOnRotate</code></td>
359
+
360
+
361
+ <td class="type">
362
+
363
+
364
+ <span class="param-type">boolean</span>
365
+
366
+
367
+
368
+ </td>
369
+
370
+
371
+ <td class="attributes">
372
+
373
+ &lt;optional><br>
374
+
375
+
376
+
377
+
378
+
379
+ </td>
380
+
381
+
382
+
383
+ <td class="default">
384
+
385
+ true
386
+
387
+ </td>
388
+
389
+
390
+ <td class="description last"><p>Whether to leave fullscreen when rotating to portrait (if not locked)</p></td>
391
+ </tr>
392
+
393
+
394
+
395
+ <tr>
396
+
397
+ <td class="name"><code>lockOnRotate</code></td>
398
+
399
+
400
+ <td class="type">
401
+
402
+
403
+ <span class="param-type">boolean</span>
404
+
405
+
406
+
407
+ </td>
408
+
409
+
410
+ <td class="attributes">
411
+
412
+ &lt;optional><br>
413
+
414
+
415
+
416
+
417
+
418
+ </td>
419
+
420
+
421
+
422
+ <td class="default">
423
+
424
+ true
425
+
426
+ </td>
427
+
428
+
429
+ <td class="description last"><p>Whether to lock orientation when rotating to landscape
430
+ Unlocked when exiting fullscreen or on 'ended'</p></td>
431
+ </tr>
432
+
433
+
434
+
435
+ <tr>
436
+
437
+ <td class="name"><code>iOS</code></td>
438
+
439
+
440
+ <td class="type">
441
+
442
+
443
+ <span class="param-type">boolean</span>
444
+
445
+
446
+
447
+ </td>
448
+
449
+
450
+ <td class="attributes">
451
+
452
+ &lt;optional><br>
453
+
454
+
455
+
456
+
457
+
458
+ </td>
459
+
460
+
461
+
462
+ <td class="default">
463
+
464
+ false
465
+
466
+ </td>
467
+
468
+
469
+ <td class="description last"><p>Whether to disable iOS's native fullscreen so controls can work</p></td>
470
+ </tr>
471
+
472
+
473
+ </tbody>
474
+ </table>
475
+
476
+ </td>
477
+ </tr>
478
+
479
+
480
+
481
+ <tr>
482
+
483
+ <td class="name"><code>touchControls</code></td>
484
+
485
+
486
+ <td class="type">
487
+
488
+
489
+ <span class="param-type">Object</span>
490
+
491
+
492
+
493
+ </td>
494
+
495
+
496
+ <td class="attributes">
497
+
498
+ &lt;optional><br>
499
+
500
+
501
+
502
+
503
+
504
+ </td>
505
+
506
+
507
+
508
+ <td class="default">
509
+
510
+ {}
511
+
512
+ </td>
513
+
514
+
515
+ <td class="description last"><p>Touch UI options.</p>
516
+ <h6>Properties</h6>
517
+
518
+
519
+ <table class="params">
520
+ <thead>
521
+ <tr>
522
+
523
+ <th>Name</th>
524
+
525
+
526
+ <th>Type</th>
527
+
528
+
529
+ <th>Attributes</th>
530
+
531
+
532
+
533
+ <th>Default</th>
534
+
535
+
536
+ <th class="last">Description</th>
537
+ </tr>
538
+ </thead>
539
+
540
+ <tbody>
541
+
542
+
543
+ <tr>
544
+
545
+ <td class="name"><code>seekSeconds</code></td>
546
+
547
+
548
+ <td class="type">
549
+
550
+
551
+ <span class="param-type">int</span>
552
+
553
+
554
+
555
+ </td>
556
+
557
+
558
+ <td class="attributes">
559
+
560
+ &lt;optional><br>
561
+
562
+
563
+
564
+
565
+
566
+ </td>
567
+
568
+
569
+
570
+ <td class="default">
571
+
572
+ 10
573
+
574
+ </td>
575
+
576
+
577
+ <td class="description last"><p>Number of seconds to seek on double-tap</p></td>
578
+ </tr>
579
+
580
+
581
+
582
+ <tr>
583
+
584
+ <td class="name"><code>tapTimeout</code></td>
585
+
586
+
587
+ <td class="type">
588
+
589
+
590
+ <span class="param-type">int</span>
591
+
592
+
593
+
594
+ </td>
595
+
596
+
597
+ <td class="attributes">
598
+
599
+ &lt;optional><br>
600
+
601
+
602
+
603
+
604
+
605
+ </td>
606
+
607
+
608
+
609
+ <td class="default">
610
+
611
+ 300
612
+
613
+ </td>
614
+
615
+
616
+ <td class="description last"><p>Interval in ms to be considered a doubletap</p></td>
617
+ </tr>
618
+
619
+
620
+
621
+ <tr>
622
+
623
+ <td class="name"><code>disableOnEnd</code></td>
624
+
625
+
626
+ <td class="type">
627
+
628
+
629
+ <span class="param-type">boolean</span>
630
+
631
+
632
+
633
+ </td>
634
+
635
+
636
+ <td class="attributes">
637
+
638
+ &lt;optional><br>
639
+
640
+
641
+
642
+
643
+
644
+ </td>
645
+
646
+
647
+
648
+ <td class="default">
649
+
650
+ false
651
+
652
+ </td>
653
+
654
+
655
+ <td class="description last"><p>Whether to disable when the video ends (e.g., if there is an endscreen)
656
+ Never shows if the endscreen plugin is present</p></td>
657
+ </tr>
658
+
659
+
660
+ </tbody>
661
+ </table>
662
+
663
+ </td>
664
+ </tr>
665
+
666
+
667
+ </tbody>
668
+ </table>
669
+
670
+ </td>
671
+ </tr>
672
+
673
+
674
+ </tbody>
675
+ </table>
676
+
677
+
678
+
679
+
680
+
681
+
682
+ <dl class="details">
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+ <dt class="tag-source">Source:</dt>
710
+ <dd class="tag-source"><ul class="dummy"><li>
711
+ <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line125">line 125</a>
712
+ </li></ul></dd>
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+ </dl>
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+ <h4 class="name" id="onPlayerReady"><span class="type-signature"></span>onPlayerReady<span class="signature">(player, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
746
+
747
+
748
+
749
+
750
+
751
+
752
+ <div class="description">
753
+ <p>Add UI and event listeners</p>
754
+ </div>
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+ <h5>Parameters:</h5>
765
+
766
+
767
+ <table class="params">
768
+ <thead>
769
+ <tr>
770
+
771
+ <th>Name</th>
772
+
773
+
774
+ <th>Type</th>
775
+
776
+
777
+ <th>Attributes</th>
778
+
779
+
780
+
781
+ <th>Default</th>
782
+
783
+
784
+ <th class="last">Description</th>
785
+ </tr>
786
+ </thead>
787
+
788
+ <tbody>
789
+
790
+
791
+ <tr>
792
+
793
+ <td class="name"><code>player</code></td>
794
+
795
+
796
+ <td class="type">
797
+
798
+
799
+ <span class="param-type">Player</span>
800
+
801
+
802
+
803
+ </td>
804
+
805
+
806
+ <td class="attributes">
807
+
808
+
809
+
810
+
811
+
812
+ </td>
813
+
814
+
815
+
816
+ <td class="default">
817
+
818
+ </td>
819
+
820
+
821
+ <td class="description last"><p>A Video.js player object.</p></td>
822
+ </tr>
823
+
824
+
825
+
826
+ <tr>
827
+
828
+ <td class="name"><code>options</code></td>
829
+
830
+
831
+ <td class="type">
832
+
833
+
834
+ <span class="param-type">Object</span>
835
+
836
+
837
+
838
+ </td>
839
+
840
+
841
+ <td class="attributes">
842
+
843
+ &lt;optional><br>
844
+
845
+
846
+
847
+
848
+
849
+ </td>
850
+
851
+
852
+
853
+ <td class="default">
854
+
855
+ {}
856
+
857
+ </td>
858
+
859
+
860
+ <td class="description last"><p>A plain object containing options for the plugin.</p></td>
861
+ </tr>
862
+
863
+
864
+ </tbody>
865
+ </table>
866
+
867
+
868
+
869
+
870
+
871
+
872
+ <dl class="details">
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+ <dt class="tag-source">Source:</dt>
900
+ <dd class="tag-source"><ul class="dummy"><li>
901
+ <a href="plugin.js.html">plugin.js</a>, <a href="plugin.js.html#line39">line 39</a>
902
+ </li></ul></dd>
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+ </dl>
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+ </article>
936
+
937
+ </section>
938
+
939
+
940
+
941
+
942
+ </div>
943
+
944
+ <nav>
945
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="TouchOverlay.html">TouchOverlay</a></li></ul><h3>Global</h3><ul><li><a href="global.html#mobileUi">mobileUi</a></li><li><a href="global.html#onPlayerReady">onPlayerReady</a></li></ul>
946
+ </nav>
947
+
948
+ <br class="clear">
949
+
950
+ <footer>
951
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Feb 02 2021 09:43:56 GMT+0100 (CET)
952
+ </footer>
953
+
954
+ <script> prettyPrint(); </script>
955
+ <script src="scripts/linenumber.js"> </script>
956
+ </body>
957
+ </html>