video.js/src/js/core.js

/**
 * @fileoverview Main function src.
 */

// HTML5 Shiv. Must be in <head> to support older browsers.
document.createElement('video');
document.createElement('audio');
document.createElement('track');

/**
 * Doubles as the main function for users to create a player instance and also
 * the main library object.
 *
 * @param  {String|Element} id      Video element or video element ID
 * @param  {Object=} options        Optional options object for config/settings
 * @param  {Function=} ready        Optional ready callback
 * @return {vjs.Player}             A player instance
 */
var vjs = function(id, options, ready){
  var tag; // Element of ID

  // Allow for element or ID to be passed in
  // String ID
  if (typeof id === 'string') {

    // Adjust for jQuery ID syntax
    if (id.indexOf('#') === 0) {
      id = id.slice(1);
    }

    // If a player instance has already been created for this ID return it.
    if (vjs.players[id]) {
      return vjs.players[id];

    // Otherwise get element for ID
    } else {
      tag = vjs.el(id);
    }

  // ID is a media element
  } else {
    tag = id;
  }

  // Check for a useable element
  if (!tag || !tag.nodeName) { // re: nodeName, could be a box div also
    throw new TypeError('The element or ID supplied is not valid. (videojs)'); // Returns
  }

  // Element may have a player attr referring to an already created player instance.
  // If not, set up a new player and return the instance.
  return tag['player'] || new vjs.Player(tag, options, ready);
};

// Extended name, also available externally, window.videojs
var videojs = vjs;
window.videojs = window.vjs = vjs;

// CDN Version. Used to target right flash swf.
vjs.CDN_VERSION = 'GENERATED_CDN_VSN';
vjs.ACCESS_PROTOCOL = ('https:' == document.location.protocol ? 'https://' : 'http://');

/**
 * Global Player instance options, surfaced from vjs.Player.prototype.options_
 * vjs.options = vjs.Player.prototype.options_
 * All options should use string keys so they avoid
 * renaming by closure compiler
 * @type {Object}
 */
vjs.options = {
  // Default order of fallback technology
  'techOrder': ['html5','flash'],
  // techOrder: ['flash','html5'],

  'html5': {},
  'flash': {},

  // Default of web browser is 300x150. Should rely on source width/height.
  'width': 300,
  'height': 150,
  // defaultVolume: 0.85,
  'defaultVolume': 0.00, // The freakin seaguls are driving me crazy!

  // Included control sets
  'children': {
    'mediaLoader': {},
    'posterImage': {},
    'textTrackDisplay': {},
    'loadingSpinner': {},
    'bigPlayButton': {},
    'controlBar': {}
  },

  // Default message to show when a video cannot be played.
  'notSupportedMessage': 'Sorry, no compatible source and playback ' +
      'technology were found for this video. Try using another browser ' +
      'like <a href="http://bit.ly/ccMUEC">Chrome</a> or download the ' +
      'latest <a href="http://adobe.ly/mwfN1">Adobe Flash Player</a>.'
};

// Set CDN Version of swf
// The added (+) blocks the replace from changing this GENERATED_CDN_VSN string
if (vjs.CDN_VERSION !== 'GENERATED'+'_CDN_VSN') {
  videojs.options['flash']['swf'] = vjs.ACCESS_PROTOCOL + 'vjs.zencdn.net/'+vjs.CDN_VERSION+'/video-js.swf';
}

/**
 * Global player list
 * @type {Object}
 */
vjs.players = {};
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`/**`
Update grunt build script. 2013-01-12 22:23:22 -08:00			`* @fileoverview Main function src.`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`*/`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`// HTML5 Shiv. Must be in <head> to support older browsers.`
Close GH-609: Captions fixes. Fixes #564, Fixes #542 2013-06-28 13:06:50 -07:00			`document.createElement('video');`
			`document.createElement('audio');`
			`document.createElement('track');`
Major rewrite to support Google Closure Compiler Advanced Optimization. Still in process. 2012-12-30 21:45:50 -08:00
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`/**`
			`* Doubles as the main function for users to create a player instance and also`
			`* the main library object.`
			`*`
			`* @param {String\|Element} id Video element or video element ID`
			`* @param {Object=} options Optional options object for config/settings`
			`* @param {Function=} ready Optional ready callback`
			`* @return {vjs.Player} A player instance`
			`*/`
Close GH-346: Remove need for good.require/good.provide. 2013-02-22 22:26:58 -05:00			`var vjs = function(id, options, ready){`
Modified some comments 2011-11-30 11:53:08 -08:00			`var tag; // Element of ID`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
			`// Allow for element or ID to be passed in`
			`// String ID`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`if (typeof id === 'string') {`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
			`// Adjust for jQuery ID syntax`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`if (id.indexOf('#') === 0) {`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00			`id = id.slice(1);`
			`}`

			`// If a player instance has already been created for this ID return it.`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`if (vjs.players[id]) {`
			`return vjs.players[id];`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
			`// Otherwise get element for ID`
			`} else {`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`tag = vjs.el(id);`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00			`}`

			`// ID is a media element`
			`} else {`
			`tag = id;`
			`}`

			`// Check for a useable element`
			`if (!tag \|\| !tag.nodeName) { // re: nodeName, could be a box div also`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`throw new TypeError('The element or ID supplied is not valid. (videojs)'); // Returns`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00			`}`

			`// Element may have a player attr referring to an already created player instance.`
			`// If not, set up a new player and return the instance.`
