merge main into develop with 4.5.1 patch

ableplayer · joedolson · Jun 15, 2025 · Nov 11, 2022 · Nov 11, 2022 · Nov 20, 2022
commit e129d083d51765b190835c467e384ddc1a059259
diff --git a/build/ableplayer.dist.js b/build/ableplayer.dist.js
diff --git a/build/ableplayer.js b/build/ableplayer.js
diff --git a/build/ableplayer.min.js b/build/ableplayer.min.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ableplayer",
-  "version": "4.5.3",
+  "version": "4.5.1",
   "description": "Accessible HTML5 media player",
   "homepage": "http://ableplayer.github.io/ableplayer",
   "bugs": "https://github.com/ableplayer/ableplayer/issues",

diff --git a/scripts/caption.js b/scripts/caption.js
@@ -1,35 +1,39 @@
 (function ($) {
+  AblePlayer.prototype.updateCaption = function (time) {
+    if (
+      !this.usingYouTubeCaptions &&
+      !this.usingVimeoCaptions &&
+      typeof this.$captionsWrapper !== "undefined"
+    ) {
+      if (this.captionsOn) {
+        this.$captionsWrapper.show();
+        if (typeof time !== "undefined") {
+          this.showCaptions(time);
+        }
+      } else if (this.$captionsWrapper) {
+        this.$captionsWrapper.hide();
+        this.prefCaptions = 0;
+      }
+    }
+  };
 
-	AblePlayer.prototype.updateCaption = function (time) {
-
-		if (!this.usingYouTubeCaptions && !this.usingVimeoCaptions &&
-			(typeof this.$captionsWrapper !== 'undefined')) {
-			if (this.captionsOn) {
-				this.$captionsWrapper.show();
-				if (typeof time !== 'undefined') {
-					this.showCaptions(time);
-				}
-			}
-			else if (this.$captionsWrapper) {
-				this.$captionsWrapper.hide();
-				this.prefCaptions = 0;
-			}
-		}
-	};
-
-	AblePlayer.prototype.updateCaptionsMenu = function (lang) {
+  AblePlayer.prototype.updateCaptionsMenu = function (lang) {
+    // uncheck all previous menu items
+    this.captionsPopup.find("li").attr("aria-checked", "false");
+    if (typeof lang === "undefined") {
+      // check the last menu item (captions off)
+      this.captionsPopup.find("li").last().attr("aria-checked", "true");
+    } else {
+      // check the newly selected lang
+      this.captionsPopup
+        .find("li[lang=" + lang + "]")
+        .attr("aria-checked", "true");
+    }
+  };
 
-		// uncheck all previous menu items
-		this.captionsPopup.find('li').attr('aria-checked','false');
-		if (typeof lang === 'undefined') {
-			// check the last menu item (captions off)
-			this.captionsPopup.find('li').last().attr('aria-checked','true');
-		}
-		else {
-			// check the newly selected lang
-			this.captionsPopup.find('li[lang=' + lang + ']').attr('aria-checked','true');
-		}
-	};
+  AblePlayer.prototype.getCaptionClickFunction = function (track) {
+    // Returns the function used when a caption is clicked in the captions menu.
+    // Not called if user clicks "Captions off". Instead, that triggers getCaptionOffFunction()
 
     var thisObj = this;
     return function () {
@@ -146,79 +150,9 @@
       thisObj.captionsOn = false;
       thisObj.currentCaption = -1;
 
-			thisObj.selectedCaptions = track;
-			thisObj.captionLang = track.language;
-			thisObj.currentCaption = -1;
-			if (thisObj.usingYouTubeCaptions) {
-				if (thisObj.captionsOn) {
-					// Two things must be true in order for setOption() to work:
-					// The YouTube caption module must be loaded
-					// and the video must have started playing
-					if (thisObj.youTubePlayer.getOptions('captions') && thisObj.startedPlaying) {
-						thisObj.youTubePlayer.setOption('captions', 'track', {'languageCode': thisObj.captionLang});
-					}
-					else {
-						// the two conditions were not met
-						// try again to set the language after onApiChange event is triggered
-						// meanwhile, the following variable will hold the value
-						thisObj.captionLangPending = thisObj.captionLang;
-					}
-				}
-				else {
-					if (thisObj.youTubePlayer.getOptions('captions')) {
-						thisObj.youTubePlayer.setOption('captions', 'track', {'languageCode': thisObj.captionLang});
-					}
-					else {
-						thisObj.youTubePlayer.loadModule('captions');
-						thisObj.captionLangPending = thisObj.captionLang;
-					}
-				}
-			}
-			else if (thisObj.usingVimeoCaptions) {
-				thisObj.vimeoPlayer.enableTextTrack(thisObj.captionLang).then(function(track) {
-					// track.language = the iso code for the language
-					// track.kind = 'captions' or 'subtitles'
-					// track.label = the human-readable label
-				}).catch(function(error) {
-					switch (error.name) {
-						case 'InvalidTrackLanguageError':
-							// no track was available with the specified language
-							console.log('No ' + track.kind + ' track is available in the specified language (' + track.label + ')');
-							break;
-						case 'InvalidTrackError':
-							// no track was available with the specified language and kind
-							console.log('No ' + track.kind + ' track is available in the specified language (' + track.label + ')');
-							break;
-						default:
-							// some other error occurred
-							console.log('Error loading ' + track.label + ' ' + track.kind + ' track');
-							break;
-						}
-				});
-			}
-			else { // using local track elements for captions/subtitles
-				thisObj.syncTrackLanguages('captions',thisObj.captionLang);
-				if (!thisObj.swappingSrc) {
-					thisObj.updateCaption(thisObj.elapsed);
-					thisObj.showDescription(thisObj.elapsed);
-				}
-			}
-			thisObj.captionsOn = true;
-			// stopgap to prevent spacebar in Firefox from reopening popup
-			// immediately after closing it (used in handleCaptionToggle())
-			thisObj.hidingPopup = true;
-			thisObj.captionsPopup.hide();
-			thisObj.$ccButton.attr('aria-expanded', 'false');
-			if (thisObj.mediaType === 'audio') {
-				thisObj.$captionsContainer.removeClass('captions-off');
-			}
-			// Ensure stopgap gets cancelled if handleCaptionToggle() isn't called
-			// e.g., if user triggered button with Enter or mouse click, not spacebar
-			setTimeout(function() {
-				thisObj.hidingPopup = false;
-			}, 100);
-			thisObj.updateCaptionsMenu(thisObj.captionLang);
-			thisObj.waitThenFocus(thisObj.$ccButton);
+      if (thisObj.mediaType === "audio") {
+        thisObj.$captionsContainer.addClass("captions-off");
+      }
 
       // stopgap to prevent spacebar in Firefox from reopening popup
       // immediately after closing it (used in handleCaptionToggle())
@@ -295,43 +229,12 @@
 
     // ruby: http://www.w3schools.com/tags/tag_ruby.asp
 
-		var c, thisCaption, captionText;
-		var cues;
-		if (this.selectedCaptions.cues.length) {
-			cues = this.selectedCaptions.cues;
-		}
-		else if (this.captions.length >= 1) {
-			cues = this.captions[0].cues;
-		}
-		else {
-			cues = [];
-		}
-		for (c = 0; c < cues.length; c++) {
-			if ((cues[c].start <= now) && (cues[c].end > now)) {
-				thisCaption = c;
-				break;
-			}
-		}
-		if (typeof thisCaption !== 'undefined') {
-			if (this.currentCaption !== thisCaption) {
-				// it's time to load the new caption into the container div
-				captionText = this.flattenCueForCaption(cues[thisCaption]).replace('\n', '<br>');
-				this.$captionsDiv.html(captionText);
-				this.currentCaption = thisCaption;
-				if (captionText.length === 0) {
-					// hide captionsDiv; otherwise background-color is visible due to padding
-					this.$captionsDiv.css('display','none');
-				}
-				else {
-					this.$captionsDiv.css('display','inline-block');
-				}
-			}
-		}
-		else {
-			this.$captionsDiv.html('').css('display','none');
-			this.currentCaption = -1;
-		}
-	};
+    // WebVTT also supports 'u' (underline)
+    // I see no reason to support that in Able Player.
+    // If it's available authors are likely to use it incorrectly
+    // where <i> or <b> should be used instead
+    // Here are the rare use cases where an underline is appropriate on the web:
+    // http://html5doctor.com/u-element/
 
     var result = [];
 

diff --git a/scripts/misc.js b/scripts/misc.js
@@ -106,10 +106,21 @@
     // Converts string of form hh:mm:ss to seconds
     var timeParts, hours, minutes, seconds, newTime;
 
-		// Takes seconds and converts to string of form hh:mm:ss
-		// If showFullTime is true, shows 00 for hours if time is less than an hour
-		// and show milliseconds (e.g., 00:00:04.123 as in Video Track Sorter)
-		// Otherwise, omits empty hours and milliseconds (e.g., 00:04 as in timer on controller)
+    timeParts = timeStr.split(":");
+    if (timeParts.length === 3) {
+      hours = parseInt(timeParts[0]);
+      minutes = parseInt(timeParts[1]);
+      seconds = parseFloat(timeParts[2]);
+      return hours * 3600 + minutes * 60 + seconds;
+    } else if (timeParts.length === 2) {
+      minutes = parseInt(timeParts[0]);
+      seconds = parseFloat(timeParts[1]);
+      return minutes * 60 + seconds;
+    } else if (timeParts.length === 1) {
+      seconds = parseFloat(timeParts[0]);
+      return seconds;
+    }
+  };
 
   AblePlayer.prototype.capitalizeFirstLetter = function (string) {
     return string.charAt(0).toUpperCase() + string.slice(1);
@@ -129,60 +140,14 @@
 
     var attr = object.attr(attribute);
 
-		timeParts = timeStr.split(':');
-		if (timeParts.length === 3) {
-			hours = parseInt(timeParts[0]);
-			minutes = parseInt(timeParts[1]);
-			seconds = parseFloat(timeParts[2]);
-			return ((hours * 3600) + (minutes * 60) + (seconds));
-		}
-		else if (timeParts.length === 2) {
-			minutes = parseInt(timeParts[0]);
-			seconds = parseFloat(timeParts[1]);
-			return ((minutes * 60) + (seconds));
-		}
-		else if (timeParts.length === 1) {
-			seconds = parseFloat(timeParts[0]);
-			return seconds;
-		}
-	};
-
-	AblePlayer.prototype.capitalizeFirstLetter = function (string) {
-		return string.charAt(0).toUpperCase() + string.slice(1);
-	};
-
-	AblePlayer.prototype.roundDown = function (value, decimals) {
-
-		// round value down to the nearest X decimal points
-		// where X is the value of the decimals parameter
-		return Number(Math.floor(value+'e'+decimals)+'e-'+decimals);
-	};
-
-	AblePlayer.prototype.hasAttr = function (object, attribute) {
-
-		 // surprisingly, there is no hasAttr() function in Jquery as of 3.2.1
-		 // return true if object has attribute; otherwise false
-		 // selector is a Jquery object
-		 // attribute is a string
-
-		var attr = object.attr(attribute);
-
-		// For some browsers, `attr` is undefined; for others,
-		// `attr` is false. Check for both.
-		if (typeof attr !== typeof undefined && attr !== false) {
-			return true;
-		}
-		else {
-			 return false;
-		}
-	};
-
-	Number.isInteger = Number.isInteger || function(value) {
-
-		// polyfill for IE11, which doesn't otherwise support Number.isInteger
-		// https://stackoverflow.com/a/31720368/744281
-		return typeof value === "number" && isFinite(value) && Math.floor(value) === value;
-	};
+    // For some browsers, `attr` is undefined; for others,
+    // `attr` is false.	 Check for both.
+    if (typeof attr !== typeof undefined && attr !== false) {
+      return true;
+    } else {
+      return false;
+    }
+  };
 
   Number.isInteger =
     Number.isInteger ||