13 lines
405 KiB
JavaScript
13 lines
405 KiB
JavaScript
|
var docData=[{comment:"/**\n* @file base-styles.js\n*\n* This code injects the required base styles in the head of the document.\n*/",meta:{range:[0,105],filename:"base-styles.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},name:"base-styles.js",kind:"file",description:"<p>base-styles.js</p>\n<p>This code injects the required base styles in the head of the document.</p>",preserveName:!0,longname:"base-styles.js",scope:"global"},{comment:"/**\n* @file big-play-button.js\n*/",meta:{range:[0,33],filename:"big-play-button.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},name:"big-play-button.js",kind:"file",description:"<p>big-play-button.js</p>",preserveName:!0,longname:"big-play-button.js",scope:"global"},{comment:"/**\n* Initial play button. Shows before the video has played. The hiding of the\n* big play button is done via CSS and player states.\n*\n* @param {Object} player Main Player\n* @param {Object=} options Object of option names and values\n* @extends Button\n* @class BigPlayButton\n*/",meta:{range:[43,320],filename:"big-play-button.js",lineno:7,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Initial play button. Shows before the video has played. The hiding of the\nbig play button is done via CSS and player states.</p>",params:[{type:{names:["Object"]},description:"<p>Main Player</p>",name:"player"},{type:{names:["Object"]},optional:!0,description:"<p>Object of option names and values</p>",name:"options"}],augments:["Button"],kind:"class",name:"BigPlayButton",longname:"BigPlayButton",scope:"global"},{comment:"/**\n* Allow sub components to stack CSS class names\n*\n* @return {String} The constructed class name\n* @method buildCSSClass\n*/",meta:{range:[339,465],filename:"big-play-button.js",lineno:22,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Allow sub components to stack CSS class names</p>",returns:[{type:{names:["String"]},description:"<p>The constructed class name</p>"}],kind:"function",name:"buildCSSClass",longname:"buildCSSClass",scope:"global"},{comment:"/**\n* Handles click for play\n*\n* @method handleClick\n*/",meta:{range:[478,533],filename:"big-play-button.js",lineno:32,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Handles click for play</p>",kind:"function",name:"handleClick",longname:"handleClick",scope:"global"},{comment:"/**\n* @file button.js\n*/",meta:{range:[0,24],filename:"button.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},name:"button.js",kind:"file",description:"<p>button.js</p>",preserveName:!0,longname:"button.js",scope:"global"},{comment:"/**\n* Base class for all buttons\n*\n* @param {Object} player Main Player\n* @param {Object=} options Object of option names and values\n* @extends ClickableComponent\n* @class Button\n*/",meta:{range:[49,231],filename:"button.js",lineno:12,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Base class for all buttons</p>",params:[{type:{names:["Object"]},description:"<p>Main Player</p>",name:"player"},{type:{names:["Object"]},optional:!0,description:"<p>Object of option names and values</p>",name:"options"}],augments:["ClickableComponent"],kind:"class",name:"Button",longname:"Button",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @param {String=} type Element's node type. e.g. 'div'\n* @param {Object=} props An object of properties that should be set on the element\n* @param {Object=} attributes An object of attributes that should be set on the element\n* @return {Element}\n* @method createEl\n*/",meta:{range:[250,561],filename:"button.js",lineno:26,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Create the component's DOM element</p>",params:[{type:{names:["String"]},optional:!0,description:"<p>Element's node type. e.g. 'div'</p>",name:"type"},{type:{names:["Object"]},optional:!0,description:"<p>An object of properties that should be set on the element</p>",name:"props"},{type:{names:["Object"]},optional:!0,description:"<p>An object of attribut
|
||
|
|
params:[{type:{names:["String","Component"]},description:"<p>The event type or other component</p>",name:"first"},{type:{names:["function","String"]},description:"<p>The event handler or event type</p>",name:"second"},{type:{names:["function"]},description:"<p>The event handler</p>",name:"third"}],returns:[{type:{names:["Component"]}}],kind:"function",name:"on",longname:"on",scope:"global"},{comment:"/**\n* Remove an event listener from this component's element\n* ```js\n* myComponent.off('eventType', myFunc);\n* ```\n* If myFunc is excluded, ALL listeners for the event type will be removed.\n* If eventType is excluded, ALL listeners will be removed from the component.\n* Alternatively you can use `off` to remove listeners that were added to other\n* elements or components using `myComponent.on(otherComponent...`.\n* In this case both the event type and listener function are REQUIRED.\n* ```js\n* myComponent.off(otherElement, 'eventType', myFunc);\n* myComponent.off(otherComponent, 'eventType', myFunc);\n* ```\n*\n* @param {String=|Component} first The event type or other component\n* @param {Function=|String} second The listener function or event type\n* @param {Function=} third The listener for other component\n* @return {Component}\n* @method off\n*/",meta:{range:[8327,9213],filename:"component.js",lineno:682,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Remove an event listener from this component's element</p>\n<pre class=\"prettyprint source lang-js\"><code> myComponent.off('eventType', myFunc);</code></pre><p>If myFunc is excluded, ALL listeners for the event type will be removed.\nIf eventType is excluded, ALL listeners will be removed from the component.\nAlternatively you can use <code>off</code> to remove listeners that were added to other\nelements or components using <code>myComponent.on(otherComponent...</code>.\nIn this case both the event type and listener function are REQUIRED.</p>\n<pre class=\"prettyprint source lang-js\"><code> myComponent.off(otherElement, 'eventType', myFunc);\n myComponent.off(otherComponent, 'eventType', myFunc);</code></pre>",params:[{type:{names:["String","Component"]},description:"<p>The event type or other component</p>",name:"first"},{type:{names:["function","String"]},description:"<p>The listener function or event type</p>",name:"second"},{type:{names:["function"]},optional:!0,description:"<p>The listener for other component</p>",name:"third"}],returns:[{type:{names:["Component"]}}],kind:"function",name:"off",longname:"off",scope:"global"},{comment:"/**\n* Add an event listener to be triggered only once and then removed\n* ```js\n* myComponent.one('eventName', myFunc);\n* ```\n* Alternatively you can add a listener to another element or component\n* that will be triggered only once.\n* ```js\n* myComponent.one(otherElement, 'eventName', myFunc);\n* myComponent.one(otherComponent, 'eventName', myFunc);\n* ```\n*\n* @param {String|Component} first The event type or other component\n* @param {Function|String} second The listener function or event type\n* @param {Function=} third The listener function for other component\n* @return {Component}\n* @method one\n*/",meta:{range:[9295,9937],filename:"component.js",lineno:730,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Add an event listener to be triggered only once and then removed</p>\n<pre class=\"prettyprint source lang-js\"><code> myComponent.one('eventName', myFunc);</code></pre><p>Alternatively you can add a listener to another element or component\nthat will be triggered only once.</p>\n<pre class=\"prettyprint source lang-js\"><code> myComponent.one(otherElement, 'eventName', myFunc);\n myComponent.one(otherComponent, 'eventName', myFunc);</code></pre>",params:[{type:{names:["String","Component"]},description:"<p>The event type or other component</p>",name:"first"},{type:{names:["function","String"]},description:"<p>The listener function or event type</p>",name:"second"},{type:{na
|
||
|
|
meta:{range:[419,529],filename:"audio-track-button.js",lineno:36,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/audio-track-controls",code:{}},description:"<p>Create a menu item for each audio track</p>",returns:[{type:{names:["Array"]},description:"<p>Array of menu items</p>"}],kind:"function",name:"createItems",longname:"createItems",scope:"global"},{comment:"/**\n* @file audio-track-menu-item.js\n*/",meta:{range:[0,39],filename:"audio-track-menu-item.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/audio-track-controls",code:{}},name:"control-bar/audio-track-controls/audio-track-menu-item.js",kind:"file",description:"<p>audio-track-menu-item.js</p>",preserveName:!0,longname:"control-bar/audio-track-controls/audio-track-menu-item.js",scope:"global"},{comment:"/**\n* The audio track menu item\n*\n* @param {Player|Object} player\n* @param {Object=} options\n* @extends MenuItem\n* @class AudioTrackMenuItem\n*/",meta:{range:[52,195],filename:"audio-track-menu-item.js",lineno:8,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/audio-track-controls",code:{}},description:"<p>The audio track menu item</p>",params:[{type:{names:["Player","Object"]},name:"player"},{type:{names:["Object"]},optional:!0,name:"options"}],augments:["MenuItem"],kind:"class",name:"AudioTrackMenuItem",longname:"AudioTrackMenuItem",scope:"global"},{comment:"/**\n* Handle click on audio track\n*\n* @method handleClick\n*/",meta:{range:[265,325],filename:"audio-track-menu-item.js",lineno:39,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/audio-track-controls",code:{}},description:"<p>Handle click on audio track</p>",kind:"function",name:"handleClick",longname:"handleClick",scope:"global"},{comment:"/**\n* Handle audio track change\n*\n* @method handleTracksChange\n*/",meta:{range:[368,433],filename:"audio-track-menu-item.js",lineno:58,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/audio-track-controls",code:{}},description:"<p>Handle audio track change</p>",kind:"function",name:"handleTracksChange",longname:"handleTracksChange",scope:"global"},{comment:"/**\n* @file control-bar.js\n*/",meta:{range:[0,29],filename:"control-bar.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},name:"control-bar/control-bar.js",kind:"file",description:"<p>control-bar.js</p>",preserveName:!0,longname:"control-bar/control-bar.js",scope:"global"},{comment:"/**\n* Container of main controls\n*\n* @extends Component\n* @class ControlBar\n*/",meta:{range:[96,174],filename:"control-bar.js",lineno:26,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Container of main controls</p>",augments:["Component"],kind:"class",name:"ControlBar",longname:"ControlBar",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @return {Element}\n* @method createEl\n*/",meta:{range:[181,265],filename:"control-bar.js",lineno:34,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Create the component's DOM element</p>",returns:[{type:{names:["Element"]}}],kind:"function",name:"createEl",longname:"createEl",scope:"global"},{comment:"/**\n* @file fullscreen-toggle.js\n*/",meta:{range:[0,35],filename:"fullscreen-toggle.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},name:"control-bar/fullscreen-toggle.js",kind:"file",description:"<p>fullscreen-toggle.js</p>",preserveName:!0,longname:"control-bar/fullscreen-toggle.js",scope:"global"},{comment:"/**\n* Toggle fullscreen video\n*\n* @extends Button\n* @class FullscreenToggle\n*/",meta:{range:[45,123],filename:"fullscreen-toggle.js",lineno:7,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Toggle fullscreen video</p>",augments:["Button"],kind:"class",name:"FullscreenToggle",longname:"FullscreenToggle",scope:"global"},{comment:"/**\n* Allow sub components to stack CSS class names\n*\n* @return {String} The constructed class name\n* @method buildCSSClass\n*/",meta:{range:[145,271],filename:"fullscreen-toggle.js",lineno:20,path:"/Us
|
||
|
|
}],kind:"function",name:"buildCSSClass",longname:"buildCSSClass",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @return {Element}\n* @method createEl\n*/",meta:{range:[333,417],filename:"custom-control-spacer.js",lineno:25,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/spacer-controls",code:{}},description:"<p>Create the component's DOM element</p>",returns:[{type:{names:["Element"]}}],kind:"function",name:"createEl",longname:"createEl",scope:"global"},{comment:"/**\n* @file spacer.js\n*/",meta:{range:[0,24],filename:"spacer.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/spacer-controls",code:{}},name:"control-bar/spacer-controls/spacer.js",kind:"file",description:"<p>spacer.js</p>",preserveName:!0,longname:"control-bar/spacer-controls/spacer.js",scope:"global"},{comment:"/**\n* Just an empty spacer element that can be used as an append point for plugins, etc.\n* Also can be used to create space between elements when necessary.\n*\n* @extends Component\n* @class Spacer\n*/",meta:{range:[31,229],filename:"spacer.js",lineno:6,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/spacer-controls",code:{}},description:"<p>Just an empty spacer element that can be used as an append point for plugins, etc.\nAlso can be used to create space between elements when necessary.</p>",augments:["Component"],kind:"class",name:"Spacer",longname:"Spacer",scope:"global"},{comment:"/**\n* Allow sub components to stack CSS class names\n*\n* @return {String} The constructed class name\n* @method buildCSSClass\n*/",meta:{range:[236,362],filename:"spacer.js",lineno:15,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/spacer-controls",code:{}},description:"<p>Allow sub components to stack CSS class names</p>",returns:[{type:{names:["String"]},description:"<p>The constructed class name</p>"}],kind:"function",name:"buildCSSClass",longname:"buildCSSClass",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @return {Element}\n* @method createEl\n*/",meta:{range:[375,459],filename:"spacer.js",lineno:25,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/spacer-controls",code:{}},description:"<p>Create the component's DOM element</p>",returns:[{type:{names:["Element"]}}],kind:"function",name:"createEl",longname:"createEl",scope:"global"},{comment:"/**\n* @file caption-settings-menu-item.js\n*/",meta:{range:[0,44],filename:"caption-settings-menu-item.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/text-track-controls",code:{}},name:"control-bar/text-track-controls/caption-settings-menu-item.js",kind:"file",description:"<p>caption-settings-menu-item.js</p>",preserveName:!0,longname:"control-bar/text-track-controls/caption-settings-menu-item.js",scope:"global"},{comment:"/**\n* The menu item for caption track settings menu\n*\n* @param {Player|Object} player\n* @param {Object=} options\n* @extends TextTrackMenuItem\n* @class CaptionSettingsMenuItem\n*/",meta:{range:[54,231],filename:"caption-settings-menu-item.js",lineno:7,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/text-track-controls",code:{}},description:"<p>The menu item for caption track settings menu</p>",params:[{type:{names:["Player","Object"]},name:"player"},{type:{names:["Object"]},optional:!0,name:"options"}],augments:["TextTrackMenuItem"],kind:"class",name:"CaptionSettingsMenuItem",longname:"CaptionSettingsMenuItem",scope:"global"},{comment:"/**\n* Handle click on menu item\n*\n* @method handleClick\n*/",meta:{range:[292,350],filename:"caption-settings-menu-item.js",lineno:35,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/text-track-controls",code:{}},description:"<p>Handle click on menu item</p>",kind:"function",name:"handleClick",longname:"handleClick",scope:"global"},{comment:"/**\n* @file captions-button.js\n*/",meta:{range:[0,33],filename:"captions-button.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/text-track-controls",code:{}},name:"control-bar/text-track-controls/captions-button.js",kind:"file",description:"<p>captions-
|
||
|
|
params:[{type:{names:["Player","Object"]},name:"player"},{type:{names:["Object"]},optional:!0,name:"options"}],augments:["Component"],kind:"class",name:"VolumeControl",longname:"VolumeControl",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @return {Element}\n* @method createEl\n*/",meta:{range:[263,347],filename:"volume-control.js",lineno:35,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/volume-control",code:{}},description:"<p>Create the component's DOM element</p>",returns:[{type:{names:["Element"]}}],kind:"function",name:"createEl",longname:"createEl",scope:"global"},{comment:"/**\n* @file volume-level.js\n*/",meta:{range:[0,30],filename:"volume-level.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/volume-control",code:{}},name:"control-bar/volume-control/volume-level.js",kind:"file",description:"<p>volume-level.js</p>",preserveName:!0,longname:"control-bar/volume-control/volume-level.js",scope:"global"},{comment:"/**\n* Shows volume level\n*\n* @param {Player|Object} player\n* @param {Object=} options\n* @extends Component\n* @class VolumeLevel\n*/",meta:{range:[37,167],filename:"volume-level.js",lineno:6,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/volume-control",code:{}},description:"<p>Shows volume level</p>",params:[{type:{names:["Player","Object"]},name:"player"},{type:{names:["Object"]},optional:!0,name:"options"}],augments:["Component"],kind:"class",name:"VolumeLevel",longname:"VolumeLevel",scope:"global"},{comment:"/**\n* Create the component's DOM element\n*\n* @return {Element}\n* @method createEl\n*/",meta:{range:[174,258],filename:"volume-level.js",lineno:16,path:"/Users/mboles/git/docs/video.js/src/js/control-bar/volume-control",code:{}},description:"<p>Create the component's DOM element</p>",returns:[{type:{names:["Element"]}}],kind:"function",name:"createEl",longname:"createEl",scope:"global"},{comment:"/**\n* @file volume-menu-button.js\n*/",meta:{range:[0,36],filename:"volume-menu-button.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},name:"control-bar/volume-menu-button.js",kind:"file",description:"<p>volume-menu-button.js</p>",preserveName:!0,longname:"control-bar/volume-menu-button.js",scope:"global"},{comment:"/**\n* Button for volume popup\n*\n* @param {Player|Object} player\n* @param {Object=} options\n* @extends PopupButton\n* @class VolumeMenuButton\n*/",meta:{range:[58,200],filename:"volume-menu-button.js",lineno:11,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Button for volume popup</p>",params:[{type:{names:["Player","Object"]},name:"player"},{type:{names:["Object"]},optional:!0,name:"options"}],augments:["PopupButton"],kind:"class",name:"VolumeMenuButton",longname:"VolumeMenuButton",scope:"global"},{comment:"/**\n* Allow sub components to stack CSS class names\n*\n* @return {String} The constructed class name\n* @method buildCSSClass\n*/",meta:{range:[378,504],filename:"volume-menu-button.js",lineno:78,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Allow sub components to stack CSS class names</p>",returns:[{type:{names:["String"]},description:"<p>The constructed class name</p>"}],kind:"function",name:"buildCSSClass",longname:"buildCSSClass",scope:"global"},{comment:"/**\n* Allow sub components to stack CSS class names\n*\n* @return {Popup} The volume popup button\n* @method createPopup\n*/",meta:{range:[538,658],filename:"volume-menu-button.js",lineno:95,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Allow sub components to stack CSS class names</p>",returns:[{type:{names:["Popup"]},description:"<p>The volume popup button</p>"}],kind:"function",name:"createPopup",longname:"createPopup",scope:"global"},{comment:"/**\n* Handle click on volume popup and calls super\n*\n* @method handleClick\n*/",meta:{range:[710,787],filename:"volume-menu-button.js",lineno:118,path:"/Users/mboles/git/docs/video.js/src/js/control-bar",code:{}},description:"<p>Handle click on volume popup and calls
|
||
|
|
meta:{range:[2936,3080],filename:"player.js",lineno:414,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Add/remove the vjs-fluid class</p>",params:[{type:{names:["Boolean"]},description:"<p>Value of true adds the class, value of false removes the class</p>",name:"bool"}],kind:"function",name:"fluid",longname:"fluid",scope:"global"},{comment:"/**\n* Get/Set the aspect ratio\n*\n* @param {String=} ratio Aspect ratio for player\n* @return aspectRatio\n* @method aspectRatio\n*/",meta:{range:[3123,3251],filename:"player.js",lineno:434,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get/Set the aspect ratio</p>",params:[{type:{names:["String"]},optional:!0,description:"<p>Aspect ratio for player</p>",name:"ratio"}],returns:[{description:"<p>aspectRatio</p>"}],kind:"function",name:"aspectRatio",longname:"aspectRatio",scope:"global"},{comment:"/**\n* Update styles of the player element (height, width and aspect ratio)\n*\n* @method updateStyleEl_\n*/",meta:{range:[3306,3410],filename:"player.js",lineno:459,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Update styles of the player element (height, width and aspect ratio)</p>",kind:"function",name:"updateStyleEl_",longname:"updateStyleEl_",scope:"global"},{comment:"/**\n* Load the Media Playback Technology (tech)\n* Load/Create an instance of playback technology including element and API methods\n* And append playback element in player div.\n*\n* @param {String} techName Name of the playback technology\n* @param {String} source Video source\n* @method loadTech_\n* @private\n*/",meta:{range:[3651,3959],filename:"player.js",lineno:544,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Load the Media Playback Technology (tech)\nLoad/Create an instance of playback technology including element and API methods\nAnd append playback element in player div.</p>",params:[{type:{names:["String"]},description:"<p>Name of the playback technology</p>",name:"techName"},{type:{names:["String"]},description:"<p>Video source</p>",name:"source"}],kind:"function",name:"loadTech_",access:"private",longname:"loadTech_",scope:"global"},{comment:"/**\n* Unload playback technology\n*\n* @method unloadTech_\n* @private\n*/",meta:{range:[4299,4369],filename:"player.js",lineno:667,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Unload playback technology</p>",kind:"function",name:"unloadTech_",access:"private",longname:"unloadTech_",scope:"global"},{comment:"/**\n* Return a reference to the current tech.\n* It will only return a reference to the tech if given an object with the\n* `IWillNotUseThisInPlugins` property on it. This is try and prevent misuse\n* of techs by plugins.\n*\n* @param {Object}\n* @return {Object} The Tech\n* @method tech\n*/",meta:{range:[4412,4696],filename:"player.js",lineno:687,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Return a reference to the current tech.\nIt will only return a reference to the tech if given an object with the\n<code>IWillNotUseThisInPlugins</code> property on it. This is try and prevent misuse\nof techs by plugins.</p>",params:[{type:{names:["Object"]}}],returns:[{type:{names:["Object"]},description:"<p>The Tech</p>"}],kind:"function",name:"tech",longname:"tech",scope:"global"},{comment:"/**\n* Set up click and touch listeners for the playback element\n*\n* On desktops, a click on the video itself will toggle playback,\n* on a mobile device a click on the video toggles controls.\n* (toggling controls is done by toggling the user state between active and\n* inactive)\n* A tap can signal that a user has become active, or has become inactive\n* e.g. a quick tap on an iPhone movie should reveal the controls. Another\n* quick tap should hide them again (signaling the user is in an inactive\n* viewing state)\n* In addition to this, we still want the user to be considered inactive after\n* a few seconds of inactivity.\n* Note: the only part of iOS interaction we can't mimic with this setup\n* is a touch and hold on the video eleme
|
||
|
|
lineno:1523,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get the ending time of the last buffered time range\nThis is used in the progress bar to encapsulate all time ranges.</p>",returns:[{type:{names:["Number"]},description:"<p>The end of the last buffered time range</p>"}],kind:"function",name:"bufferedEnd",longname:"bufferedEnd",scope:"global"},{comment:"/**\n* Get or set the current volume of the media\n* ```js\n* // get\n* var howLoudIsIt = myPlayer.volume();\n* // set\n* myPlayer.volume(0.5); // Set volume to half\n* ```\n* 0 is off (muted), 1.0 is all the way up, 0.5 is half way.\n*\n* @param {Number} percentAsDecimal The new volume as a decimal percent\n* @return {Number} The current volume when getting\n* @return {Player} self when setting\n* @method volume\n*/",meta:{range:[15058,15507],filename:"player.js",lineno:1542,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:'<p>Get or set the current volume of the media</p>\n<pre class="prettyprint source lang-js"><code> // get\n var howLoudIsIt = myPlayer.volume();\n // set\n myPlayer.volume(0.5); // Set volume to half</code></pre><p>0 is off (muted), 1.0 is all the way up, 0.5 is half way.</p>',params:[{type:{names:["Number"]},description:"<p>The new volume as a decimal percent</p>",name:"percentAsDecimal"}],returns:[{type:{names:["Number"]},description:"<p>The current volume when getting</p>"},{type:{names:["Player"]},description:"<p>self when setting</p>"}],kind:"function",name:"volume",longname:"volume",scope:"global"},{comment:"/**\n* Get the current muted state, or turn mute on or off\n* ```js\n* // get\n* var isVolumeMuted = myPlayer.muted();\n* // set\n* myPlayer.muted(true); // mute the volume\n* ```\n*\n* @param {Boolean=} muted True to mute, false to unmute\n* @return {Boolean} True if mute is on, false if not when getting\n* @return {Player} self when setting mute\n* @method muted\n*/",meta:{range:[15559,15933],filename:"player.js",lineno:1574,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:'<p>Get the current muted state, or turn mute on or off</p>\n<pre class="prettyprint source lang-js"><code> // get\n var isVolumeMuted = myPlayer.muted();\n // set\n myPlayer.muted(true); // mute the volume</code></pre>',params:[{type:{names:["Boolean"]},optional:!0,description:"<p>True to mute, false to unmute</p>",name:"muted"}],returns:[{type:{names:["Boolean"]},description:"<p>True if mute is on, false if not when getting</p>"},{type:{names:["Player"]},description:"<p>self when setting mute</p>"}],kind:"function",name:"muted",longname:"muted",scope:"global"},{comment:"/**\n* Check to see if fullscreen is supported\n*\n* @return {Boolean}\n* @method supportsFullScreen\n*/",meta:{range:[15964,16063],filename:"player.js",lineno:1598,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Check to see if fullscreen is supported</p>",returns:[{type:{names:["Boolean"]}}],kind:"function",name:"supportsFullScreen",longname:"supportsFullScreen",scope:"global"},{comment:"/**\n* Check if the player is in fullscreen mode\n* ```js\n* // get\n* var fullscreenOrNot = myPlayer.isFullscreen();\n* // set\n* myPlayer.isFullscreen(true); // tell the player it's in fullscreen\n* ```\n* NOTE: As of the latest HTML5 spec, isFullscreen is no longer an official\n* property and instead document.fullscreenElement is used. But isFullscreen is\n* still a valuable property for internal player workings.\n*\n* @param {Boolean=} isFS Update the player's fullscreen state\n* @return {Boolean} true if fullscreen false if not when getting\n* @return {Player} self when setting\n* @method isFullscreen\n*/",meta:{range:[16076,16694],filename:"player.js",lineno:1608,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:'<p>Check if the player is in fullscreen mode</p>\n<pre class="prettyprint source lang-js"><code> // get\n var fullscreenOrNot = myPlayer.isFullscreen();\n // set\n myPlayer.isFullscreen(
|
||
|
|
meta:{range:[27469,28509],filename:"player.js",lineno:2529,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Returns a value that expresses the current state of the element\nwith respect to rendering the current playback position, from the\ncodes in the list below.</p>\n<ul>\n<li>HAVE_NOTHING (numeric value 0)\nNo information regarding the media resource is available.</li>\n<li>HAVE_METADATA (numeric value 1)\nEnough of the resource has been obtained that the duration of the\nresource is available.</li>\n<li>HAVE_CURRENT_DATA (numeric value 2)\nData for the immediate current playback position is available.</li>\n<li>HAVE_FUTURE_DATA (numeric value 3)\nData for the immediate current playback position is available, as\nwell as enough data for the user agent to advance the current\nplayback position in the direction of playback.</li>\n<li>HAVE_ENOUGH_DATA (numeric value 4)\nThe user agent estimates that enough data is available for\nplayback to proceed uninterrupted.</li>\n</ul>",see:["https://html.spec.whatwg.org/multipage/embedded-content.html#dom-media-readystate"],returns:[{type:{names:["Number"]},description:"<p>the current playback rendering state</p>"}],kind:"function",name:"readyState",longname:"readyState",scope:"global"},{comment:"/**\n* Get a video track list\n* @link https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist\n*\n* @return {VideoTrackList} thes current video track list\n* @method videoTracks\n*/",meta:{range:[28522,28718],filename:"player.js",lineno:2556,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get a video track list</p>",tags:[{originalTitle:"link",title:"link",text:"https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist",value:"https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist"}],returns:[{type:{names:["VideoTrackList"]},description:"<p>thes current video track list</p>"}],kind:"function",name:"videoTracks",longname:"videoTracks",scope:"global"},{comment:"/**\n* Get an audio track list\n* @link https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist\n*\n* @return {AudioTrackList} thes current audio track list\n* @method audioTracks\n*/",meta:{range:[28752,28949],filename:"player.js",lineno:2574,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get an audio track list</p>",tags:[{originalTitle:"link",title:"link",text:"https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist",value:"https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist"}],returns:[{type:{names:["AudioTrackList"]},description:"<p>thes current audio track list</p>"}],kind:"function",name:"audioTracks",longname:"audioTracks",scope:"global"},{comment:"/**\n* Get an array of associated text tracks. captions, subtitles, chapters, descriptions\n* http://www.w3.org/html/wg/drafts/html/master/embedded-content-0.html#dom-media-texttracks\n*\n* @return {Array} Array of track objects\n* @method textTracks\n*/",meta:{range:[29427,29685],filename:"player.js",lineno:2600,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get an array of associated text tracks. captions, subtitles, chapters, descriptions\nhttp://www.w3.org/html/wg/drafts/html/master/embedded-content-0.html#dom-media-texttracks</p>",returns:[{type:{names:["Array"]},description:"<p>Array of track objects</p>"}],kind:"function",name:"textTracks",longname:"textTracks",scope:"global"},{comment:"/**\n* Get an array of remote text tracks\n*\n* @return {Array}\n* @method remoteTextTracks\n*/",meta:{range:[29704,29794],filename:"player.js",lineno:2613,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Get an array of remote text tracks</p>",returns:[{type:{names:["Array"]}}],kind:"function",name:"remoteTextTracks",longname:"remoteTextTracks",scope:"global"},{comment:"/**\n* Get an array of remote html track elements\n*\n* @return {HTMLTrackElement[]}\n* @method remoteTextTrackEls\n*/",meta:{range:[29807,29920],filename:"player.js",lineno:2623,
|
||
|
|
params:[{type:{names:["Number"]},optional:!0,description:"<p>Current time of video</p>",name:"time"}],returns:[{type:{names:["Number"]},description:"<p>Current time</p>"}],kind:"function",name:"currentTime",longname:"currentTime",scope:"global"},{comment:"/**\n* Get current source\n*\n* @method currentSrc\n*/",meta:{range:[1556,1606],filename:"flash.js",lineno:219,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Get current source</p>",kind:"function",name:"currentSrc",longname:"currentSrc",scope:"global"},{comment:"/**\n* Load media into player\n*\n* @method load\n*/",meta:{range:[1723,1771],filename:"flash.js",lineno:246,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Load media into player</p>",kind:"function",name:"load",longname:"load",scope:"global"},{comment:"/**\n* Get poster\n*\n* @method poster\n*/",meta:{range:[1784,1822],filename:"flash.js",lineno:255,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Get poster</p>",kind:"function",name:"poster",longname:"poster",scope:"global"},{comment:"/**\n* Poster images are not handled by the Flash tech so make this a no-op\n*\n* @method setPoster\n*/",meta:{range:[1835,1934],filename:"flash.js",lineno:264,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Poster images are not handled by the Flash tech so make this a no-op</p>",kind:"function",name:"setPoster",longname:"setPoster",scope:"global"},{comment:"/**\n* Determine if can seek in media\n*\n* @return {TimeRangeObject}\n* @method seekable\n*/",meta:{range:[1941,2029],filename:"flash.js",lineno:271,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Determine if can seek in media</p>",returns:[{type:{names:["TimeRangeObject"]}}],kind:"function",name:"seekable",longname:"seekable",scope:"global"},{comment:"/**\n* Get buffered time range\n*\n* @return {TimeRangeObject}\n* @method buffered\n*/",meta:{range:[2054,2135],filename:"flash.js",lineno:285,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Get buffered time range</p>",returns:[{type:{names:["TimeRangeObject"]}}],kind:"function",name:"buffered",longname:"buffered",scope:"global"},{comment:"/**\n* Get fullscreen support -\n* Flash does not allow fullscreen through javascript\n* so always returns false\n*\n* @return {Boolean} false\n* @method supportsFullScreen\n*/",meta:{range:[2160,2329],filename:"flash.js",lineno:299,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Get fullscreen support -\nFlash does not allow fullscreen through javascript\nso always returns false</p>",returns:[{type:{names:["Boolean"]},description:"<p>false</p>"}],kind:"function",name:"supportsFullScreen",longname:"supportsFullScreen",scope:"global"},{comment:"/**\n* Request to enter fullscreen\n* Flash does not allow fullscreen through javascript\n* so always returns false\n*\n* @return {Boolean} false\n* @method enterFullScreen\n*/",meta:{range:[2342,2511],filename:"flash.js",lineno:311,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Request to enter fullscreen\nFlash does not allow fullscreen through javascript\nso always returns false</p>",returns:[{type:{names:["Boolean"]},description:"<p>false</p>"}],kind:"function",name:"enterFullScreen",longname:"enterFullScreen",scope:"global"},{comment:"/**\n* @file html5.js\n* HTML5 Media Controller - Wrapper for HTML5 Media API\n*/",meta:{range:[0,78],filename:"html5.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},name:"tech/html5.js",kind:"file",description:"<p>html5.js\nHTML5 Media Controller - Wrapper for HTML5 Media API</p>",preserveName:!0,longname:"tech/html5.js",scope:"global"},{comment:"/**\n* HTML5 Media Controller - Wrapper for HTML5 Media API\n*\n* @param {Object=} options Object of option names and values\n* @param {Function=} ready Ready callback function\n* @extends Tech\n* @class Html5\n*/",meta:{range:[127,333],filename:"html5.js",lineno:21,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{
|
||
|
|
kind:"function",name:"clearTracks",params:[{type:{names:["Array","String"]},description:"<p>type(s) of track lists to empty</p>",name:"types"}],longname:"clearTracks",scope:"global"},{comment:"/**\n* Reset the tech. Removes all sources and resets readyState.\n*\n* @method reset\n*/",meta:{range:[2382,2467],filename:"tech.js",lineno:267,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Reset the tech. Removes all sources and resets readyState.</p>",kind:"function",name:"reset",longname:"reset",scope:"global"},{comment:"/**\n* When invoked without an argument, returns a MediaError object\n* representing the current error state of the player or null if\n* there is no error. When invoked with an argument, set the current\n* error state of the player.\n* @param {MediaError=} err Optional an error object\n* @return {MediaError} the current error object or null\n* @method error\n*/",meta:{range:[2474,2839],filename:"tech.js",lineno:274,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>When invoked without an argument, returns a MediaError object\nrepresenting the current error state of the player or null if\nthere is no error. When invoked with an argument, set the current\nerror state of the player.</p>",params:[{type:{names:["MediaError"]},optional:!0,description:"<p>Optional an error object</p>",name:"err"}],returns:[{type:{names:["MediaError"]},description:"<p>the current error object or null</p>"}],kind:"function",name:"error",longname:"error",scope:"global"},{comment:"/**\n* Return the time ranges that have been played through for the\n* current source. This implementation is incomplete. It does not\n* track the played time ranges, only whether the source has played\n* at all or not.\n* @return {TimeRangeObject} a single time range if this video has\n* played or an empty set of ranges if not.\n* @method played\n*/",meta:{range:[2864,3208],filename:"tech.js",lineno:291,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Return the time ranges that have been played through for the\ncurrent source. This implementation is incomplete. It does not\ntrack the played time ranges, only whether the source has played\nat all or not.</p>",returns:[{type:{names:["TimeRangeObject"]},description:"<p>a single time range if this video has\nplayed or an empty set of ranges if not.</p>"}],kind:"function",name:"played",longname:"played",scope:"global"},{comment:"/**\n* Set current time\n*\n* @method setCurrentTime\n*/",meta:{range:[3230,3282],filename:"tech.js",lineno:307,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Set current time</p>",kind:"function",name:"setCurrentTime",longname:"setCurrentTime",scope:"global"},{comment:"/**\n* Initialize texttrack listeners\n*\n* @method initTextTrackListeners\n*/",meta:{range:[3298,3372],filename:"tech.js",lineno:317,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Initialize texttrack listeners</p>",kind:"function",name:"initTextTrackListeners",longname:"initTextTrackListeners",scope:"global"},{comment:"/**\n* Initialize audio and video track listeners\n*\n* @method initTrackListeners\n*/",meta:{range:[3430,3512],filename:"tech.js",lineno:341,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Initialize audio and video track listeners</p>",kind:"function",name:"initTrackListeners",longname:"initTrackListeners",scope:"global"},{comment:"/**\n* Emulate texttracks\n*\n* @method emulateTextTracks\n*/",meta:{range:[3573,3630],filename:"tech.js",lineno:366,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Emulate texttracks</p>",kind:"function",name:"emulateTextTracks",longname:"emulateTextTracks",scope:"global"},{comment:"/**\n* Get videotracks\n*\n* @returns {VideoTrackList}\n* @method videoTracks\n*/",meta:{range:[3769,3845],filename:"tech.js",lineno:417,path:"/Users/mboles/git/docs/video.js/src/js/tech",code:{}},description:"<p>Get videotracks</p>",returns:[{type:{names:["VideoTrackList"]}}],kind:"function",na
|
||
|
|
code:{}},description:"<p>Restore texttrack settings</p>",kind:"function",name:"restoreSettings",longname:"restoreSettings",scope:"global"},{comment:"/**\n* Save texttrack settings to local storage\n*\n* @method saveSettings\n*/",meta:{range:[1290,1364],filename:"text-track-settings.js",lineno:187,path:"/Users/mboles/git/docs/video.js/src/js/tracks",code:{}},description:"<p>Save texttrack settings to local storage</p>",kind:"function",name:"saveSettings",longname:"saveSettings",scope:"global"},{comment:"/**\n* Update display of texttrack settings\n*\n* @method updateDisplay\n*/",meta:{range:[1416,1487],filename:"text-track-settings.js",lineno:209,path:"/Users/mboles/git/docs/video.js/src/js/tracks",code:{}},description:"<p>Update display of texttrack settings</p>",kind:"function",name:"updateDisplay",longname:"updateDisplay",scope:"global"},{comment:"/**\n* @file text-track.js\n*/",meta:{range:[0,28],filename:"text-track.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/tracks",code:{}},name:"tracks/text-track.js",kind:"file",description:"<p>text-track.js</p>",preserveName:!0,longname:"tracks/text-track.js",scope:"global"},{comment:"/**\n* A single text track as defined in:\n* @link https://html.spec.whatwg.org/multipage/embedded-content.html#texttrack\n*\n* interface TextTrack : EventTarget {\n* readonly attribute TextTrackKind kind;\n* readonly attribute DOMString label;\n* readonly attribute DOMString language;\n*\n* readonly attribute DOMString id;\n* readonly attribute DOMString inBandMetadataTrackDispatchType;\n*\n* attribute TextTrackMode mode;\n*\n* readonly attribute TextTrackCueList? cues;\n* readonly attribute TextTrackCueList? activeCues;\n*\n* void addCue(TextTrackCue cue);\n* void removeCue(TextTrackCue cue);\n*\n* attribute EventHandler oncuechange;\n* };\n*\n* @param {Object=} options Object of option names and values\n* @extends Track\n* @class TextTrack\n*/",meta:{range:[568,1320],filename:"text-track.js",lineno:99,path:"/Users/mboles/git/docs/video.js/src/js/tracks",code:{}},description:"<p>A single text track as defined in:</p>",tags:[{originalTitle:"link",title:"link",text:"https://html.spec.whatwg.org/multipage/embedded-content.html#texttrack\n\ninterface TextTrack : EventTarget {\n readonly attribute TextTrackKind kind;\n readonly attribute DOMString label;\n readonly attribute DOMString language;\n\n readonly attribute DOMString id;\n readonly attribute DOMString inBandMetadataTrackDispatchType;\n\n attribute TextTrackMode mode;\n\n readonly attribute TextTrackCueList? cues;\n readonly attribute TextTrackCueList? activeCues;\n\n void addCue(TextTrackCue cue);\n void removeCue(TextTrackCue cue);\n\n attribute EventHandler oncuechange;\n};",value:"https://html.spec.whatwg.org/multipage/embedded-content.html#texttrack\n\ninterface TextTrack : EventTarget {\n readonly attribute TextTrackKind kind;\n readonly attribute DOMString label;\n readonly attribute DOMString language;\n\n readonly attribute DOMString id;\n readonly attribute DOMString inBandMetadataTrackDispatchType;\n\n attribute TextTrackMode mode;\n\n readonly attribute TextTrackCueList? cues;\n readonly attribute TextTrackCueList? activeCues;\n\n void addCue(TextTrackCue cue);\n void removeCue(TextTrackCue cue);\n\n attribute EventHandler oncuechange;\n};"}],params:[{type:{names:["Object"]},optional:!0,description:"<p>Object of option names and values</p>",name:"options"}],augments:["Track"],kind:"class",name:"TextTrack",longname:"TextTrack",scope:"global"},{comment:"/**\n* add a cue to the internal list of cues\n*\n* @param {Object} cue the cue to add to our internal list\n* @method addCue\n*/",meta:{range:[1732,1856],filename:"text-track.js",lineno:263,path:"/Users/mboles/git/docs/video.js/src/js/tracks",code:{}},description:"<p>add a cue to the internal list of cues</p>",params:[{type:{names:["Object"]},description:"<p>the cue to add to our internal list</p>",name:"cue"}],kind:"function",name:"addCue",longname:"addCue",scope:"global"},{comment:"/**\n* remvoe a cue from our internal list
|
||
|
|
meta:{range:[7591,8181],filename:"dom.js",lineno:614,path:"/Users/mboles/git/docs/video.js/src/js/utils",code:{}},description:"<p>Finds a single DOM element matching <code>selector</code> within the optional\n<code>context</code> of another DOM element (defaulting to <code>document</code>).</p>",kind:"function",name:"$",params:[{type:{names:["String"]},description:"<p>A valid CSS selector, which will be passed to <code>querySelector</code>.</p>",name:"selector"},{type:{names:["Element","String"]},optional:!0,defaultvalue:"document",description:"<p>A DOM element within which to query. Can also be a selector\n string in which case the first matching element will be used\n as context. If missing (or no element matches selector), falls\n back to <code>document</code>.</p>",name:"context"}],returns:[{type:{names:["Element","null"]}}],longname:"$",scope:"global"},{comment:"/**\n* Finds a all DOM elements matching `selector` within the optional\n* `context` of another DOM element (defaulting to `document`).\n*\n* @function $$\n* @param {String} selector\n* A valid CSS selector, which will be passed to `querySelectorAll`.\n*\n* @param {Element|String} [context=document]\n* A DOM element within which to query. Can also be a selector\n* string in which case the first matching element will be used\n* as context. If missing (or no element matches selector), falls\n* back to `document`.\n*\n* @return {NodeList}\n*/",meta:{range:[8188,8776],filename:"dom.js",lineno:632,path:"/Users/mboles/git/docs/video.js/src/js/utils",code:{}},description:"<p>Finds a all DOM elements matching <code>selector</code> within the optional\n<code>context</code> of another DOM element (defaulting to <code>document</code>).</p>",kind:"function",name:"$$",params:[{type:{names:["String"]},description:"<p>A valid CSS selector, which will be passed to <code>querySelectorAll</code>.</p>",name:"selector"},{type:{names:["Element","String"]},optional:!0,defaultvalue:"document",description:"<p>A DOM element within which to query. Can also be a selector\n string in which case the first matching element will be used\n as context. If missing (or no element matches selector), falls\n back to <code>document</code>.</p>",name:"context"}],returns:[{type:{names:["NodeList"]}}],longname:"$$",scope:"global"},{comment:"/**\n* @file events.js\n*\n* Event System (John Resig - Secrets of a JS Ninja http://jsninja.com/)\n* (Original book version wasn't completely usable, so fixed some things and made Closure Compiler compatible)\n* This should work very similarly to jQuery's events, however it's based off the book version which isn't as\n* robust as jquery's, so there's probably some differences.\n*/",meta:{range:[0,377],filename:"events.js",lineno:1,path:"/Users/mboles/git/docs/video.js/src/js/utils",code:{}},name:"utils/events.js",kind:"file",description:"<p>events.js</p>\n<p>Event System (John Resig - Secrets of a JS Ninja http://jsninja.com/)\n(Original book version wasn't completely usable, so fixed some things and made Closure Compiler compatible)\nThis should work very similarly to jQuery's events, however it's based off the book version which isn't as\nrobust as jquery's, so there's probably some differences.</p>",preserveName:!0,longname:"utils/events.js",scope:"global"},{comment:"/**\n* Add an event listener to element\n* It stores the handler function in a separate cache object\n* and adds a generic handler to the element's event,\n* along with a unique id (guid) to the element.\n*\n* @param {Element|Object} elem Element or object to bind listeners to\n* @param {String|Array} type Type of event to bind to.\n* @param {Function} fn Event listener.\n* @method on\n*/",meta:{range:[399,789],filename:"events.js",lineno:16,path:"/Users/mboles/git/docs/video.js/src/js/utils",code:{}},description:"<p>Add an event listener to element\nIt stores the handler function in a separate cache object\nand adds a generic handler to the element's event,\nalong with a uni
|
||
|
|
params:[{type:{names:["Object"]},description:"<p>The options object whose values will be overriden</p>",name:"defaults"},{type:{names:["Object"]},description:"<p>The options object with values to override the first</p>",name:"overrides"},{type:{names:["Object"]},description:"<p>Any number of additional options objects</p>",name:"etc"}],returns:[{type:{names:["Object"]},description:"<p>a new object with the merged values</p>"}],mixes:["videojs"],kind:"function",name:"mergeOptions",longname:"mergeOptions",scope:"global"},{comment:"/**\n* Create a Video.js player plugin\n* Plugins are only initialized when options for the plugin are included\n* in the player options, or the plugin function on the player instance is\n* called.\n* **See the plugin guide in the docs for a more detailed example**\n* ```js\n* // Make a plugin that alerts when the player plays\n* videojs.plugin('myPlugin', function(myPluginOptions) {\n* myPluginOptions = myPluginOptions || {};\n*\n* var player = this;\n* var alertText = myPluginOptions.text || 'Player is playing!'\n*\n* player.on('play', function(){\n* alert(alertText);\n* });\n* });\n* // USAGE EXAMPLES\n* // EXAMPLE 1: New player with plugin options, call plugin immediately\n* var player1 = videojs('idOne', {\n* myPlugin: {\n* text: 'Custom text!'\n* }\n* });\n* // Click play\n* // --> Should alert 'Custom text!'\n* // EXAMPLE 3: New player, initialize plugin later\n* var player3 = videojs('idThree');\n* // Click play\n* // --> NO ALERT\n* // Click pause\n* // Initialize plugin using the plugin function on the player instance\n* player3.myPlugin({\n* text: 'Plugin added later!'\n* });\n* // Click play\n* // --> Should alert 'Plugin added later!'\n* ```\n*\n* @param {String} name The plugin name\n* @param {Function} fn The plugin function that will be called with options\n* @mixes videojs\n* @method plugin\n*/",meta:{range:[6472,7900],filename:"video.js",lineno:354,path:"/Users/mboles/git/docs/video.js/src/js",code:{}},description:"<p>Create a Video.js player plugin\nPlugins are only initialized when options for the plugin are included\nin the player options, or the plugin function on the player instance is\ncalled.\n<strong>See the plugin guide in the docs for a more detailed example</strong></p>\n<pre class=\"prettyprint source lang-js\"><code> // Make a plugin that alerts when the player plays\n videojs.plugin('myPlugin', function(myPluginOptions) {\n myPluginOptions = myPluginOptions || {};\n\n var player = this;\n var alertText = myPluginOptions.text || 'Player is playing!'\n\n player.on('play', function(){\n alert(alertText);\n });\n });\n // USAGE EXAMPLES\n // EXAMPLE 1: New player with plugin options, call plugin immediately\n var player1 = videojs('idOne', {\n myPlugin: {\n text: 'Custom text!'\n }\n });\n // Click play\n // --> Should alert 'Custom text!'\n // EXAMPLE 3: New player, initialize plugin later\n var player3 = videojs('idThree');\n // Click play\n // --> NO ALERT\n // Click pause\n // Initialize plugin using the plugin function on the player instance\n player3.myPlugin({\n text: 'Plugin added later!'\n });\n // Click play\n // --> Should alert 'Plugin added later!'</code></pre>",params:[{type:{names:["String"]},description:"<p>The plugin name</p>",name:"name"},{type:{names:["function"]},description:"<p>The plugin function that will be called with options</p>",name:"fn"}],mixes:["videojs"],kind:"function",name:"plugin",longname:"plugin",scope:"global"},{comment:"/**\n* Adding languages so that they're available to all players.\n* ```js\n* videojs.addLanguage('es', { 'Hello': 'Hola' });\n* ```\n*\n* @param {String} code The language code or dictionary property\n* @param {Object} data The data values to be translated\n* @return {Object} The resulting language dictionary object\n* @mixes videojs\n* @method addLanguage\n*/",
|