web/video.js
1
0
Fork 0
mirror of https://github.com/videojs/video.js.git synced 2024-12-27 02:43:45 +02:00
Code Releases Activity

Updated docs with recent changes

Browse Source
This commit is contained in:
Steve Heffernan 2013-11-05 17:12:20 -08:00
parent b6c902a7b3
commit 9662736766
46 changed files with 1313 additions and 998 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/api/vjs.BigPlayButton.md
View File

@ -65,14 +65,14 @@ big play button is done via CSS and player states.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -249,7 +254,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -379,10 +384,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -477,18 +482,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -497,7 +504,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.Button.md
View File

@ -64,14 +64,14 @@ Base class for all buttons
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -248,7 +253,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -378,10 +383,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -476,18 +481,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -496,7 +503,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.CaptionsButton.md
View File

@ -65,14 +65,14 @@ The button component for toggling and selecting captions
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -480,18 +485,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -500,7 +507,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

49
docs/api/vjs.CaptionsTrack.md
View File

@ -94,14 +94,14 @@ _inherited from_: [src/js/tracks.js#L264](https://github.com/videojs/video.js/bl
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -215,7 +215,7 @@ _inherited from_: [src/js/tracks.js#L190](https://github.com/videojs/video.js/bl
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -248,7 +248,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -275,16 +275,21 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
@ -479,10 +484,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -611,18 +616,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -631,7 +638,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.ChaptersButton.md
View File

@ -65,14 +65,14 @@ The button component for toggling and selecting chapters
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -480,18 +485,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -500,7 +507,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

49
docs/api/vjs.ChaptersTrack.md
View File

@ -94,14 +94,14 @@ _inherited from_: [src/js/tracks.js#L264](https://github.com/videojs/video.js/bl
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -215,7 +215,7 @@ _inherited from_: [src/js/tracks.js#L190](https://github.com/videojs/video.js/bl
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -248,7 +248,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -275,16 +275,21 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
@ -479,10 +484,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -611,18 +616,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -631,7 +638,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.ChaptersTrackMenuItem.md
View File

@ -64,14 +64,14 @@ __DEFINED IN__: [src/js/tracks.js#L987](https://github.com/videojs/video.js/blob
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -151,7 +151,7 @@ _inherited from_: [src/js/menu.js#L64](https://github.com/videojs/video.js/blob/
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -182,7 +182,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -209,21 +209,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -380,10 +385,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -488,18 +493,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -508,7 +515,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.Component.md
View File

@ -84,14 +84,14 @@ Components are also event emitters.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -174,7 +174,7 @@ _defined in_: [src/js/component.js#L190](https://github.com/videojs/video.js/blo
##### RETURNS:
* `vjs.Component` The component
_defined in_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_defined in_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -205,7 +205,7 @@ _defined in_: [src/js/component.js#L201](https://github.com/videojs/video.js/blo
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -232,21 +232,26 @@ _defined in_: [src/js/component.js#L294](https://github.com/videojs/video.js/blo
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_defined in_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_defined in_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -268,7 +273,7 @@ _defined in_: [src/js/component.js#L239](https://github.com/videojs/video.js/blo
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -398,10 +403,10 @@ _defined in_: [src/js/component.js#L522](https://github.com/videojs/video.js/blo
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_defined in_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -496,18 +501,20 @@ _defined in_: [src/js/component.js#L600](https://github.com/videojs/video.js/blo
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_defined in_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_defined in_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -516,7 +523,7 @@ _defined in_: [src/js/component.js#L707](https://github.com/videojs/video.js/blo
### resize `EVENT`
> Fired when the width and/or height of the component changes
_defined in_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_defined in_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.ControlBar.md
View File

@ -64,14 +64,14 @@ Container of main controls
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -248,7 +253,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -378,10 +383,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -476,18 +481,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -496,7 +503,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.CurrentTimeDisplay.md
View File

@ -64,14 +64,14 @@ Displays the current time
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.DurationDisplay.md
View File

@ -64,14 +64,14 @@ Displays the duration
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.Flash.md
View File

@ -67,14 +67,14 @@ Flash Media Controller - Wrapper for fallback SWF API
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -157,7 +157,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -188,7 +188,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -215,21 +215,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -414,10 +419,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -520,18 +525,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -540,7 +547,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.FullscreenToggle.md
View File

@ -64,14 +64,14 @@ Toggle fullscreen video
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.Html5.md
View File

@ -67,14 +67,14 @@ HTML5 Media Controller - Wrapper for HTML5 Media API
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -157,7 +157,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -188,7 +188,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -215,21 +215,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -414,10 +419,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -520,18 +525,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -540,7 +547,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

8
docs/api/vjs.JSON.md
View File

@ -14,17 +14,17 @@
## METHODS
### parse( text, reviver )
### parse( text, [reviver] )
> parse the json
##### PARAMETERS:
* __text__
* __reviver__
* __text__ `String` The JSON string to parse
* __reviver__ `Function` _(OPTIONAL)_ Optional function that can transform the results
##### RETURNS:
* `Object|Array` The parsed JSON
_defined in_: [src/js/json.js#L32](https://github.com/videojs/video.js/blob/master/src/js/json.js#L32)
_defined in_: [src/js/json.js#L34](https://github.com/videojs/video.js/blob/master/src/js/json.js#L34)
---

51
docs/api/vjs.LoadProgressBar.md
View File

@ -64,14 +64,14 @@ Shows load progress
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.LoadingSpinner.md
View File

@ -64,14 +64,14 @@ Loading spinner for waiting events
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.MediaLoader.md
View File

@ -65,14 +65,14 @@ when the player is initialized.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -378,10 +383,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -476,18 +481,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -496,7 +503,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.MediaTechController.md
View File

@ -67,14 +67,14 @@ Base class for media (HTML5 Video, Flash) controllers
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -157,7 +157,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -188,7 +188,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -215,21 +215,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -414,10 +419,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -520,18 +525,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -540,7 +547,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.Menu.md
View File

@ -66,14 +66,14 @@ captions selection menus.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -163,7 +163,7 @@ _defined in_: [src/js/menu.js#L26](https://github.com/videojs/video.js/blob/mast
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -194,7 +194,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -221,21 +221,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -257,7 +262,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -387,10 +392,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -485,18 +490,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -505,7 +512,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.MenuButton.md
View File

@ -65,14 +65,14 @@ A button class with a popup menu
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _defined in_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob/mas
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -381,10 +386,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -479,18 +484,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -499,7 +506,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.MenuItem.md
View File

@ -66,14 +66,14 @@ The component for a menu item. `<li>`
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -153,7 +153,7 @@ _defined in_: [src/js/menu.js#L64](https://github.com/videojs/video.js/blob/mast
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -184,7 +184,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -211,21 +211,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -490,18 +495,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -510,7 +517,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.MuteToggle.md
View File

@ -64,14 +64,14 @@ A button component for muting the audio
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.OffTextTrackMenuItem.md
View File

@ -66,14 +66,14 @@ A special menu item for turning of a specific type of text track
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -153,7 +153,7 @@ _inherited from_: [src/js/menu.js#L64](https://github.com/videojs/video.js/blob/
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -184,7 +184,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -211,21 +211,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -490,18 +495,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -510,7 +517,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.PlayProgressBar.md
View File

@ -64,14 +64,14 @@ Shows play progress
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.PlayToggle.md
View File

@ -64,14 +64,14 @@ Button to toggle between play and pause
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.Player.md
View File

@ -106,14 +106,14 @@ After an instance has been created it can be accessed globally using `Video('exa
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -281,7 +281,7 @@ _defined in_: [src/js/player.js#L641](https://github.com/videojs/video.js/blob/m
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -336,7 +336,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -363,21 +363,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -549,10 +554,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -785,18 +790,20 @@ _defined in_: [src/js/player.js#L762](https://github.com/videojs/video.js/blob/m
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -896,7 +903,7 @@ _defined in_: [src/js/player.js#L476](https://github.com/videojs/video.js/blob/m
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.PosterImage.md
View File

@ -64,14 +64,14 @@ The component that handles showing the poster image.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.ProgressControl.md
View File

@ -65,14 +65,14 @@ and play progress
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -377,10 +382,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -475,18 +480,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -495,7 +502,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.RemainingTimeDisplay.md
View File

@ -64,14 +64,14 @@ Displays the time left in the video
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.SeekBar.md
View File

@ -65,14 +65,14 @@ Seek Bar and holder for the progress bars
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -388,10 +393,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -486,18 +491,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -506,7 +513,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.SeekHandle.md
View File

@ -65,14 +65,14 @@ and can be dragged to adjust the playhead.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -152,7 +152,7 @@ _defined in_: [src/js/control-bar/progress-control.js#L196](https://github.com/v
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -183,7 +183,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -210,21 +210,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -246,7 +251,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.Slider.md
View File

@ -65,14 +65,14 @@ The base functionality for sliders like the volume bar and seek bar
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -388,10 +393,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -486,18 +491,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -506,7 +513,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.SliderHandle.md
View File

@ -65,14 +65,14 @@ Needed so it can determine seek position based on handle position/size
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -152,7 +152,7 @@ _defined in_: [src/js/slider.js#L223](https://github.com/videojs/video.js/blob/m
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -183,7 +183,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -210,21 +210,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -246,7 +251,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.SubtitlesButton.md
View File

@ -65,14 +65,14 @@ The button component for toggling and selecting subtitles
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -480,18 +485,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -500,7 +507,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

49
docs/api/vjs.SubtitlesTrack.md
View File

@ -94,14 +94,14 @@ _inherited from_: [src/js/tracks.js#L264](https://github.com/videojs/video.js/bl
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -215,7 +215,7 @@ _inherited from_: [src/js/tracks.js#L190](https://github.com/videojs/video.js/bl
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -248,7 +248,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -275,16 +275,21 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
@ -479,10 +484,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -611,18 +616,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -631,7 +638,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

49
docs/api/vjs.TextTrack.md
View File

@ -96,14 +96,14 @@ _defined in_: [src/js/tracks.js#L264](https://github.com/videojs/video.js/blob/m
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -217,7 +217,7 @@ _defined in_: [src/js/tracks.js#L190](https://github.com/videojs/video.js/blob/m
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -250,7 +250,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -277,16 +277,21 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
@ -481,10 +486,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -613,18 +618,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -633,7 +640,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.TextTrackButton.md
View File

@ -65,14 +65,14 @@ The base class for buttons that toggle specific text track types (e.g. subtitles
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -381,10 +386,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -479,18 +484,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -499,7 +506,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.TextTrackDisplay.md
View File

@ -64,14 +64,14 @@ The component for displaying text track cues
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -377,10 +382,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -475,18 +480,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -495,7 +502,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.TextTrackMenuItem.md
View File

@ -66,14 +66,14 @@ The specific menu item type for selecting a language within a text track kind
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -153,7 +153,7 @@ _inherited from_: [src/js/menu.js#L64](https://github.com/videojs/video.js/blob/
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -184,7 +184,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -211,21 +211,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -490,18 +495,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -510,7 +517,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.TimeDivider.md
View File

@ -66,14 +66,14 @@ Can be hidden if it's not needed in the design.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -156,7 +156,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -187,7 +187,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -214,21 +214,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -378,10 +383,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -476,18 +481,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -496,7 +503,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.VolumeBar.md
View File

@ -65,14 +65,14 @@ The bar that contains the volume level and can be clicked on to adjust the level
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -388,10 +393,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -486,18 +491,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -506,7 +513,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.VolumeControl.md
View File

@ -64,14 +64,14 @@ The component for controlling the volume level
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

53
docs/api/vjs.VolumeHandle.md
View File

@ -64,14 +64,14 @@ The volume handle can be dragged to adjust the volume level
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -151,7 +151,7 @@ _defined in_: [src/js/control-bar/volume-control.js#L137](https://github.com/vid
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -182,7 +182,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -209,21 +209,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -245,7 +250,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---
### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
@ -375,10 +380,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -473,18 +478,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -493,7 +500,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.VolumeLevel.md
View File

@ -64,14 +64,14 @@ Shows volume level
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -376,10 +381,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -474,18 +479,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -494,7 +501,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---

51
docs/api/vjs.VolumeMenuButton.md
View File

@ -65,14 +65,14 @@ Menu button with a popup for showing the volume slider.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component
_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)
---
@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---
### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js
### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger
##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting
_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)
---
### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
@ -381,10 +386,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values
##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged
_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)
@ -479,18 +484,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger
##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting
_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)
---
@ -499,7 +506,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)
---