Repository navigation
Expand file tree
/
Copy pathableplayer-base.js
More file actions
671 lines (589 loc) · 23.1 KB
/
Copy pathableplayer-base.js
File metadata and controls
671 lines (589 loc) · 23.1 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
/*
// JavaScript for Able Player
// HTML5 Media API:
http://www.w3.org/TR/html5/embedded-content-0.html#htmlmediaelement
http://dev.w3.org/html5/spec-author-view/video.html
// W3C API Test Page:
http://www.w3.org/2010/05/video/mediaevents.html
// YouTube Player API for iframe Embeds
https://developers.google.com/youtube/iframe_api_reference
// YouTube Player Parameters
https://developers.google.com/youtube/player_parameters?playerVersion=HTML5
// YouTube Data API
https://developers.google.com/youtube/v3
// Vimeo Player API
https://github.com/vimeo/player.js
// Google API Client Library for JavaScript
https://developers.google.com/api-client-library/javascript/dev/dev_jscript
// Google API Explorer: YouTube services and methods
https://developers.google.com/apis-explorer/#s/youtube/v3/
// Web Speech API (Speech Synthesis)
https://w3c.github.io/speech-api/#tts-section
https://developer.mozilla.org/en-US/docs/Web/API/Window/speechSynthesis
*/
/*jslint node: true, browser: true, white: true, indent: 2, unparam: true, plusplus: true */
/*global $, jQuery */
"use strict";
// maintain an array of Able Player instances for use globally (e.g., for keeping prefs in sync)
var AblePlayerInstances = [];
(function ($) {
$(function () {
$('video, audio').each(function (index, element) {
if ($(element).data('able-player') !== undefined) {
AblePlayerInstances.push(new AblePlayer($(this),$(element)));
}
});
});
// YouTube player support; pass ready event to jQuery so we can catch in player.
window.onYouTubeIframeAPIReady = function() {
AblePlayer.youTubeIframeAPIReady = true;
$('body').trigger('youTubeIframeAPIReady', []);
};
// If there is only one player on the page, dispatch global keydown events to it
// Otherwise, keydowwn events are handled locally (see event.js > handleEventListeners())
$(window).on('keydown',function(e) {
if (AblePlayer.nextIndex === 1) {
AblePlayer.lastCreated.onPlayerKeyPress(e);
}
});
/**
* Construct the AblePlayer object.
*
* @param object media jQuery selector or element identifying the media.
*/
window.AblePlayer = function(media) {
var thisObj = this;
// Keep track of the last player created for use with global events.
AblePlayer.lastCreated = this;
this.media = media;
if ($(media).length === 0) {
this.provideFallback();
return;
}
// Default variables assignment
// The following variables CAN be overridden with HTML attributes
// autoplay (Boolean; if present always resolves to true, regardless of value)
if ($(media).attr('autoplay') !== undefined) {
this.autoplay = true; // this value remains constant
this.okToPlay = true; // this value can change dynamically
}
else {
this.autoplay = false;
this.okToPlay = false;
}
// loop (Boolean; if present always resolves to true, regardless of value)
if ($(media).attr('loop') !== undefined) {
this.loop = true;
}
else {
this.loop = false;
}
// playsinline (Boolean; if present always resolves to true, regardless of value)
if ($(media).attr('playsinline') !== undefined) {
this.playsInline = '1'; // this value gets passed to YT.Player contructor in youtube.js
}
else {
this.playsInline = '0';
}
// poster (Boolean, indicating whether media element has a poster attribute)
if ($(media).attr('poster')) {
this.hasPoster = true;
}
else {
this.hasPoster = false;
}
// get height and width attributes, if present
// and add them to variables
// Not currently used, but might be useful for resizing player
if ($(media).attr('width')) {
this.width = $(media).attr('width');
}
if ($(media).attr('height')) {
this.height = $(media).attr('height');
}
// start-time
var startTime = $(media).data('start-time');
var isNumeric = ( typeof startTime === 'number' || ( typeof startTime === 'string' && value.trim() !== '' && ! isNaN(value) && isFinite( Number(value) ) ) ) ? true : false;
if ( startTime !== undefined && isNumeric ) {
this.startTime = $(media).data('start-time');
}
else {
this.startTime = 0;
}
// debug
if ($(media).data('debug') !== undefined && $(media).data('debug') !== false) {
this.debug = true;
}
else {
this.debug = false;
}
// Path to root directory of Able Player code
if ($(media).data('root-path') !== undefined) {
// add a trailing slash if there is none
this.rootPath = $(media).data('root-path').replace(/\/?$/, '/');
}
else {
this.rootPath = this.getRootPath();
}
// Volume
// Range is 0 to 10. Best not to crank it to avoid overpowering screen readers
this.defaultVolume = 7;
if ($(media).data('volume') !== undefined && $(media).data('volume') !== "") {
var volume = $(media).data('volume');
if (volume >= 0 && volume <= 10) {
this.defaultVolume = volume;
}
}
this.volume = this.defaultVolume;
// Optional Buttons
// Buttons are added to the player controller if relevant media is present
// However, in some applications it might be undesirable to show buttons
// (e.g., if chapters or transcripts are provided in an external container)
if ($(media).data('use-chapters-button') !== undefined && $(media).data('use-chapters-button') === false) {
this.useChaptersButton = false;
}
else {
this.useChaptersButton = true;
}
// Control whether text descriptions are read aloud
// set to "false" if the sole purpose of the WebVTT descriptions file
// is to integrate text description into the transcript
// set to "true" to write description text to a div
// This variable does *not* control the method by which description is read.
// For that, see below (this.descMethod)
if ($(media).data('descriptions-audible') !== undefined && $(media).data('descriptions-audible') === false) {
this.readDescriptionsAloud = false;
}
else if ($(media).data('description-audible') !== undefined && $(media).data('description-audible') === false) {
// support both singular and plural spelling of attribute
this.readDescriptionsAloud = false;
}
else {
this.readDescriptionsAloud = true;
}
// setting initial this.descVoices to an empty array
// to be populated later by getBrowserVoices
this.descVoices = [];
// Method by which text descriptions are read
// valid values of data-desc-reader are:
// 'brower' (default) - text-based audio description is handled by the browser, if supported
// 'screenreader' - text-based audio description is always handled by screen readers
// The latter may be preferable by owners of websites in languages that are not well supported
// by the Web Speech API
if ($(media).data('desc-reader') == 'screenreader') {
this.descReader = 'screenreader';
}
else {
this.descReader = 'browser';
}
// Default state of captions and descriptions
// This setting is overridden by user preferences, if they exist
// values for data-state-captions and data-state-descriptions are 'on' or 'off'
if ($(media).data('state-captions') == 'off') {
this.defaultStateCaptions = 0; // off
}
else {
this.defaultStateCaptions = 1; // on by default
}
if ($(media).data('state-descriptions') == 'on') {
this.defaultStateDescriptions = 1; // on
}
else {
this.defaultStateDescriptions = 0; // off by default
}
// Default setting for prefDescPause
// Extended description (i.e., pausing during description) is on by default
// but this settings give website owners control over that
// since they know the nature of their videos, and whether pausing is necessary
// This setting is overridden by user preferences, if they exist
if ($(media).data('desc-pause-default') == 'off') {
this.defaultDescPause = 0; // off
}
else {
this.defaultDescPause = 1; // on by default
}
// Headings
// By default, an off-screen heading is automatically added to the top of the media player
// It is intelligently assigned a heading level based on context, via misc.js > getNextHeadingLevel()
// Authors can override this behavior by manually assigning a heading level using data-heading-level
// Accepted values are 1-6, or 0 which indicates "no heading"
// (i.e., author has already hard-coded a heading before the media player; Able Player doesn't need to do this)
if ($(media).data('heading-level') !== undefined && $(media).data('heading-level') !== "") {
var headingLevel = $(media).data('heading-level');
if (/^[0-6]*$/.test(headingLevel)) { // must be a valid HTML heading level 1-6; or 0
this.playerHeadingLevel = headingLevel;
}
}
// Transcripts
// There are three types of interactive transcripts.
// In descending of order of precedence (in case there are conflicting tags), they are:
// 1. "manual" - A manually coded external transcript (requires data-transcript-src)
// 2. "external" - Automatically generated, written to an external div (requires data-transcript-div & a valid target element)
// 3. "popup" - Automatically generated, written to a draggable, resizable popup window that can be toggled on/off with a button
// If data-include-transcript="false", there is no "popup" transcript
if ($(media).data('transcript-div') !== undefined
&& $(media).data('transcript-div') !== ""
&& null !== document.getElementById( $(media).data('transcript-div') ) ) {
this.transcriptDivLocation = $(media).data('transcript-div');
}
else {
this.transcriptDivLocation = null;
}
if ($(media).data('include-transcript') !== undefined && $(media).data('include-transcript') === false) {
this.hideTranscriptButton = true;
}
else {
this.hideTranscriptButton = null;
}
this.transcriptType = null;
if ($(media).data('transcript-src') !== undefined) {
this.transcriptSrc = $(media).data('transcript-src');
if (this.transcriptSrcHasRequiredParts()) {
this.transcriptType = 'manual';
}
else {
console.log('ERROR: Able Player transcript is missing required parts');
}
}
else if ($(media).find('track[kind="captions"], track[kind="subtitles"],track:not([kind])').length > 0) {
// required tracks are present. COULD automatically generate a transcript
if (this.transcriptDivLocation) {
this.transcriptType = 'external';
}
else {
this.transcriptType = 'popup';
}
}
// In "Lyrics Mode", line breaks in WebVTT caption files are supported in the transcript
// If false (default), line breaks are are removed from transcripts in order to provide a more seamless reading experience
// If true, line breaks are preserved, so content can be presented karaoke-style, or as lines in a poem
if ($(media).data('lyrics-mode') !== undefined && $(media).data('lyrics-mode') !== false) {
this.lyricsMode = true;
}
else {
this.lyricsMode = false;
}
// Transcript Title
if ($(media).data('transcript-title') !== undefined && $(media).data('transcript-title') !== "") {
this.transcriptTitle = $(media).data('transcript-title');
}
else {
// do nothing. The default title will be defined later (see transcript.js)
}
// Captions
// data-captions-position can be used to set the default captions position
// this is only the default, and can be overridden by user preferences
// valid values of data-captions-position are 'below' and 'overlay'
if ($(media).data('captions-position') === 'overlay') {
this.defaultCaptionsPosition = 'overlay';
}
else { // the default, even if not specified
this.defaultCaptionsPosition = 'below';
}
// Chapters
if ($(media).data('chapters-div') !== undefined && $(media).data('chapters-div') !== "") {
this.chaptersDivLocation = $(media).data('chapters-div');
}
if ($(media).data('chapters-title') !== undefined) {
// NOTE: empty string is valid; results in no title being displayed
this.chaptersTitle = $(media).data('chapters-title');
}
if ($(media).data('chapters-default') !== undefined && $(media).data('chapters-default') !== "") {
this.defaultChapter = $(media).data('chapters-default');
}
else {
this.defaultChapter = null;
}
// Slower/Faster buttons
// valid values of data-speed-icons are 'animals' (default) and 'arrows'
// 'animals' uses turtle and rabbit; 'arrows' uses up/down arrows
if ($(media).data('speed-icons') === 'arrows') {
this.speedIcons = 'arrows';
}
else {
this.speedIcons = 'animals';
}
// Seekbar
// valid values of data-seekbar-scope are 'chapter' and 'video'; will also accept 'chapters'
if ($(media).data('seekbar-scope') === 'chapter' || $(media).data('seekbar-scope') === 'chapters') {
this.seekbarScope = 'chapter';
}
else {
this.seekbarScope = 'video';
}
// YouTube
if ($(media).data('youtube-id') !== undefined && $(media).data('youtube-id') !== "") {
this.youTubeId = this.getYouTubeId($(media).data('youtube-id'));
}
if ($(media).data('youtube-desc-id') !== undefined && $(media).data('youtube-desc-id') !== "") {
this.youTubeDescId = this.getYouTubeId($(media).data('youtube-desc-id'));
}
if ($(media).data('youtube-nocookie') !== undefined && $(media).data('youtube-nocookie')) {
this.youTubeNoCookie = true;
}
else {
this.youTubeNoCookie = false;
}
// Vimeo
if ($(media).data('vimeo-id') !== undefined && $(media).data('vimeo-id') !== "") {
this.vimeoId = this.getVimeoId($(media).data('vimeo-id'));
}
if ($(media).data('vimeo-desc-id') !== undefined && $(media).data('vimeo-desc-id') !== "") {
this.vimeoDescId = this.getVimeoId($(media).data('vimeo-desc-id'));
}
// Skin
// valid values of data-skin are:
// '2020' (default as of 4.6), all buttons in one row beneath a full-width seekbar
// 'legacy', two rows of controls; seekbar positioned in available space within top row
if ($(media).data('skin') == 'legacy') {
this.skin = 'legacy';
}
else {
this.skin = '2020';
}
// Size
// width of Able Player is determined using the following order of precedence:
// 1. data-width attribute
// 2. width attribute (for video or audio, although it is not valid HTML for audio)
// 3. Intrinsic size from video (video only, determined later)
if ($(media).data('width') !== undefined) {
this.playerWidth = parseInt($(media).data('width'));
}
else if ($(media)[0].getAttribute('width')) {
// NOTE: jQuery attr() returns null for all invalid HTML attributes
// (e.g., width on <audio>)
// but it can be acessed via JavaScript getAttribute()
this.playerWidth = parseInt($(media)[0].getAttribute('width'));
}
else {
this.playerWidth = null;
}
// Icon type
// By default, AblePlayer 3.0.33 and higher uses SVG icons for the player controls
// Fallback for browsers that don't support SVG is scalable icomoon fonts
// Ultimate fallback is images, if the user has a custom style sheet that overrides font-family
// Use data-icon-type to force controls to use either 'svg', 'font', or 'images'
this.iconType = 'font';
this.forceIconType = false;
if ($(media).data('icon-type') !== undefined && $(media).data('icon-type') !== "") {
var iconType = $(media).data('icon-type');
if (iconType === 'font' || iconType == 'image' || iconType == 'svg') {
this.iconType = iconType;
this.forceIconType = true;
}
}
if ($(media).data('allow-fullscreen') !== undefined && $(media).data('allow-fullscreen') === false) {
this.allowFullscreen = false;
}
else {
this.allowFullscreen = true;
}
// Define other variables that are used in fullscreen program flow
this.clickedFullscreenButton = false;
this.restoringAfterFullscreen = false;
// Seek interval
// Number of seconds to seek forward or back with Rewind & Forward buttons
// Unless specified with data-seek-interval, the default value is re-calculated in initialize.js > setSeekInterval();
// Calculation attempts to intelligently assign a reasonable interval based on media length
this.defaultSeekInterval = 10;
this.useFixedSeekInterval = false; // will change to true if media has valid data-seek-interval attribute
if ($(media).data('seek-interval') !== undefined && $(media).data('seek-interval') !== "") {
var seekInterval = $(media).data('seek-interval');
if (/^[1-9][0-9]*$/.test(seekInterval)) { // must be a whole number greater than 0
this.seekInterval = seekInterval;
this.useFixedSeekInterval = true; // do not override with calculuation
}
}
// Now Playing
// Shows "Now Playing:" plus the title of the current track above player
// Only used if there is a playlist
if ($(media).data('show-now-playing') !== undefined && $(media).data('show-now-playing') === false) {
this.showNowPlaying = false;
}
else {
this.showNowPlaying = true;
}
// TTML support (experimental); enabled for testing with data-use-ttml (Boolean)
if ($(media).data('use-ttml') !== undefined) {
this.useTtml = true;
// The following may result in a console error.
this.convert = require('xml-js');
}
else {
this.useTtml = false;
}
// Fallback
// The data-test-fallback attribute can be used to test the fallback solution in any browser
if ($(media).data('test-fallback') !== undefined && $(media).data('test-fallback') !== false) {
if ($(media).data('test-fallback') == '2') {
this.testFallback = 2; // emulate browser that doesn't support HTML5 media
}
else {
this.testFallback = 1; // emulate failure to load Able Player
}
}
else {
this.testFallback = false;
}
// Language
// Player language is determined given the following precedence:
// 1. The value of data-lang on the media element, if provided and a matching translation file is available
// 2. Lang attribute on <html> or <body>, if a matching translation file is available
// 3. English
// Final calculation occurs in translation.js > getTranslationText()
if ($(media).data('lang') !== undefined && $(media).data('lang') !== "") {
this.lang = $(media).data('lang').toLowerCase();
}
else {
this.lang = null;
}
// Metadata Tracks
if ($(media).data('meta-type') !== undefined && $(media).data('meta-type') !== "") {
this.metaType = $(media).data('meta-type');
}
if ($(media).data('meta-div') !== undefined && $(media).data('meta-div') !== "") {
this.metaDiv = $(media).data('meta-div');
}
// Search
// conducting a search requires an external div in which to write the results
if ($(media).data('search-div') !== undefined && $(media).data('search-div') !== "") {
this.searchDiv = $(media).data('search-div');
// Search term (optional; could be assigned later in a JavaScript application)
if ($(media).data('search') !== undefined && $(media).data('search') !== "") {
this.searchString = $(media).data('search');
}
// Search Language
if ($(media).data('search-lang') !== undefined && $(media).data('search-lang') !== "") {
this.searchLang = $(media).data('search-lang');
}
else {
this.searchLang = null; // will change to final value of this.lang in translation.js > getTranslationText()
}
// Search option: Ignore capitalization in search terms
if ($(media).data('search-ignore-caps') !== undefined && $(media).data('search-ignore-caps') !== false) {
this.searchIgnoreCaps = true;
}
else {
this.searchIgnoreCaps = false;
}
// conducting a search currently requires an external div in which to write the results
if ($(media).data('search-div') !== undefined && $(media).data('search-div') !== "") {
this.searchString = $(media).data('search');
this.searchDiv = $(media).data('search-div');
}
}
// Hide controls when video starts playing
// They will reappear again when user presses a key or moves the mouse
// As of v4.0, controls are hidden automatically on playback in fullscreen mode
if ($(media).data('hide-controls') !== undefined && $(media).data('hide-controls') !== false) {
this.hideControls = true;
this.hideControlsOriginal = true; // a copy of hideControls, since the former may change if user enters full screen mode
}
else {
this.hideControls = false;
this.hideControlsOriginal = false;
}
// Steno mode
// Enable support for Able Player keyboard shortcuts in textaarea fields
// so users can control the player while transcribing
if ($(media).data('steno-mode') !== undefined && $(media).data('steno-mode') !== false) {
this.stenoMode = true;
// Add support for stenography in an iframe via data-steno-iframe-id
if ($(media).data('steno-iframe-id') !== undefined && $(media).data('steno-iframe-id') !== "") {
this.stenoFrameId = $(media).data('steno-iframe-id');
this.$stenoFrame = $('#' + this.stenoFrameId);
if (!(this.$stenoFrame.length)) {
// iframe not found
this.stenoFrameId = null;
this.$stenoFrame = null;
}
}
else {
this.stenoFrameId = null;
this.$stenoFrame = null;
}
}
else {
this.stenoMode = false;
this.stenoFrameId = null;
this.$stenoFrame = null;
}
// Define built-in variables that CANNOT be overridden with HTML attributes
this.setDefaults();
////////////////////////////////////////
//
// End assignment of default variables
//
////////////////////////////////////////
this.ableIndex = AblePlayer.nextIndex;
AblePlayer.nextIndex += 1;
this.title = $(media).attr('title');
// populate translation object with localized versions of all labels and prompts
// use defer method to defer additional processing until text is retrieved
this.tt = {};
var thisObj = this;
$.when(this.getTranslationText()).then(
function () {
if (thisObj.countProperties(thisObj.tt) > 50) {
// close enough to ensure that most text variables are populated
thisObj.setup();
}
else {
// can't continue loading player with no text
thisObj.provideFallback();
}
}
).
fail(function() {
thisObj.provideFallback();
});
};
// Index to increment every time new player is created.
AblePlayer.nextIndex = 0;
AblePlayer.prototype.setup = function() {
var thisObj = this;
this.initializing = true; // will remain true until entire sequence of function calls is complete
this.reinitialize().then(function () {
if (!thisObj.player) {
// No player for this media, show last-line fallback.
thisObj.provideFallback();
}
else {
thisObj.setupInstance().then(function () {
thisObj.setupInstancePlaylist();
if (thisObj.hasPlaylist) {
// for playlists, recreatePlayer() is called from within cuePlaylistItem()
}
else {
thisObj.recreatePlayer().then(function() {
thisObj.initializing = false;
thisObj.playerCreated = true; // remains true until browser is refreshed
});
}
});
}
});
};
AblePlayer.getActiveDOMElement = function () {
var activeElement = document.activeElement;
// For shadow DOMs we need to keep digging down through the DOMs
while (activeElement.shadowRoot && activeElement.shadowRoot.activeElement) {
activeElement = activeElement.shadowRoot.activeElement;
}
return activeElement;
};
AblePlayer.localGetElementById = function(element, id) {
if (element.getRootNode)
{
// Use getRootNode() and querySelector() where supported (for shadow DOM support)
return $(element.getRootNode().querySelector('#' + id));
}
else
{
// If getRootNode is not supported it should be safe to use document.getElementById (since there is no shadow DOM support)
return $(document.getElementById(id));
}
};
AblePlayer.youTubeIframeAPIReady = false;
AblePlayer.loadingYouTubeIframeAPI = false;
})(jQuery);