{{ message }}
Repository navigation
Expand file tree
/
Copy pathcontrol.js
More file actions
1826 lines (1663 loc) · 62.6 KB
/
Copy pathcontrol.js
File metadata and controls
1826 lines (1663 loc) · 62.6 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';
function addControlFunctions(AblePlayer) {
AblePlayer.prototype.seekTo = function (newTime) {
var thisObj = this;
// define variables to be used for analytics
// e.g., to measure the extent to which users seek back and forward
this.seekFromTime = this.media.currentTime;
this.seekToTime = newTime;
this.seeking = true;
this.liveUpdatePending = true;
if (this.speakingDescription) {
this.synth.cancel();
}
this.syncSignVideo( {'time' : this.startTime } );
if (this.player === 'html5') {
var seekable;
this.startTime = newTime;
// Check HTML5 media "seekable" property to be sure media is seekable to startTime
seekable = this.media.seekable;
if (seekable.length > 0 && this.startTime >= seekable.start(0) && this.startTime <= seekable.end(0)) {
// ok to seek to startTime
// canplaythrough will be triggered when seeking is complete
// this.seeking will be set to false at that point
this.media.currentTime = this.startTime;
this.seekStatus = 'complete';
this.syncSignVideo( { 'time' : this.startTime } );
}
} else if (this.player === 'youtube') {
this.youTubePlayer.seekTo(newTime,true);
if (newTime > 0) {
if (typeof this.$posterImg !== 'undefined') {
this.$posterImg.hide();
}
}
this.syncSignVideo( {'time' : newTime } );
} else if (this.player === 'vimeo') {
this.vimeoPlayer.setCurrentTime(newTime).then(function() {
// seek finished.
// successful completion also fires a 'seeked' event (see event.js)
thisObj.elapsed = newTime;
thisObj.refreshControls('timeline');
})
}
this.refreshControls('timeline');
};
AblePlayer.prototype.getMediaTimes = function (duration, elapsed) {
// Returns an array with keys 'duration' and 'elapsed'
// Vars passed to this function come courtesy of select Vimeo events
// Use those if they're available.
// Otherwise, will need to call the relevant media API
// This function should only be called from onMediaUpdateTime()
// If duration and elapsed are needed other times, use this.duration and this.elapsed
// both values are expressed in seconds, and all player APIs are similar:
// they return a value that is rounded to the nearest second before playback begins,
// then to the nearest thousandth of a second after playback begins
// With HTML5 media API, some browsers are more precise (e.g., Firefox rounds to 6 decimal points)
// but inconsistent (values with 9 decimal points have been sporadically observed in Safari)
// For standardization, values are rounded to 6 decimal points before they're returned
var deferred, promise, thisObj, mediaTimes;
mediaTimes = {};
deferred = new this.defer();
promise = deferred.promise();
thisObj = this;
if (typeof duration !== 'undefined' && typeof elapsed !== 'undefined') {
mediaTimes['duration'] = duration;
mediaTimes['elapsed'] = elapsed;
deferred.resolve(mediaTimes);
} else {
this.getDuration().then(function(duration) {
mediaTimes['duration'] = thisObj.roundDown(duration,6);
thisObj.getElapsed().then(function(elapsed) {
mediaTimes['elapsed'] = thisObj.roundDown(elapsed,6);
deferred.resolve(mediaTimes);
});
});
}
return promise;
};
AblePlayer.prototype.getDuration = function () {
// returns duration of the current media, expressed in seconds
// function is called by getMediaTimes, and return value is sanitized there
var deferred, promise;
deferred = new this.defer();
promise = deferred.promise();
if (this.player === 'vimeo') {
if (this.vimeoPlayer) {
this.vimeoPlayer.getDuration().then(function(duration) {
if (duration === undefined || isNaN(duration) || duration === -1) {
deferred.resolve(0);
} else {
deferred.resolve(duration);
}
});
} else { // vimeoPlayer hasn't been initialized yet.
deferred.resolve(0);
}
} else {
var duration;
if (this.player === 'html5') {
duration = this.media.duration;
} else if (this.player === 'youtube') {
if (this.youTubePlayerReady) {
if (this.duration > 0) {
// duration was already retrieved while checking for captions
duration = this.duration;
} else {
duration = this.youTubePlayer.getDuration();
}
} else { // the YouTube player hasn't initialized yet
duration = 0;
}
}
if (duration === undefined || isNaN(duration) || duration === -1) {
deferred.resolve(0);
} else {
deferred.resolve(duration);
}
}
return promise;
};
AblePlayer.prototype.getElapsed = function () {
// returns elapsed time of the current media, expressed in seconds
// function is called by getMediaTimes, and return value is sanitized there
var deferred, promise;
deferred = new this.defer();
promise = deferred.promise();
if (this.player === 'vimeo') {
if (this.vimeoPlayer) {
this.vimeoPlayer.getCurrentTime().then(function(elapsed) {
if (elapsed === undefined || isNaN(elapsed) || elapsed === -1) {
deferred.resolve(0);
} else {
deferred.resolve(elapsed);
}
});
} else { // vimeoPlayer hasn't been initialized yet.
deferred.resolve(0);
}
} else {
var elapsed;
if (this.player === 'html5') {
elapsed = this.media.currentTime;
} else if (this.player === 'youtube') {
if (this.youTubePlayerReady) {
elapsed = this.youTubePlayer.getCurrentTime();
} else { // the YouTube player hasn't initialized yet
elapsed = 0;
}
}
if (elapsed === undefined || isNaN(elapsed) || elapsed === -1) {
deferred.resolve(0);
} else {
deferred.resolve(elapsed);
}
}
return promise;
};
AblePlayer.prototype.getPlayerState = function () {
// Returns one of the following states:
// - 'stopped' - Not yet played for the first time, or otherwise reset to unplayed.
// - 'ended' - Finished playing.
// - 'paused' - Not playing, but not stopped or ended.
// - 'buffering' - Momentarily paused to load, but will resume once data is loaded.
// - 'playing' - Currently playing.
var deferred, promise, thisObj;
deferred = new this.defer();
promise = deferred.promise();
thisObj = this;
if (this.player === 'html5') {
if (this.media.ended) {
deferred.resolve('ended');
} else if (this.media.paused) {
deferred.resolve('paused');
} else if (this.media.readyState !== 4) {
deferred.resolve('buffering');
} else {
deferred.resolve('playing');
}
} else if (this.player === 'youtube' && this.youTubePlayerReady) {
var state = this.youTubePlayer.getPlayerState();
if (state === -1 || state === 5) {
deferred.resolve('stopped');
} else if (state === 0) {
deferred.resolve('ended');
} else if (state === 1) {
deferred.resolve('playing');
} else if (state === 2) {
deferred.resolve('paused');
} else if (state === 3) {
deferred.resolve('buffering');
}
} else if (this.player === 'vimeo' && this.vimeoPlayer) {
// curiously, Vimeo's API has no getPlaying(), getBuffering(), or getState() methods
// so maybe if it's neither paused nor ended, it must be playing???
this.vimeoPlayer.getPaused().then(function(paused) {
if (paused) {
deferred.resolve('paused');
} else {
thisObj.vimeoPlayer.getEnded().then(function(ended) {
if (ended) {
deferred.resolve('ended');
} else {
deferred.resolve('playing');
}
});
}
});
}
return promise;
};
AblePlayer.prototype.isPlaybackRateSupported = function () {
if (this.player === 'html5') {
return (this.media.playbackRate) ? true : false;
} else if (this.player === 'youtube') {
// Youtube supports varying playback rates per video.
// Only expose controls if more than one playback rate is available.
if ( this.youTubePlayerReady ) {
try {
// can return undefined if player is mid-reload (e.g., just after cueVideoById)
var rates = this.youTubePlayer.getAvailablePlaybackRates();
return ( rates && rates.length > 1 ) ? true : false;
} catch (e) {
return false;
}
} else {
return false;
}
} else if ( this.player === 'vimeo' ) {
// since this takes longer to determine, it was set previously in initVimeoPlayer()
return this.vimeoSupportsPlaybackRateChange;
}
};
AblePlayer.prototype.setPlaybackRate = function (rate) {
rate = Math.max(0.5, rate);
if (this.hasClosedDesc && this.descMethod === 'text') {
// keep speech rate in sync with playback rate even if descOn is false
this.syncSpeechToPlaybackRate(rate);
}
this.syncSignVideo( {'rate' : rate } );
if (this.player === 'html5') {
this.media.playbackRate = rate;
} else if (this.player === 'youtube') {
this.youTubePlayer.setPlaybackRate(rate);
} else if (this.player === 'vimeo') {
this.vimeoPlayer.setPlaybackRate(rate);
}
this.syncSignVideo( { 'rate' : rate } );
this.playbackRate = rate;
this.$speed.text( this.translate( 'speed', 'Speed' ) + ': ' + rate.toFixed(2).toString() + 'x');
this.updateSpeedButtonLabels();
};
// Refresh the faster/slower button labels so they reflect the rate each button would now select.
AblePlayer.prototype.updateSpeedButtonLabels = function () {
if (!this.$controllerDiv) {
return;
}
var thisObj = this;
[ 'faster', 'slower' ].forEach( function( control ) {
var $button = thisObj.$controllerDiv.find( '.able-button-handler-' + control );
if ( $button.length ) {
thisObj.setText( $button, thisObj.getButtonTitle( control ) );
}
});
};
AblePlayer.prototype.getPlaybackRate = function () {
if (this.player === 'html5') {
return this.media.playbackRate;
} else if (this.player === 'youtube' && (this.youTubePlayerReady)) {
return this.youTubePlayer.getPlaybackRate();
}
};
AblePlayer.prototype.isPaused = function () {
// Note there are three player states that count as paused in this sense,
// and one of them is named 'paused'.
// A better name would be 'isCurrentlyNotPlayingOrBuffering'
if (this.player === 'vimeo') {
// just rely on value of this.playing
return (this.playing) ? false : true;
} else {
this.getPlayerState().then(function(state) {
// if any of the following is true, consider the media 'paused'
return state === 'paused' || state === 'stopped' || state === 'ended';
});
}
};
AblePlayer.prototype.syncSignVideo = function(options) {
if (this.hasSignLanguage && this.vimeoSignPlayer && options) {
const sign = this.vimeoSignPlayer;
const thisObj = this;
const ignore = function(error) {
if (thisObj.debug) {
console.log('Vimeo sign player error: ', error);
}
};
if (typeof options.time !== 'undefined') {
sign.setCurrentTime(options.time).catch(ignore);
}
if (typeof options.rate !== 'undefined') {
sign.setPlaybackRate(options.rate).catch(ignore);
}
if (typeof options.pause !== 'undefined') {
sign.pause().catch(ignore);
}
if (typeof options.play !== 'undefined') {
sign.play().catch(ignore);
}
if (typeof options.volume !== 'undefined') {
sign.setVolume(0).catch(ignore);
}
return;
}
if (this.hasSignLanguage && ( this.signVideo || this.signYoutube ) ) {
if (options && typeof options.time !== 'undefined') {
if ( this.signVideo ) {
this.signVideo.currentTime = options.time;
} else {
this.youTubeSignPlayer.seekTo(options.time,true);
}
}
if (options && typeof options.rate !== 'undefined') {
if ( this.signVideo ) {
this.signVideo.playbackRate = options.rate;
} else {
this.youTubeSignPlayer.setPlaybackRate(options.rate);
}
}
if (options && typeof options.pause !== 'undefined') {
if ( this.signVideo ) {
this.signVideo.pause(true);
} else {
this.youTubeSignPlayer.pauseVideo();
}
}
if (options && typeof options.play !== 'undefined') {
if ( this.signVideo ) {
this.signVideo.play(true);
} else {
this.youTubeSignPlayer.playVideo();
}
}
if (options && typeof options.volume !== 'undefined') {
if ( this.signVideo ) {
this.signVideo.volume = 0;
}
}
}
};
AblePlayer.prototype.pauseMedia = function () {
this.syncSignVideo( { 'pause' : true } );
if (this.player === 'html5') {
this.media.pause(true);
} else if (this.player === 'youtube') {
this.youTubePlayer.pauseVideo();
} else if (this.player === 'vimeo') {
this.vimeoPlayer.pause();
}
};
AblePlayer.prototype.playMedia = function () {
this.syncSignVideo( { 'play' : true } );
if (this.player === 'html5') {
this.media.play(true);
} else if (this.player === 'youtube') {
this.youTubePlayer.playVideo();
if (typeof this.$posterImg !== 'undefined') {
this.$posterImg.hide();
}
this.stoppingYouTube = false;
} else if (this.player === 'vimeo') {
this.vimeoPlayer.play();
}
this.startedPlaying = true;
if (this.hideControls) {
// wait briefly after playback begins, then hide controls
this.hidingControls = true;
this.invokeHideControlsTimeout();
}
};
AblePlayer.prototype.fadeControls = function(direction) {
// Visibly fade controls without hiding them from screen reader users
// direction is either 'out' or 'in'
// After the player fades, it's replaced by an empty space
// Would be better if the video and captions expanded to fill the void
// replace JS animation with CSS animation in 12/2025.
if (direction == 'out') {
// get the original height of two key components:
this.$playerDiv.addClass( 'fade-out' ).removeClass( 'fade-in' );
} else if (direction == 'in') {
this.$playerDiv.addClass( 'fade-in' ).removeClass( 'fade-out' );
}
};
AblePlayer.prototype.invokeHideControlsTimeout = function () {
// invoke timeout for waiting a few seconds after a mouse move or key down
// before hiding controls again
var thisObj = this;
this.hideControlsTimeout = window.setTimeout(function() {
if (typeof thisObj.playing !== 'undefined' && thisObj.playing === true && thisObj.hideControls) {
thisObj.fadeControls('out');
thisObj.controlsHidden = true;
}
},5000);
this.hideControlsTimeoutStatus = 'active';
};
AblePlayer.prototype.refreshControls = function(context = 'init', duration, elapsed) {
// context is one of the following:
// 'init' - initial build (or subsequent change that requires full rebuild)
// 'timeline' - a change may effect time-related controls
// 'captions' - a change may effect caption-related controls
// 'descriptions' - a change may effect description-related controls
// 'transcript' - a change may effect the transcript window or button
// 'fullscreen' - a change has been triggered by full screen toggle
// 'playpause' - a change triggered by either a 'play' or 'pause' event
// Normalize context to a known value.
if (['init', 'timeline', 'captions', 'descriptions', 'transcript', 'fullscreen', 'playpause'].indexOf(context) === -1) {
context = 'init';
}
// duration and elapsed are passed from callback functions of Vimeo API events
// duration is expressed as sss.xxx
// elapsed is expressed as sss.xxx
var thisObj, textByState, volumeStatus, timestamp, captionsCount, newTop, statusBarWidthBreakpoint;
thisObj = this;
// wait until new source has loaded before refreshing controls
// some critical events won't fire until playback of new media starts
if ( this.swappingSrc && this.playing ) {
return;
}
if ( context === 'timeline' || context === 'init' ) {
// Update timeline controls.
var lastChapterIndex, displayElapsed, updateLive, widthUsed,
leftControls, rightControls, seekbarWidth, buffered, mediaDuration;
// all timeline-related functionality requires duration
if (typeof this.duration === 'undefined') {
// wait until duration is known before proceeding with refresh
return;
}
if (this.useChapterTimes) {
this.chapterDuration = this.getChapterDuration();
this.chapterElapsed = this.getChapterElapsed();
}
if ( !this.useFixedSeekInterval && !this.seekIntervalCalculated && this.duration > 0) {
// couldn't calculate seekInterval previously; try again.
this.setSeekInterval();
}
if (this.seekBar) {
if (this.useChapterTimes) {
lastChapterIndex = this.selectedChapters.cues.length-1;
if (this.selectedChapters.cues[lastChapterIndex] == this.currentChapter) {
// this is the last chapter
if (this.currentChapter.end !== this.duration) {
// chapter ends before or after video ends
// need to adjust seekbar duration to match video end
this.seekBar.setDuration(this.duration - this.currentChapter.start);
} else {
this.seekBar.setDuration(this.chapterDuration);
}
} else {
// this is not the last chapter
this.seekBar.setDuration(this.chapterDuration);
}
} else if ( !(this.duration === undefined || isNaN(this.duration) || this.duration === -1) ) {
this.seekBar.setDuration(this.duration);
}
if (!(this.seekBar.tracking)) {
// Only update the aria live region if we have an update pending
// (from a seek button control) or if the seekBar has focus.
let activeEl = AblePlayer.getActiveDOMElement();
updateLive = this.liveUpdatePending || this.seekBar.$seekHead.is($(activeEl));
this.liveUpdatePending = false;
if (this.useChapterTimes) {
this.seekBar.setPosition(this.chapterElapsed, updateLive);
} else {
this.seekBar.setPosition(this.elapsed, updateLive);
}
}
// When seeking, display the seek bar time instead of the actual elapsed time.
if (this.seekBar.tracking) {
displayElapsed = this.seekBar.lastTrackPosition;
} else {
displayElapsed = ( this.useChapterTimes ) ? this.chapterElapsed : this.elapsed;
}
}
// update elapsed & duration
if (typeof this.$durationContainer !== 'undefined') {
if (this.useChapterTimes) {
this.$durationContainer.text( this.formatSecondsAsColonTime(this.chapterDuration));
} else {
this.$durationContainer.text( this.formatSecondsAsColonTime(this.duration));
}
}
if (typeof this.$elapsedTimeContainer !== 'undefined') {
this.$elapsedTimeContainer.text(this.formatSecondsAsColonTime(displayElapsed));
}
if (this.skin === 'legacy') {
// Update seekbar width.
// To do this, we need to calculate the width of all buttons surrounding it.
if (this.seekBar) {
let controlWrapper = this.seekBar.$wrapperDiv.parent().parent();
leftControls = this.seekBar.$wrapperDiv.parent().prev('div.able-left-controls');
rightControls = leftControls.next('div.able-right-controls');
widthUsed = leftControls.outerWidth(true);
rightControls.children().each(function () {
if ( $(this).is('button') ) {
widthUsed += $(this).outerWidth(true) + 5;
}
});
if (this.fullscreen) {
seekbarWidth = $(window).width() - widthUsed;
} else {
// seekbar is wide enough to fill the remaining space
// include a 10px buffer to account for minor browser differences or custom styles.
seekbarWidth = controlWrapper.width() - widthUsed - 10;
}
// Sometimes some minor fluctuations based on browser weirdness, so set a threshold.
if (Math.abs(seekbarWidth - this.seekBar.getWidth()) > 5) {
this.seekBar.setWidth(seekbarWidth);
}
}
}
// Update buffering progress.
// TODO: Currently only using the first HTML5 buffered interval,
// but this fails sometimes when buffering is split into two or more intervals.
if (this.player === 'html5' && this.media.buffered.length > 0) {
mediaDuration = (typeof duration !== 'undefined' && !isNaN(duration) && duration > 0) ? duration : this.duration;
buffered = this.media.buffered.end(0);
if (this.useChapterTimes) {
if (buffered > this.chapterDuration) {
buffered = this.chapterDuration;
}
if (this.seekBar && this.chapterDuration > 0) {
this.seekBar.setBuffered(buffered / this.chapterDuration);
}
} else if ( this.seekBar && !isNaN(buffered) && !isNaN(mediaDuration) && mediaDuration > 0 ) {
this.seekBar.setBuffered(buffered / mediaDuration);
}
} else if (this.player === 'youtube' && this.seekBar && this.youTubePlayerReady ) {
this.seekBar.setBuffered(this.youTubePlayer.getVideoLoadedFraction());
} else if (this.player === 'vimeo') {
// TODO: Add support for Vimeo buffering update
}
}
if (context === 'descriptions' || context == 'init') {
if (this.$descButton) {
this.toggleButtonState(
this.$descButton,
this.descOn,
this.translate( 'turnOffDescriptions', 'Turn off descriptions' ),
this.translate( 'turnOnDescriptions', 'Turn on descriptions' ),
);
}
}
if ( context === 'captions' || context == 'init' ) {
if (this.$ccButton) {
captionsCount = this.captions.length;
if ( captionsCount > 1 ) {
this.$ccButton.attr({
'aria-haspopup': 'true',
'aria-controls': this.mediaId + '-captions-menu'
});
}
var ariaLabelOn = ( captionsCount > 1 ) ? this.translate( 'captions', 'Captions' ) : this.translate( 'showCaptions', 'Show captions' );
var ariaLabelOff = ( captionsCount > 1 ) ? this.translate( 'captions', 'Captions' ) : this.translate( 'hideCaptions', 'Hide captions' );
this.toggleButtonState(
this.$ccButton,
this.captionsOn,
ariaLabelOff,
ariaLabelOn
);
}
}
if (context === 'fullscreen' || context == 'init'){
if (this.$fullscreenButton) {
if (!this.fullscreen) {
this.$fullscreenButton.attr( 'aria-label', this.translate( 'enterFullScreen', 'Enter full screen' ) );
this.getIcon( this.$fullscreenButton, 'fullscreen-expand' );
} else {
this.$fullscreenButton.attr('aria-label', this.translate( 'exitFullScreen', 'Exit full screen' ) );
this.getIcon( this.$fullscreenButton, 'fullscreen-collapse' );
}
}
}
if (context === 'playpause' || context == 'init'){
if (typeof this.$bigPlayButton !== 'undefined' && typeof this.seekBar !== 'undefined') {
// Choose show/hide for big play button and adjust position.
if (this.paused && !this.seekBar.tracking) {
if (!this.hideBigPlayButton) {
this.$bigPlayButton.show();
this.$bigPlayButton.attr('aria-hidden', 'false');
}
} else {
this.$bigPlayButton.hide();
this.$bigPlayButton.attr('aria-hidden', 'true');
}
}
}
if (context === 'transcript' || context == 'init'){
if (this.transcriptType) {
// Sync checkbox and autoScrollTranscript with user preference
if (this.prefAutoScrollTranscript === 1) {
this.autoScrollTranscript = true;
this.$autoScrollTranscriptCheckbox.prop('checked',true);
} else {
this.autoScrollTranscript = false;
this.$autoScrollTranscriptCheckbox.prop('checked',false);
}
// If transcript locked, scroll transcript to current highlight location.
if (this.autoScrollTranscript && this.currentHighlight) {
newTop = Math.floor(this.$transcriptDiv.scrollTop() +
$(this.currentHighlight).position().top -
(this.$transcriptDiv.height() / 2) +
($(this.currentHighlight).height() / 2));
if (newTop !== Math.floor(this.$transcriptDiv.scrollTop())) {
// Set a flag to ignore the coming scroll event.
// there's no other way I know of to differentiate programmatic and user-initiated scroll events.
this.scrollingTranscript = true;
// only scroll once after moving a highlight
if (this.movingHighlight) {
this.$transcriptDiv.scrollTop(newTop);
this.movingHighlight = false;
}
}
}
}
}
if (context === 'init') {
if (this.$chaptersButton) {
this.$chaptersButton.attr({
'aria-label': this.translate( 'chapters', 'Chapters' ),
'aria-haspopup': 'true',
'aria-controls': this.mediaId + '-chapters-menu'
});
}
}
if (context === 'timeline' || context === 'playpause' || context === 'init') {
// update status
textByState = {
'stopped': this.translate( 'statusStopped', 'Stopped' ),
'paused': this.translate( 'statusPaused', 'Paused' ),
'playing': this.translate( 'statusPlaying', 'Playing' ),
'buffering': this.translate( 'statusBuffering', 'Buffering' ),
'ended': this.translate( 'statusEnd', 'End of track' )
};
if (this.stoppingYouTube) {
// stoppingYouTube is true temporarily while video is paused and seeking to 0
// See notes in handleRestart()
// this.stoppingYouTube will be reset when seek to 0 is finished (in event.js > onMediaUpdateTime())
if (this.$status.text() !== this.translate( 'statusStopped', 'Stopped' ) ) {
this.$status.text( this.translate( 'statusStopped', 'Stopped' ) );
}
this.getIcon( this.$playpauseButton, 'play' );
} else if (typeof this.$status !== 'undefined' && typeof this.seekBar !== 'undefined') {
// Update the text only if it's changed since it has role="alert";
// also don't update while tracking, since this may Pause/Play the player but we don't want to send a Pause/Play update.
this.getPlayerState().then(function(currentState) {
volumeStatus = thisObj.getVolume() === 0 ? thisObj.translate( 'statusMuted', 'Muted' ) : '';
volumeStatus = (volumeStatus) ? ', ' + volumeStatus : '';
let currentMessage = textByState[currentState] + ' ' + volumeStatus;
if (thisObj.$status.text() !== currentMessage && !thisObj.seekBar.tracking) {
// Debounce updates; only update after status has stayed steadily different for a while
// "A while" is defined differently depending on context
if (thisObj.swappingSrc) {
// this is where most of the chatter occurs (e.g., playing, paused, buffering, playing),
// so set a longer wait time before writing a status message
if (!thisObj.debouncingStatus) {
thisObj.statusMessageThreshold = 2000; // in ms (2 seconds)
}
} else if (!thisObj.debouncingStatus) {
// for all other contexts (e.g., users clicks Play/Pause)
// user should receive more rapid feedback
thisObj.statusMessageThreshold = 250; // in ms
}
timestamp = (new Date()).getTime();
if (!thisObj.statusDebounceStart) {
thisObj.statusDebounceStart = timestamp;
// Call refreshControls() again after allotted time has passed
thisObj.debouncingStatus = true;
thisObj.statusTimeout = setTimeout(function () {
thisObj.debouncingStatus = false;
thisObj.refreshControls(context);
}, thisObj.statusMessageThreshold);
} else if ((timestamp - thisObj.statusDebounceStart) > thisObj.statusMessageThreshold) {
thisObj.$status.text(currentMessage);
thisObj.statusDebounceStart = null;
clearTimeout(thisObj.statusTimeout);
thisObj.statusTimeout = null;
}
} else {
thisObj.statusDebounceStart = null;
thisObj.debouncingStatus = false;
clearTimeout(thisObj.statusTimeout);
thisObj.statusTimeout = null;
}
// Don't change play/pause button display while using the seek bar (or if YouTube stopped)
if (!thisObj.seekBar.tracking && !thisObj.stoppingYouTube) {
if (currentState === 'paused' || currentState === 'stopped' || currentState === 'ended') {
thisObj.$playpauseButton.attr('aria-label', thisObj.translate( 'play', 'Play' ) );
thisObj.getIcon( thisObj.$playpauseButton, 'play' );
} else {
thisObj.$playpauseButton.attr('aria-label', thisObj.translate( 'pause', 'Pause' ) );
thisObj.getIcon( thisObj.$playpauseButton, 'pause' );
}
}
});
}
}
// Show/hide status bar content conditionally
if (!this.fullscreen) {
statusBarWidthBreakpoint = 300;
if (this.$statusBarDiv.width() < statusBarWidthBreakpoint) {
// Player is too small for a speed span
this.$statusBarDiv.find('span.able-speed').hide();
this.hidingSpeed = true;
} else {
if (this.hidingSpeed) {
this.$statusBarDiv.find('span.able-speed').show();
this.hidingSpeed = false;
}
}
}
};
AblePlayer.prototype.handlePlay = function(e) {
if (this.paused) {
// user clicked play
this.okToPlay = true;
this.playMedia();
if (this.synth.paused) {
// media was paused while description was speaking
// resume utterance
this.synth.resume();
}
} else {
// user clicked pause
this.okToPlay = false;
this.pauseMedia();
if (this.speakingDescription) {
// pause the current utterance
// it will resume when the user presses play
this.synth.pause();
}
}
if (this.speechEnabled === null) {
this.initSpeech('play');
}
};
AblePlayer.prototype.handleRestart = function() {
if (this.speakingDescription) {
// cancel audio description
this.synth.cancel();
}
this.seekTo(0);
};
AblePlayer.prototype.handlePrevTrack = function() {
// currently on the first track
// wrap to bottom and play the last track
let newIndex = (this.playlistIndex === 0) ? this.$playlist.length - 1 : this.playlistIndex - 1;
this.cueingPlaylistItem = true; // stopgap to prevent multiple firings
this.cuePlaylistItem(newIndex);
};
AblePlayer.prototype.handleNextTrack = function() {
// currently on the last track
// wrap to top and play the first track
let newIndex = (this.playlistIndex === this.$playlist.length - 1) ? 0 : this.playlistIndex + 1;
this.cueingPlaylistItem = true; // stopgap to prevent multiple firings
this.cuePlaylistItem(newIndex);
};
AblePlayer.prototype.handleRewind = function() {
var targetTime;
targetTime = this.elapsed - this.seekInterval;
if (this.useChapterTimes && (targetTime < this.currentChapter.start)) {
targetTime = this.currentChapter.start;
} else if (targetTime < 0) {
targetTime = 0;
}
this.seekTo(targetTime);
};
AblePlayer.prototype.handleFastForward = function() {
var targetTime, lastChapterIndex;
lastChapterIndex = this.chapters.length-1;
targetTime = this.elapsed + this.seekInterval;
if (this.useChapterTimes) {
if (this.chapters[lastChapterIndex] == this.currentChapter) {
// this is the last chapter
if (targetTime > this.duration || targetTime > this.currentChapter.end) {
// targetTime would exceed the end of the video (or chapter)
// scrub to end of whichever is earliest
targetTime = Math.min(this.duration, this.currentChapter.end);
} else if (this.duration % targetTime < this.seekInterval) {
// nothing left but pocket change after seeking to targetTime
// go ahead and seek to end of video (or chapter), whichever is earliest
targetTime = Math.min(this.duration, this.currentChapter.end);
}
} else {
// this is not the last chapter
if (targetTime > this.currentChapter.end) {
// targetTime would exceed the end of the chapter
// scrub exactly to end of chapter
targetTime = this.currentChapter.end;
}
}
} else {
// not using chapter times
if (targetTime > this.duration) {
targetTime = this.duration;
}
}
this.seekTo(targetTime);
};
AblePlayer.prototype.handleRateIncrease = function() {
this.changeRate(1);
};
AblePlayer.prototype.handleRateDecrease = function() {
this.changeRate(-1);
};
// Increases or decreases playback rate, where dir is 1 or -1 indication direction.
AblePlayer.prototype.changeRate = function (dir,change = true) {
var rates, currentRate, index, newRate, vimeoMin, vimeoMax;
if (this.player === 'html5') {
if ( change ) {
// increase or decrease by 0.25x
this.setPlaybackRate(this.getPlaybackRate() + (0.25 * dir));
} else {
return this.getPlaybackRate() + (0.25 * dir);
}
} else if (this.player === 'youtube') {
if (this.youTubePlayerReady) {
rates = this.youTubePlayer.getAvailablePlaybackRates();
if ( !rates ) {
// player is mid-reload (e.g., just after cueVideoById); nothing to do yet
return;
}
currentRate = this.getPlaybackRate();
index = rates.indexOf(currentRate);
if (index === -1) {
console.log('ERROR: Youtube returning unknown playback rate ' + currentRate.toString());
} else {
index += dir;
// Can only increase or decrease rate if there's another rate available.
if (index < rates.length && index >= 0) {
if ( change ) {
this.setPlaybackRate(rates[index]);
} else {
return rates[index];
}
}
}
}
} else if (this.player === 'vimeo') {
// range is 0.5 to 2
// increase/decrease in inrements of 0.5
vimeoMin = 0.5;
vimeoMax = 2;
if (dir === 1) {
newRate = (this.vimeoPlaybackRate + 0.5 <= vimeoMax) ? this.vimeoPlaybackRate + 0.5 : vimeoMax;
} else if (dir === -1) {
newRate = (this.vimeoPlaybackRate - 0.5 >= vimeoMin) ? this.vimeoPlaybackRate - 0.5 : vimeoMin;
}
if ( change ) {
this.setPlaybackRate(newRate);
} else {
return newRate;
}
}
};
AblePlayer.prototype.handleCaptionToggle = function() {
var thisObj = this;
var captions;
captions = (this.captions.length) ? this.captions : [];
if (captions.length === 1) {
// When there's only one set of captions, just do an on/off toggle.
if (this.captionsOn === true) {
// turn them off
this.captionsOn = false;
this.prefCaptions = 0;
this.updatePreferences('prefCaptions');
if (this.usingYouTubeCaptions) {
this.youTubePlayer.unloadModule('captions');
} else if (this.usingVimeoCaptions) {
this.vimeoPlayer.disableTextTrack();
} else {
this.$captionsWrapper.hide();
}
} else {
// captions are off. Turn them on.
this.captionsOn = true;
this.prefCaptions = 1;
this.updatePreferences('prefCaptions');
if (this.usingYouTubeCaptions) {
this.youTubePlayer.loadModule('captions');
} else if (this.usingVimeoCaptions) {
this.vimeoPlayer.enableTextTrack(this.captionLang).catch(function(error) {
switch (error.name) {
case 'InvalidTrackLanguageError':
// There is no text track for the specified language
console.log(`No Vimeo text track is available in the specified language (${this.captionLang})`);
break;
case 'InvalidTrackError':
// There is no such text track
console.log('No Vimeo text track is available');
break;
You can’t perform that action at this time.