Repository navigation
Expand file tree
/
Copy pathbuildplayer.js
More file actions
1609 lines (1453 loc) · 55.4 KB
/
Copy pathbuildplayer.js
File metadata and controls
1609 lines (1453 loc) · 55.4 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
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
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
710
711
712
713
714
715
716
717
718
719
720
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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
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
900
901
902
903
904
905
906
907
908
909
910
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
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import $ from 'jquery';
import DOMPurify from 'dompurify';
import validate from './validate';
import AccessibleSlider from './slider';
function addBuildplayerFunctions(AblePlayer) {
AblePlayer.prototype.injectPlayerCode = function() {
// create and inject surrounding HTML structure
// If iOS & video:
// iOS does not support any of the player's functionality - everything plays in its own player
// Therefore, AblePlayer is not loaded & all functionality is disabled
// (this all determined. If this is iOS && video, this function is never called)
var captionsContainer;
// Wrappers, from inner to outer:
// $mediaContainer - contains the original media element
// $ableDiv - contains the media player and all its objects (e.g., captions, controls, descriptions)
// $ableWrapper - contains additional widgets (e.g., transcript window, sign window)
this.$mediaContainer = this.$media.wrap('<div class="able-media-container"></div>').parent();
this.$ableDiv = this.$mediaContainer.wrap('<div class="able"></div>').parent();
this.$ableWrapper = this.$ableDiv.wrap('<div class="able-wrapper"></div>').parent();
this.$ableWrapper.addClass('able-skin-' + this.skin);
if (this.mediaType === 'video') {
// youtube adds its own big play button
// don't show ours *unless* video has a poster attribute
// (which obstructs the YouTube poster & big play button)
if (this.player !== 'youtube' || this.hasPoster) {
this.injectBigPlayButton();
}
}
// add container that captions or description will be appended to
// Note: new Jquery object must be assigned _after_ wrap, hence the temp captionsContainer variable
captionsContainer = $('<div>');
captionsContainer.addClass('able-captions-container');
if (this.mediaType === 'video') {
captionsContainer.addClass('able-vidcap-container');
} else if (this.mediaType === 'audio') {
captionsContainer.addClass('able-audcap-container');
// hide this by default. It will be shown if captions are available
captionsContainer.addClass('captions-off');
}
this.injectPlayerControlArea(); // this may need to be injected after captions???
this.$captionsContainer = this.$mediaContainer.wrap(captionsContainer).parent();
this.injectAlert(this.$ableDiv);
this.injectPlaylist();
this.injectAudioPoster();
// Do this last, as it should be prepended to the top of this.$ableDiv
// after everything else has prepended
this.injectOffscreenHeading();
};
AblePlayer.prototype.injectAudioPoster = function() {
if ( this.mediaType === 'audio' && this.hasPoster ) {
const audioPoster = DOMPurify.sanitize(this.audioPoster);
const audioPosterAlt = DOMPurify.sanitize(this.audioPosterAlt);
let audioPosterImg = document.createElement( 'img' );
audioPosterImg.setAttribute( 'src', audioPoster );
audioPosterImg.setAttribute( 'alt', audioPosterAlt );
this.$audioWrapper = this.$playerDiv.wrap( '<div class="able-audio-wrapper">' ).parent();
this.$audioWrapper.prepend( audioPosterImg );
}
}
AblePlayer.prototype.injectOffscreenHeading = function () {
// Inject an offscreen heading to the media container.
// If heading hasn't already been manually defined via data-heading-level,
// automatically assign a level that is one level deeper than the closest parent heading
// as determined by getNextHeadingLevel()
var headingType;
if (this.playerHeadingLevel == '0') {
// do NOT inject a heading (at author's request)
} else {
if (typeof this.playerHeadingLevel === 'undefined') {
this.playerHeadingLevel = this.getNextHeadingLevel(this.$ableDiv); // returns in integer 1-6
}
headingType = 'h' + this.playerHeadingLevel.toString();
this.headingDiv = document.createElement( headingType );
this.$ableDiv.prepend(this.headingDiv);
this.headingDiv.classList.add('able-offscreen');
this.headingDiv.textContent = this.translate( 'playerHeading', 'Media player' );
}
};
AblePlayer.prototype.injectBigPlayButton = function () {
var thisObj = this;
this.$bigPlayButton = $('<button>', {
'class': 'able-big-play-button',
'aria-hidden': false,
'aria-label': this.translate( 'play', 'Play' ),
'type': 'button',
'tabindex': 0
});
this.getIcon( this.$bigPlayButton, 'play' );
this.$bigPlayButton.on( 'click', function () {
thisObj.handlePlay();
});
this.$mediaContainer.append(this.$bigPlayButton);
};
AblePlayer.prototype.injectPlayerControlArea = function () {
this.$playerDiv = $('<div>', {
'class' : 'able-player',
'role' : 'region',
'aria-label' : ( 'audio' === this.mediaType ) ? this.translate( 'audioPlayer', 'audio player' ) : this.translate( 'videoPlayer', 'video player' )
});
this.$playerDiv.addClass('able-' + this.mediaType);
if (this.hasPlaylist && this.showNowPlaying) {
this.$nowPlayingDiv = $('<div>',{
'class' : 'able-now-playing',
'aria-live' : 'assertive',
'aria-atomic': 'true'
});
}
this.$controllerDiv = $('<div>',{
'class' : 'able-controller'
});
this.$controllerDiv.addClass('able-' + this.iconColor + '-controls');
this.$statusBarDiv = $('<div>',{
'class' : 'able-status-bar'
});
this.$timer = $('<span>',{
'class' : 'able-timer'
});
this.$elapsedTimeContainer = $('<span>',{
'class': 'able-elapsedTime',
text: '0:00'
});
this.$durationContainer = $('<span>',{
'class': 'able-duration'
});
this.$durationSeparator = $('<span>',{
'class': 'able-timer-separator',
'text': ' / '
});
this.$timer.append(this.$elapsedTimeContainer).append(this.$durationSeparator).append(this.$durationContainer);
this.$speed = $('<span>',{
'class' : 'able-speed',
'aria-live' : 'assertive',
'aria-atomic' : 'true'
}).text(this.translate( 'speed', 'Speed' ) + ': 1x');
this.$status = $('<span>',{
'class' : 'able-status',
'aria-live' : 'polite'
});
// Put everything together.
this.$statusBarDiv.append(this.$timer, this.$speed, this.$status);
if (this.showNowPlaying) {
this.$playerDiv.append(this.$nowPlayingDiv, this.$controllerDiv, this.$statusBarDiv);
} else {
this.$playerDiv.append(this.$controllerDiv, this.$statusBarDiv);
}
if (this.mediaType === 'video') {
// the player controls go after the media & captions
this.$ableDiv.append(this.$playerDiv);
} else {
// the player controls go before the media & captions
this.$ableDiv.prepend(this.$playerDiv);
}
};
AblePlayer.prototype.injectTextDescriptionArea = function () {
// create a div for writing description text
this.$descDiv = $('<div>',{
'class': 'able-descriptions'
});
// Add ARIA so description will be announced by screen readers
// Later (in description.js > showDescription()),
// if browser supports Web Speech API and this.descMethod === 'browser'
// these attributes will be removed
this.$descDiv.attr({
'aria-live': 'assertive',
'aria-atomic': 'true'
});
// Start off with description hidden.
// It will be exposed conditionally within description.js > initDescription()
this.$descDiv.hide();
this.$ableDiv.append(this.$descDiv);
};
AblePlayer.prototype.getDefaultWidth = function(which) {
let viewportMaxwidth = window.innerWidth;
// return default width of resizable elements
// these values are somewhat arbitrary, but seem to result in good usability
// if users disagree, they can resize (and resposition) them
if (which === 'transcript') {
return ( viewportMaxwidth <= 450 ) ? viewportMaxwidth : 450;
} else if (which === 'sign') {
return ( viewportMaxwidth <= 400 ) ? viewportMaxwidth : 400;
}
};
/**
* Reposition draggable windows when switched into fullscreen.
*
* @param {string} which 'transcript' or 'sign'.
*/
AblePlayer.prototype.rePositionDraggableWindow = function (which) {
let preferences, $window;
preferences = this.getPref();
$window = ( which === 'transcript' ) ? this.$transcriptArea : this.$signWindow;
if ( which === 'transcript' && $window ) {
if (typeof preferences.transcript !== 'undefined') {
this.prevTranscriptPosition = preferences.transcript;
}
$window.css({
'top': 0,
'left': 0
});
} else if ( 'sign' === which && $window ) {
if (typeof preferences.sign !== 'undefined') {
this.prevSignPosition = preferences.sign;
}
$window.css({
'top': 0,
'right': 0,
'left': 'auto'
});
}
}
AblePlayer.prototype.positionDraggableWindow = function (which, width) {
// which is either 'transcript' or 'sign'
var preferences, preferencePos, $window, windowPos, viewportWidth, windowWidth;
preferences = this.getPref();
$window = ( which === 'transcript' ) ? this.$transcriptArea : this.$signWindow;
if ( ! $window ) {
return;
}
if (which === 'transcript') {
if (typeof preferences.transcript !== 'undefined') {
preferencePos = preferences.transcript;
}
if ( this.prevTranscriptPosition ) {
preferencePos = this.prevTranscriptPosition;
this.prevTranscriptPosition = false;
}
} else if (which === 'sign') {
if (typeof preferences.sign !== 'undefined') {
preferencePos = preferences.sign;
}
if ( this.prevSignPosition ) {
preferencePos = this.prevSignPosition;
this.prevSignPosition = false;
}
}
if (typeof preferencePos !== 'undefined' && !($.isEmptyObject(preferencePos))) {
// position window using stored values from preferences
$window.css({
'position': preferencePos['position'],
'width': preferencePos['width'],
'z-index': preferencePos['zindex']
});
if (preferencePos['position'] === 'absolute') {
$window.css({
'top': preferencePos['top'],
'left': preferencePos['left']
});
// Check whether the window is above the top of the viewport.
let topPosition = $window.offset().top;
let leftPosition = $window.offset().left;
viewportWidth = window.innerWidth;
windowWidth = $window.width();
if ( topPosition < 0 ) {
$window.css({
'top': preferencePos['top'] - topPosition
});
}
// If draggable window is off screen to the left.
if ( leftPosition < 0 && ! this.restoringAfterFullscreen ) {
$window.css({
'left': preferencePos['left'] - leftPosition
});
}
// If draggable window is off screen to the right.
if ( viewportWidth - leftPosition < 30 ) {
$window.css({
'left': viewportWidth - windowWidth
});
}
}
// since preferences are not page-specific, z-index needs may vary across different pages
this.updateZIndex(which);
} else {
// position window using default values
windowPos = this.getOptimumPosition(which, width);
if (typeof width === 'undefined') {
width = this.getDefaultWidth(which);
}
$window.css({
'position': windowPos[0],
'width': width,
'z-index': windowPos[3]
});
if (windowPos[0] === 'absolute') {
$window.css({
'top': windowPos[1] + 'px',
'left': windowPos[2] + 'px',
});
}
}
};
AblePlayer.prototype.getOptimumPosition = function (targetWindow, targetWidth) {
// returns optimum position for targetWindow, as an array with the following structure:
// 0 - CSS position ('absolute' or 'relative')
// 1 - top
// 2 - left
// 3 - zindex (if not default)
// targetWindow is either 'transcript' or 'sign'
// if there is room to the right of the player, position element there
// else if there is room the left of the player, position element there
// else position element beneath player
var gap, position, ableWidth, ableOffset, ableLeft, windowWidth, otherWindowWidth;
if (typeof targetWidth === 'undefined') {
targetWidth = this.getDefaultWidth(targetWindow);
}
gap = 5; // number of pixels to preserve between Able Player objects
position = []; // position, top, left
ableWidth = this.$ableDiv.width();
ableOffset = this.$ableDiv.offset();
ableLeft = ableOffset.left;
windowWidth = $(window).width();
otherWindowWidth = 0; // width of other visiable draggable windows will be added to this
if (targetWindow === 'transcript') {
// If placing the transcript window, check position of sign window first.
if (typeof this.$signWindow !== 'undefined' && (this.$signWindow.is(':visible'))) {
otherWindowWidth = this.$signWindow.width() + gap;
}
} else if (targetWindow === 'sign') {
// If placing the sign window, check position of transcript window first.
if (typeof this.$transcriptArea !== 'undefined' && (this.$transcriptArea.is(':visible'))) {
otherWindowWidth = this.$transcriptArea.width() + gap;
}
}
if (targetWidth < (windowWidth - (ableLeft + ableWidth + gap + otherWindowWidth))) {
// there's room to the left of $ableDiv
position[0] = 'absolute';
position[1] = 0;
position[2] = ableWidth + otherWindowWidth + gap;
} else if (targetWidth + gap < ableLeft) {
// there's room to the right of $ableDiv
position[0] = 'absolute';
position[1] = 0;
position[2] = ableLeft - targetWidth - gap;
} else {
// position element below $ableDiv
position[0] = 'relative';
// no need to define top, left, or z-index
}
return position;
};
AblePlayer.prototype.injectAlert = function ($container) {
// inject two alerts, one visible for all users and one for screen reader users only
this.$alertBox = $('<div role="alert"></div>');
this.$alertBox.addClass('able-alert');
this.$alertBox.hide();
var $alertText = $( '<span></span>' );
$alertText.appendTo(this.$alertBox);
var $alertDismiss = $('<button type="button"></button>' );
$alertDismiss.attr( 'aria-label', this.translate( 'dismissButton', 'Dismiss' ) );
$alertDismiss.text( '×' );
$alertDismiss.appendTo(this.$alertBox);
$alertDismiss.on( 'click', function(e) {
$(this).parent('div').hide();
});
this.$alertBox.appendTo($container);
if ( ! this.$srAlertBox ) {
this.$srAlertBox = $('<div role="alert"></div>');
this.$srAlertBox.addClass('able-screenreader-alert');
this.$srAlertBox.appendTo($container);
}
};
AblePlayer.prototype.injectPlaylist = function () {
if (this.playlistEmbed === true) {
// move playlist into player, immediately before statusBarDiv
var playlistClone = this.$playlistDom.clone();
playlistClone.insertBefore(this.$statusBarDiv);
// Update to the new playlist copy.
this.$playlist = playlistClone.find('li');
}
};
AblePlayer.prototype.createPopup = function (which, tracks) {
// Create popup menu and append to player
// 'which' parameter is either 'captions', 'chapters', 'prefs', 'transcript-window' or 'sign-window'
// 'tracks', if provided, is a list of tracks to be used as menu items
var thisObj, $menu, includeMenuItem, i, $menuItem, prefCat, whichPref, hasDefault, track,
windowOptions, $thisItem, $prevItem, $nextItem, hasDescription, hasTranscript;
thisObj = this;
$menu = $('<ul>',{
'id': this.mediaId + '-' + which + '-menu',
'class': 'able-popup',
'role': 'menu'
}).hide();
if (which === 'captions') {
$menu.addClass('able-popup-captions');
}
// Populate menu with menu items
if (which === 'prefs') {
if (this.prefCats.length > 1) {
for (i = 0; i < this.prefCats.length; i++) {
prefCat = this.prefCats[i];
hasDescription = ( thisObj.hasDescTracks || thisObj.hasOpenDesc || thisObj.hasClosedDesc ) ? true : false;
hasTranscript = ( thisObj.transcriptType === null ) ? false : true;
// If this player does not have descriptions or transcripts, do not output that option preferences.
if ( prefCat === 'descriptions' && ! hasDescription || prefCat === 'transcript' && ! hasTranscript ) {
continue;
}
$menuItem = $('<li></li>',{
'role': 'menuitem',
'tabindex': '-1'
});
if (prefCat === 'captions') {
$menuItem.text( this.translate( 'prefMenuCaptions', 'Captions' ) );
} else if (prefCat === 'descriptions') {
$menuItem.text( this.translate( 'prefMenuDescriptions', 'Descriptions' ) );
} else if (prefCat === 'keyboard') {
$menuItem.text( this.translate( 'prefMenuKeyboard', 'Keyboard' ) );
} else if (prefCat === 'transcript') {
$menuItem.text( this.translate( 'prefMenuTranscript', 'Transcript' ) );
}
$menuItem.on('click',function() {
whichPref = $(this).text();
thisObj.showingPrefsDialog = true;
thisObj.setFullscreen(false);
if (whichPref === thisObj.translate( 'prefMenuCaptions', 'Captions' ) ) {
thisObj.showPrefsDialog('captions');
} else if (whichPref === thisObj.translate( 'prefMenuDescriptions', 'Descriptions' ) ) {
thisObj.showPrefsDialog('descriptions');
} else if (whichPref === thisObj.translate( 'prefMenuKeyboard', 'Keyboard' ) ) {
thisObj.showPrefsDialog('keyboard');
} else if (whichPref === thisObj.translate( 'prefMenuTranscript', 'Transcript' ) ) {
thisObj.showPrefsDialog('transcript');
}
thisObj.closePopups();
thisObj.showingPrefsDialog = false;
});
$menu.append($menuItem);
}
this.$prefsButton.attr('data-prefs-popup','menu');
} else if (this.prefCats.length == 1) {
// only 1 category, so don't create a popup menu.
// Instead, open dialog directly when user clicks Prefs button
this.$prefsButton.attr('data-prefs-popup',this.prefCats[0]);
}
} else if (which === 'captions' || which === 'chapters') {
hasDefault = false;
for (i = 0; i < tracks.length; i++) {
track = tracks[i];
if (which === 'captions' && this.player === 'html5' && typeof track.cues === 'undefined') {
includeMenuItem = false;
} else {
includeMenuItem = true;
}
if (includeMenuItem) {
$menuItem = $('<li></li>',{
'role': 'menuitemradio',
'tabindex': '-1',
'lang': track.language
});
if (track.def && this.prefCaptions == 1) {
$menuItem.attr('aria-checked','true');
hasDefault = true;
} else {
$menuItem.attr('aria-checked','false');
}
// Get a label using track data
if (which == 'captions') {
$menuItem.text(track.label);
$menuItem.on('click',this.getCaptionClickFunction(track));
} else if (which == 'chapters') {
$menuItem.text(this.flattenCueForCaption(track) + ' - ' + this.formatSecondsAsColonTime(track.start));
$menuItem.on('click',this.getChapterClickFunction(track.start));
}
$menu.append($menuItem);
}
}
if (which === 'captions') {
// add a 'captions off' menu item
$menuItem = $('<li></li>',{
'role': 'menuitemradio',
'tabindex': '-1',
}).text( this.translate( 'captionsOff', 'Captions off' ) );
if (this.prefCaptions === 0) {
$menuItem.attr('aria-checked','true');
hasDefault = true;
} else {
$menuItem.attr('aria-checked','false');
}
$menuItem.on('click',this.getCaptionOffFunction());
$menu.append($menuItem);
}
} else if (which === 'transcript-window' || which === 'sign-window') {
windowOptions = [];
windowOptions.push({
'name': 'move',
'label': this.translate( 'windowMove', 'Move' )
});
windowOptions.push({
'name': 'resize',
'label': this.translate( 'windowResize', 'Resize' )
});
windowOptions.push({
'name': 'close',
'label': this.translate( 'closeButtonLabel', 'Close' )
});
for (i = 0; i < windowOptions.length; i++) {
$menuItem = $('<li></li>',{
'role': 'menuitem',
'tabindex': '-1',
'data-choice': windowOptions[i].name
});
$menuItem.text(windowOptions[i].label);
$menuItem.on('click',function(e) {
e.stopPropagation();
if (typeof e.button !== 'undefined' && e.button !== 0) {
// this was a mouse click (if click is triggered by keyboard, e.button is undefined)
// and the button was not a left click (left click = 0)
// therefore, ignore this click
return false;
}
if ( !thisObj.finishingDrag ) {
thisObj.handleMenuChoice(which.substring(0, which.indexOf('-')), $(this).attr('data-choice'), e);
}
});
$menu.append($menuItem);
}
}
// assign default item, if there isn't one already
if (which === 'captions' && !hasDefault) {
// check the menu item associated with the default language
// as determined in control.js > syncTrackLanguages()
if ($menu.find('li[lang=' + this.captionLang + ']')) {
// a track exists for the default language. Check that item in the menu
$menu.find('li[lang=' + this.captionLang + ']').attr('aria-checked','true');
} else {
// check the last item (captions off)
$menu.find('li').last().attr('aria-checked','true');
}
} else if (which === 'chapters') {
if ($menu.find('li:contains("' + this.defaultChapter + '")')) {
$menu.find('li:contains("' + this.defaultChapter + '")').attr('aria-checked','true').addClass('able-focus');
} else {
$menu.find('li').first().attr('aria-checked','true').addClass('able-focus');
}
}
// add keyboard handlers for navigating within popups
$menu.on('keydown',function (e) {
$thisItem = $(this).find('li:focus');
if ($thisItem.is(':first-child')) {
// this is the first item in the menu
$prevItem = $(this).find('li').last(); // wrap to bottom
$nextItem = $thisItem.next();
} else if ($thisItem.is(':last-child')) {
// this is the last Item
$prevItem = $thisItem.prev();
$nextItem = $(this).find('li').first(); // wrap to top
} else {
$prevItem = $thisItem.prev();
$nextItem = $thisItem.next();
}
if (e.key === 'Tab') {
if (e.shiftKey) {
$thisItem.removeClass('able-focus');
$prevItem.trigger('focus').addClass('able-focus');
} else {
$thisItem.removeClass('able-focus');
$nextItem.trigger('focus').addClass('able-focus');
}
} else if (e.key === 'ArrowDown' || e.key === 'ArrowRight') {
$thisItem.removeClass('able-focus');
$nextItem.trigger('focus').addClass('able-focus');
} else if (e.key == 'ArrowUp' || e.key === 'ArrowLeft') {
$thisItem.removeClass('able-focus');
$prevItem.trigger('focus').addClass('able-focus');
} else if (e.key === ' ' || e.key === 'Enter') {
$thisItem.trigger( 'click' );
} else if (e.key === 'Escape') {
$thisItem.removeClass('able-focus');
thisObj.closePopups();
e.stopPropagation();
}
e.preventDefault();
});
this.$controllerDiv.append($menu);
return $menu;
};
AblePlayer.prototype.closePopups = function () {
var thisObj = this;
if (this.chaptersPopup && this.chaptersPopup.is(':visible')) {
this.chaptersPopup.hide();
this.$chaptersButton.attr('aria-expanded','false').trigger('focus');
}
if (this.captionsPopup && this.captionsPopup.is(':visible')) {
this.captionsPopup.hide();
this.$ccButton.attr('aria-expanded', 'false');
this.waitThenFocus(this.$ccButton);
}
if (this.prefsPopup && this.prefsPopup.is(':visible') ) {
this.prefsPopup.hide();
// restore menu items to their original state
this.prefsPopup.find('li').removeClass('able-focus').attr('tabindex','-1');
this.$prefsButton.attr('aria-expanded', 'false');
if (!this.showingPrefsDialog) {
this.waitThenFocus(thisObj.$prefsButton);
}
}
if (this.$volumeSlider && this.$volumeSlider.is(':visible')) {
this.$volumeSlider.hide().attr('aria-hidden','true');
this.$volumeButton.attr('aria-expanded', 'false').trigger('focus');
}
if (this.$transcriptPopup && this.$transcriptPopup.is(':visible')) {
this.$transcriptPopup.hide();
// restore menu items to their original state
this.$transcriptPopup.find('li').removeClass('able-focus').attr('tabindex','-1');
this.$transcriptPopupButton.attr('aria-expanded','false').trigger('focus');
}
if (this.$signPopup && this.$signPopup.is(':visible')) {
this.$signPopup.hide();
// restore menu items to their original state
this.$signPopup.find('li').removeClass('able-focus').attr('tabindex','-1');
this.$signPopupButton.attr('aria-expanded','false').trigger('focus');
}
};
AblePlayer.prototype.setupPopups = function (which) {
// Create and fill in the popup menu forms for various controls.
// parameter 'which' is passed if refreshing content of an existing popup ('captions' or 'chapters')
// If which is undefined, automatically setup 'captions', 'chapters', and 'prefs' popups
// However, only setup 'transcript-window' and 'sign-window' popups if passed as value of which
var popups, i, tracks;
popups = [];
if (typeof which === 'undefined') {
popups.push('prefs');
}
if (which === 'captions' || (typeof which === 'undefined')) {
if (this.captions.length > 0) {
popups.push('captions');
}
}
if (which === 'chapters' || (typeof which === 'undefined')) {
if (this.chapters.length > 0 && this.useChaptersButton) {
popups.push('chapters');
}
}
if (which === 'transcript-window' && this.transcriptType === 'popup') {
popups.push('transcript-window');
}
if (which === 'sign-window' && this.hasSignLanguage) {
popups.push('sign-window');
}
if (popups.length > 0) {
for (i=0; i<popups.length; i++) {
var popup = popups[i];
if (popup == 'prefs') {
this.prefsPopup = this.createPopup('prefs');
} else if (popup == 'captions') {
if (typeof this.captionsPopup === 'undefined' || !this.captionsPopup) {
this.captionsPopup = this.createPopup('captions',this.captions);
}
} else if (popup == 'chapters') {
if (this.selectedChapters) {
tracks = this.selectedChapters.cues;
} else if (this.chapters.length >= 1) {
tracks = this.chapters[0].cues;
} else {
tracks = [];
}
if (typeof this.chaptersPopup === 'undefined' || !this.chaptersPopup) {
this.chaptersPopup = this.createPopup('chapters',tracks);
}
} else if (popup == 'transcript-window') {
return this.createPopup('transcript-window');
} else if (popup == 'sign-window') {
return this.createPopup('sign-window');
}
}
}
};
AblePlayer.prototype.provideFallback = function() {
// provide fallback in case of a critical error building the player
// to test, set data-test-fallback to either of the following values:
// 1 = emulate failure to build Able Player
// 2 = emulate browser that doesn't support HTML5 media
var i, $fallback;
if (this.usingFallback) {
// fallback has already been implemented.
// stopgap to prevent this function from executing twice on the same media element
return;
} else {
this.usingFallback = true;
}
if (!this.testFallback) {
// this is not a test.
// an actual error has resulted in this function being called.
// use scenario 1
this.testFallback = 1;
}
if (typeof this.$media === 'undefined') {
// this function has been called prior to initialize.js > reinitialize()
// before doing anything, need to create the jQuery media object
this.$media = $(this.media);
}
// get/assign an id for the media element
if (this.$media.attr('id')) {
this.mediaId = this.$media.attr('id');
} else {
this.mediaId = 'media' + Math.floor(Math.random() * 1000000000).toString();
}
// check whether element has nested fallback content
this.hasFallback = false;
if (this.$media.children().length) {
i = 0;
while (i < this.$media.children().length && !this.hasFallback) {
if (!(this.$media.children()[i].tagName === 'SOURCE' ||
this.$media.children()[i].tagName === 'TRACK')) {
// this element is something other than <source> or <track>
this.hasFallback = true;
}
i++;
}
}
if (!this.hasFallback) {
// the HTML code does not include any nested fallback content
// inject our own
// NOTE: this message is not translated, since fallback may be needed
// due to an error loading the translation file
// This will only be needed on very rare occasions, so English is ok.
$fallback = $('<p>').text('Media player unavailable.');
this.$media.append($fallback);
}
// get height and width attributes, if present
// and add them to a style attribute
if (this.$media.attr('width')) {
this.$media.css('width',this.$media.attr('width') + 'px');
}
if (this.$media.attr('height')) {
this.$media.css('height',this.$media.attr('height') + 'px');
}
// Remove data-able-player attribute
this.$media.removeAttr('data-able-player');
// Add controls attribute (so browser will add its own controls)
this.$media.prop('controls',true);
if (this.testFallback == 2) {
// emulate browser failure to support HTML5 media by changing the media tag name
// browsers should display the supported content that's nested inside
$(this.$media).replaceWith($('<foobar id="foobar-' + this.mediaId + '">'));
this.$newFallbackElement = $('#foobar-' + this.mediaId);
// append all children from the original media
if (this.$media.children().length) {
i = this.$media.children().length - 1;
while (i >= 0) {
this.$newFallbackElement.prepend($(this.$media.children()[i]));
i--;
}
}
if (!this.hasFallback) {
// inject our own fallback content, defined above
this.$newFallbackElement.append($fallback);
}
} else {
console.warn("Able Player encountered a problem, falling back to browser's HTML5 player.");
}
return;
};
AblePlayer.prototype.calculateControlLayout = function () {
// Calculates the layout for controls based on media and options.
// Returns an array with 4 keys (for legacy skin) or 2 keys (for 2020 skin)
// Keys are the following order:
// 0 = Top left
// 1 = Top right
// 2 = Bottom left (legacy skin only)
// 3 = Bottom right (legacy skin only)
// Each key contains an array of control names to put in that section.
var controlLayout, playbackSupported, numA11yButtons;
controlLayout = [];
controlLayout[0] = [];
controlLayout[1] = [];
if (this.skin === 'legacy') {
controlLayout[2] = [];
controlLayout[3] = [];
}
controlLayout[0].push('play');
controlLayout[0].push('restart');
controlLayout[0].push('rewind');
controlLayout[0].push('forward');
if (this.skin === 'legacy') {
controlLayout[1].push('seek');
}
if (this.hasPlaylist) {
if (this.skin === 'legacy') {
controlLayout[0].push('previous');
controlLayout[0].push('next');
} else {
controlLayout[0].push('previous');
controlLayout[0].push('next');
}
}
if (this.isPlaybackRateSupported()) {
playbackSupported = true;
if (this.skin === 'legacy') {
controlLayout[2].push('slower');
controlLayout[2].push('faster');
}
} else {
playbackSupported = false;
}
numA11yButtons = 0;
if (this.hasCaptions) {
numA11yButtons++;
if (this.skin === 'legacy') {
controlLayout[2].push('captions');
} else {
controlLayout[1].push('captions');
}
}
if (this.hasSignLanguage) {
numA11yButtons++;
if (this.skin === 'legacy') {
controlLayout[2].push('sign');
} else {
controlLayout[1].push('sign');
}
}
if (this.mediaType === 'video') {
if (this.hasOpenDesc || this.hasClosedDesc) {
numA11yButtons++;
if (this.skin === 'legacy') {
controlLayout[2].push('descriptions');
} else {
controlLayout[1].push('descriptions');
}
}
}
if (this.transcriptType !== null && !(this.hideTranscriptButton)) {
numA11yButtons++;
if (this.skin === 'legacy') {
controlLayout[2].push('transcript');
} else {
controlLayout[1].push('transcript');
}
}
if (this.hasChapters && this.useChaptersButton) {
numA11yButtons++;
if (this.skin === 'legacy') {
controlLayout[2].push('chapters');
} else {
controlLayout[1].push('chapters');
}
}
if (this.skin == '2020' && numA11yButtons > 0) {
controlLayout[1].push('pipe');
}
if (playbackSupported && this.skin === '2020') {
controlLayout[1].push('faster');
controlLayout[1].push('slower');
controlLayout[1].push('pipe');
}
if (this.skin === 'legacy') {
controlLayout[3].push('preferences');
} else {
controlLayout[1].push('preferences');
}
if (this.mediaType === 'video' && this.allowFullscreen && this.nativeFullscreenSupported() ) {
if (this.skin === 'legacy') {
controlLayout[3].push('fullscreen');
} else {
controlLayout[1].push('fullscreen');
}
}
if (this.browserSupportsVolume()) {
this.volumeButton = 'volume-' + this.getVolumeName(this.volume);
if (this.skin === 'legacy') {
controlLayout[1].push('volume');
} else {
controlLayout[1].push('volume');
}
} else {
this.volume = false;
}
return controlLayout;
};
AblePlayer.prototype.addControls = function() {
// determine which controls to show based on several factors:
// mediaType (audio vs video)
// availability of tracks (e.g., for closed captions & audio description)
// browser support (e.g., for sliders and speedButtons)
// user preferences (???)
// some controls are aligned on the left, and others on the right
var thisObj, controlLayout, numSections,
i, j, controls, $controllerSpan, $sliderDiv, sliderLabel, $pipe, control,
buttonTitle, $newButton, buttonText, position, buttonHeight,
buttonWidth, buttonSide, controllerWidth, tooltipId, tooltipY, tooltipX,
tooltipWidth, tooltipStyle, tooltip, tooltipTimerId, captionLabel, popupMenuId;
thisObj = this;
// Initialize the layout into the this.controlLayout variable.
controlLayout = this.calculateControlLayout();
numSections = controlLayout.length;
// add an empty div to serve as a tooltip
tooltipId = this.mediaId + '-tooltip';
this.$tooltipDiv = $('<div>',{
'id': tooltipId,
'class': 'able-tooltip'
}).hide();
this.$controllerDiv.append(this.$tooltipDiv);
if (this.skin == '2020') {
// add a full-width seek bar
$sliderDiv = $('<div class="able-seekbar"></div>');
sliderLabel = this.translate( 'seekbarLabel', '%1 timeline', [ this.mediaType ] );
this.$controllerDiv.append($sliderDiv);
this.seekBar = new AccessibleSlider($sliderDiv, this.duration, this.seekInterval, sliderLabel );
}
// add a full-width seek bar
let $controlRow = $('<div class="able-control-row"></div>');
this.$controllerDiv.append($controlRow);
for (i = 0; i < numSections; i++) {