Changed this.player to this.player_ to be more consistent with other private vars. 2013-01-16 20:24:38 -05:00			`return tag['player'] \|\| new vjs.Player(tag, options, ready);`
Major rewrite to support Google Closure Compiler Advanced Optimization. Still in process. 2012-12-30 21:45:50 -08:00			`};`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`// Extended name, also available externally, window.videojs`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`var videojs = vjs;`
Add videojs to window directly. Fix #448 2013-04-22 11:32:17 -04:00			`window.videojs = window.vjs = vjs;`
Fixed CDN Version that was breaking dev.html. Fixed Double auto-setup 2012-01-14 18:13:13 -08:00
			`// CDN Version. Used to target right flash swf.`
Uppercase constants 2013-01-18 16:54:45 -08:00			`vjs.CDN_VERSION = 'GENERATED_CDN_VSN';`
			`vjs.ACCESS_PROTOCOL = ('https:' == document.location.protocol ? 'https://' : 'http://');`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
Major rewrite to support Google Closure Compiler Advanced Optimization. Still in process. 2012-12-30 21:45:50 -08:00			`/**`
Updated player options to use component options_ settings and mergeOptions. 2013-01-21 16:19:46 -08:00			`* Global Player instance options, surfaced from vjs.Player.prototype.options_`
			`* vjs.options = vjs.Player.prototype.options_`
			`* All options should use string keys so they avoid`
			`* renaming by closure compiler`
Major rewrite to support Google Closure Compiler Advanced Optimization. Still in process. 2012-12-30 21:45:50 -08:00			`* @type {Object}`
			`*/`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`vjs.options = {`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00			`// Default order of fallback technology`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`'techOrder': ['html5','flash'],`
			`// techOrder: ['flash','html5'],`
Changed h5swf name to just Flash for ease of use. And lowercased tech object names. 2011-12-07 21:03:12 -08:00
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`'html5': {},`
Close GH-535: Adding version numbers in build. Minifying CSS.. 2013-05-23 13:10:29 -07:00			`'flash': {},`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
use {width: "auto", height: "auto"} to let css decide video dimensions 2013-03-07 23:21:08 +02:00			`// Default of web browser is 300x150. Should rely on source width/height.`
			`'width': 300,`
			`'height': 150,`
Updated swf object to newest version. Optimizing player for later loaded sources. 2011-12-01 15:47:12 -08:00			`// defaultVolume: 0.85,`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`'defaultVolume': 0.00, // The freakin seaguls are driving me crazy!`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00
			`// Included control sets`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`'children': {`
Updated closure compiler advanced mode branch 2013-01-10 13:06:12 -08:00			`'mediaLoader': {},`
			`'posterImage': {},`
			`'textTrackDisplay': {},`
			`'loadingSpinner': {},`
			`'bigPlayButton': {},`
			`'controlBar': {}`
Default incompatibility msg w/ other global options fixes #636 2013-08-05 14:19:20 -04:00			`},`

			`// Default message to show when a video cannot be played.`
Merge branch '636-incompatible' of git://github.com/jelbourn/video.js into jelbourn-636-incompatible Conflicts: test/unit/player.js 2013-08-27 10:26:32 -07:00			`'notSupportedMessage': 'Sorry, no compatible source and playback ' +`
Default incompatibility msg w/ other global options fixes #636 2013-08-05 14:19:20 -04:00			`'technology were found for this video. Try using another browser ' +`
			`'like <a href="http://bit.ly/ccMUEC">Chrome</a> or download the ' +`
			`'latest <a href="http://adobe.ly/mwfN1">Adobe Flash Player</a>.'`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 11:40:05 -08:00			`};`

Close GH-535: Adding version numbers in build. Minifying CSS.. 2013-05-23 13:10:29 -07:00			`// Set CDN Version of swf`
			`// The added (+) blocks the replace from changing this GENERATED_CDN_VSN string`
			`if (vjs.CDN_VERSION !== 'GENERATED'+'_CDN_VSN') {`
			`videojs.options['flash']['swf'] = vjs.ACCESS_PROTOCOL + 'vjs.zencdn.net/'+vjs.CDN_VERSION+'/video-js.swf';`
			`}`

Major rewrite to support Google Closure Compiler Advanced Optimization. Still in process. 2012-12-30 21:45:50 -08:00			`/**`
			`* Global player list`
			`* @type {Object}`
			`*/`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-04 16:58:23 -08:00			`vjs.players = {};`