37 KiB
vjs.Player
EXTENDS: vjs.Component
DEFINED IN: src/js/player.js#L21
An instance of the vjs.Player
class is created when any of the Video.js setup methods are used to initialize a video.
var myPlayer = videojs('example_video_1');
In the following example, the data-setup
attribute tells the Video.js library to create a player instance when the library is ready.
<video id="example_video_1" data-setup='{}' controls>
<source src="my-source.mp4" type="video/mp4">
</video>
After an instance has been created it can be accessed globally using Video('example_video_1')
.
INDEX
-
- autoplay
- buffered
- bufferedEnd
- bufferedPercent
- cancelFullScreen
deprecated
- controls
- currentSrc
- currentTime
- currentType
- dispose
- duration
- ended
- error
- exitFullscreen
- init
- isFullScreen
deprecated
- isFullscreen
- language
- load
- loop
- muted
- pause
- paused
- play
- playbackRate
- poster
- preload
- remainingTime
- requestFullScreen
deprecated
- requestFullscreen
- seeking
- src
- volume
- addChild
inherited
- addClass
inherited
- buildCSSClass
inherited
- children
inherited
- clearInterval
inherited
- clearTimeout
inherited
- contentEl
inherited
- createEl
inherited
- dimensions
inherited
- el
inherited
- enableTouchActivity
inherited
- getChild
inherited
- getChildById
inherited
- hasClass
inherited
- height
inherited
- hide
inherited
- id
inherited
- initChildren
inherited
- name
inherited
- off
inherited
- on
inherited
- one
inherited
- options
inherited
- player
inherited
- ready
inherited
- removeChild
inherited
- removeClass
inherited
- setInterval
inherited
- setTimeout
inherited
- show
inherited
- trigger
inherited
- triggerReady
inherited
- width
inherited
METHODS
addChild( child, [options] )
Adds a child component inside this component
myComponent.el(); // -> <div class='my-component'></div> myComonent.children(); // [empty array] var myButton = myComponent.addChild('MyButton'); // -> <div class='my-component'><div class="my-button">myButton<div></div> // -> myButton === myComonent.children()[0];
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 } } });
PARAMETERS:
- child
String|vjs.Component
The class name or instance of a child to add - options
Object
(OPTIONAL) Options, including options to be passed to children of the child.
RETURNS:
vjs.Component
The child component (created by this process if a string was used)
inherited from: src/js/component.js#L362
addClass( classToAdd )
Add a CSS class name to the component's element
PARAMETERS:
- classToAdd
String
Classname to add
RETURNS:
vjs.Component
inherited from: src/js/component.js#L826
autoplay( value )
Get or set the autoplay attribute.
PARAMETERS:
- value
RETURNS:
String
The autoplay attribute value when gettingvjs.Player
Returns the player when setting
defined in: src/js/player.js#L1273
buffered()
Get a TimeRange object with the times of the video that have been downloaded
If you just want the percent of the video that's been downloaded, use bufferedPercent.
// Number of different ranges of time have been buffered. Usually 1. numberOfRanges = bufferedTimeRange.length, // Time in seconds when the first range starts. Usually 0. firstRangeStart = bufferedTimeRange.start(0), // Time in seconds when the first range ends firstRangeEnd = bufferedTimeRange.end(0), // Length in seconds of the first time range firstRangeLength = firstRangeEnd - firstRangeStart;
RETURNS:
Object
A mock TimeRange object (following HTML spec)
defined in: src/js/player.js#L782
bufferedEnd()
Get the ending time of the last buffered time range
This is used in the progress bar to encapsulate all time ranges.
RETURNS:
Number
The end of the last buffered time range
defined in: src/js/player.js#L833
bufferedPercent()
Get the percent (as a decimal) of the video that's been downloaded
var howMuchIsDownloaded = myPlayer.bufferedPercent();
0 means none, 1 means all. (This method isn't in the HTML5 spec, but it's very convenient)
RETURNS:
Number
A decimal between 0 and 1 representing the percent
defined in: src/js/player.js#L802
buildCSSClass()
Allows sub components to stack CSS class names
RETURNS:
String
The constructed class name
inherited from: src/js/component.js#L536
cancelFullScreen()
Old naming for exitFullscreen Deprecated true
defined in: src/js/player.js#L1038
children()
Get an array of all child components
var kids = myComponent.children();
RETURNS:
Array
The children
inherited from: src/js/component.js#L296
clearInterval( intervalId )
Clears an interval and removes the associated dispose listener
PARAMETERS:
- intervalId
Number
The id of the interval to clear
RETURNS:
Number
Returns the interval ID
inherited from: src/js/component.js#L1219
clearTimeout( timeoutId )
Clears a timeout and removes the associated dispose listener
PARAMETERS:
- timeoutId
Number
The id of the timeout to clear
RETURNS:
Number
Returns the timeout ID
inherited from: src/js/component.js#L1181
contentEl()
Return the component's DOM element for embedding content. Will either be el_ or a new element defined in createEl.
RETURNS:
Element
inherited from: src/js/component.js#L239
controls( controls )
Get or set whether or not the controls are showing.
PARAMETERS:
- controls
Boolean
Set controls to showing or not
RETURNS:
Boolean
Controls are showing
defined in: src/js/player.js#L1353
createEl( [tagName], [attributes] )
Create the component's DOM element
PARAMETERS:
- tagName
String
(OPTIONAL) Element's node type. e.g. 'div' - attributes
Object
(OPTIONAL) An object of element attributes that should be set on the element
RETURNS:
Element
inherited from: src/js/component.js#L200
currentSrc()
Returns the fully qualified URL of the current source value e.g. http://mysite.com/video.mp4 Can be used in conjuction with
currentType
to assist in rebuilding the current source object.
RETURNS:
String
The current source
defined in: src/js/player.js#L1240
currentTime( [seconds] )
Get or set the current time (in seconds)
// get var whereYouAt = myPlayer.currentTime(); // set myPlayer.currentTime(120); // 2 minutes into the video
PARAMETERS:
- seconds
Number|String
(OPTIONAL) The time to seek to
RETURNS:
Number
The time in seconds, when not settingvjs.Player
self, when the current time is set
defined in: src/js/player.js#L702
currentType()
Get the current source type e.g. video/mp4 This can allow you rebuild the current source object so that you could load the same source and tech later
RETURNS:
String
The source MIME type
defined in: src/js/player.js#L1250
dimensions( width, height )
Set both width and height at the same time
PARAMETERS:
- width
Number|String
- height
Number|String
RETURNS:
vjs.Component
The component
inherited from: src/js/component.js#L938
dispose()
Destroys the video player and does any necessary cleanup
myPlayer.dispose();
This is especially helpful if you are dynamically adding and removing videos to/from the DOM.
defined in: src/js/player.js#L164
duration( seconds )
Get the length in time of the video in seconds
var lengthOfVideo = myPlayer.duration();
NOTE: The video must have started loading before the duration can be known, and in the case of Flash, may not be known until the video starts playing.
PARAMETERS:
- seconds
RETURNS:
Number
The duration of the video in seconds
defined in: src/js/player.js#L730
el()
Get the component's DOM element
var domEl = myComponent.el();
RETURNS:
Element
inherited from: src/js/component.js#L220
enableTouchActivity()
Report user touch activity when touch events occur
User activity is used to determine when controls should show/hide. It's relatively simple when it comes to mouse events, because any mouse event should show the controls. So we capture mouse events that bubble up to the player and report activity when that happens.
With touch events it isn't as easy. We can't rely on touch events at the player level, because a tap (touchstart + touchend) on the video itself on mobile devices is meant to turn controls off (and on). User activity is checked asynchronously, so what could happen is a tap event on the video turns the controls off, then the touchend event bubbles up to the player, which if it reported user activity, would turn the controls right back on. (We also don't want to completely block touch events from bubbling up)
Also a touchmove, touch+hold, and anything other than a tap is not supposed to turn the controls back on on a mobile device.
Here we're setting the default component behavior to report user activity whenever touch events happen, and this can be turned off by components that want touch events to act differently.
inherited from: src/js/component.js#L1120
ended()
Returns whether or not the player is in the "ended" state.
RETURNS:
Boolean
True if the player is in the ended state, false if not.
defined in: src/js/player.js#L1474
error( err )
Set or get the current MediaError
PARAMETERS:
- err
*
A MediaError or a String/Number to be turned into a MediaError
RETURNS:
vjs.MediaError|null
when gettingvjs.Player
when setting
defined in: src/js/player.js#L1438
exitFullscreen()
Return the video to its normal size after having been in full screen mode
myPlayer.exitFullscreen();
RETURNS:
vjs.Player
self
defined in: src/js/player.js#L1017
getChild( name )
Returns a child component with the provided name
PARAMETERS:
- name
RETURNS:
vjs.Component
inherited from: src/js/component.js#L330
getChildById( id )
Returns a child component with the provided ID
PARAMETERS:
- id
RETURNS:
vjs.Component
inherited from: src/js/component.js#L313
hasClass( classToCheck )
Check if a component's element has a CSS class name
PARAMETERS:
- classToCheck
String
Classname to check
RETURNS:
vjs.Component
inherited from: src/js/component.js#L816
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
This component, when setting the heightNumber|String
The height, when getting
inherited from: src/js/component.js#L927
hide()
Hide the component element if currently showing
RETURNS:
vjs.Component
inherited from: src/js/component.js#L857
id()
Get the component's ID
var id = myComponent.id();
RETURNS:
String
inherited from: src/js/component.js#L258
init( tag, [options], [ready] )
player's constructor function
PARAMETERS:
- tag
Element
The original video tag used for configuring options - options
Object
(OPTIONAL) Player options - ready
Function
(OPTIONAL) Ready callback function
defined in: src/js/player.js#L32
initChildren()
Add and initialize default child components from options
// when an instance of MyComponent is created, all children in options // will be added to the instance by their name strings and options MyComponent.prototype.options_.children = { myChildComponent: { myChildOption: true } } // Or when creating the component var myComp = new MyComponent(player, { children: { myChildComponent: { myChildOption: true } } });
The children option can also be an Array of child names or child options objects (that also include a 'name' key).
var myComp = new MyComponent(player, { children: [ 'button', { name: 'button', someOtherOption: true } ] });
inherited from: src/js/component.js#L481
isFullScreen( isFS )
Old naming for isFullscreen() Deprecated true
PARAMETERS:
- isFS
defined in: src/js/player.js#L940
isFullscreen( [isFS] )
Check if the player is in fullscreen mode
// get var fullscreenOrNot = myPlayer.isFullscreen(); // set myPlayer.isFullscreen(true); // tell the player it's in fullscreen
NOTE: As of the latest HTML5 spec, isFullscreen is no longer an official property and instead document.fullscreenElement is used. But isFullscreen is still a valuable property for internal player workings.
PARAMETERS:
- isFS
Boolean
(OPTIONAL) Update the player's fullscreen state
RETURNS:
Boolean
true if fullscreen, false if notvjs.Player
self, when setting
defined in: src/js/player.js#L928
language( languageCode )
The player's language code
PARAMETERS:
- languageCode
String
The locale string
RETURNS:
String
The locale string when gettingvjs.Player
self, when setting
defined in: src/js/player.js#L124
load()
Begin loading the src data.
RETURNS:
vjs.Player
Returns the player
defined in: src/js/player.js#L1230
loop( value )
Get or set the loop attribute on the video element.
PARAMETERS:
- value
RETURNS:
String
The loop attribute value when gettingvjs.Player
Returns the player when setting
defined in: src/js/player.js#L1287
muted( [muted] )
Get the current muted state, or turn mute on or off
// get var isVolumeMuted = myPlayer.muted(); // set myPlayer.muted(true); // mute the volume
PARAMETERS:
- muted
Boolean
(OPTIONAL) True to mute, false to unmute
RETURNS:
Boolean
True if mute is on, false if not, when gettingvjs.Player
self, when setting mute
defined in: src/js/player.js#L890
name()
Get the component's name. The name is often used to reference the component.
var name = myComponent.name();
RETURNS:
String
inherited from: src/js/component.js#L277
off( [first], [second], [third] )
Remove an event listener from this component's element
myComponent.off('eventType', myFunc);
If myFunc is excluded, ALL listeners for the event type will be removed. If eventType is excluded, ALL listeners will be removed from the component.
Alternatively you can use
off
to remove listeners that were added to other elements or components usingmyComponent.on(otherComponent...
. In this case both the event type and listener function are REQUIRED.myComponent.off(otherElement, 'eventType', myFunc); myComponent.off(otherComponent, 'eventType', myFunc);
PARAMETERS:
- first
String|vjs.Component
(OPTIONAL) The event type or other component - second
Function|String
(OPTIONAL) The listener function or event type - third
Function
(OPTIONAL) The listener for other component
RETURNS:
vjs.Component
inherited from: src/js/component.js#L646
on( first, second, third )
Add an event listener to this component's element
var myFunc = function(){ var myComponent = this; // Do something when the event is fired }; myComponent.on('eventType', myFunc);
The context of myFunc will be myComponent unless previously bound.
Alternatively, you can add a listener to another element or component.
myComponent.on(otherElement, 'eventName', myFunc); myComponent.on(otherComponent, 'eventName', myFunc);
The benefit of using this over
vjs.on(otherElement, 'eventName', myFunc)
andotherComponent.on('eventName', myFunc)
is that this way the listeners will be automatically cleaned up when either component is disposed. It will also bind myComponent as the context of myFunc.NOTE: When using this on elements in the page other than window and document (both permanent), if you remove the element from the DOM you need to call
vjs.trigger(el, 'dispose')
on it to clean up references to it and allow the browser to garbage collect it.
PARAMETERS:
- first
String|vjs.Component
The event type or other component - second
Function|String
The event handler or event type - third
Function
The event handler
RETURNS:
vjs.Component
self
inherited from: src/js/component.js#L577
one( first, second, [third] )
Add an event listener to be triggered only once and then removed
myComponent.one('eventName', myFunc);
Alternatively you can add a listener to another element or component that will be triggered only once.
myComponent.one(otherElement, 'eventName', myFunc); myComponent.one(otherComponent, 'eventName', myFunc);
PARAMETERS:
- first
String|vjs.Component
The event type or other component - second
Function|String
The listener function or event type - third
Function
(OPTIONAL) The listener function for other component
RETURNS:
vjs.Component
inherited from: src/js/component.js#L691
options( obj )
Deep merge of options objects
Whenever a property is an object on both options objects the two properties will be merged using vjs.obj.deepMerge.
This is used for merging options for child components. We want it to be easy to override individual options on a child component without having to rewrite all the other default options.
Parent.prototype.options_ = { children: { 'childOne': { 'foo': 'bar', 'asdf': 'fdsa' }, 'childTwo': {}, 'childThree': {} } } newOptions = { children: { 'childOne': { 'foo': 'baz', 'abc': '123' } 'childTwo': null, 'childFour': {} } } this.options(newOptions);
RESULT
{ children: { 'childOne': { 'foo': 'baz', 'asdf': 'fdsa', 'abc': '123' }, 'childTwo': null, // Disabled. Won't be initialized. 'childThree': {}, 'childFour': {} } }
PARAMETERS:
- obj
Object
Object of new option values
RETURNS:
Object
A NEW object of this.options_ and obj merged
inherited from: src/js/component.js#L179
pause()
Pause the video playback
myPlayer.pause();
RETURNS:
vjs.Player
self
defined in: src/js/player.js#L671
paused()
Check if the player is paused
var isPaused = myPlayer.paused(); var isPlaying = !myPlayer.paused();
RETURNS:
Boolean
false if the media is currently playing, or true otherwise
defined in: src/js/player.js#L684
play()
start media playback
myPlayer.play();
RETURNS:
vjs.Player
self
defined in: src/js/player.js#L659
playbackRate( rate )
Gets or sets the current playback rate.
PARAMETERS:
- rate
Boolean
New playback rate to set.
RETURNS:
Number
Returns the new playback rate when settingNumber
Returns the current playback rate when getting
defined in: src/js/player.js#L1616
player()
Return the component's player
RETURNS:
vjs.Player
inherited from: src/js/component.js#L126
poster( [src] )
get or set the poster image source url
EXAMPLE:
// getting var currentPoster = myPlayer.poster(); // setting myPlayer.poster('http://example.com/myImage.jpg');
PARAMETERS:
- src
String
(OPTIONAL) Poster image source URL
RETURNS:
String
poster URL when gettingvjs.Player
self when setting
defined in: src/js/player.js#L1318
preload( value )
Get or set the preload attribute.
PARAMETERS:
- value
RETURNS:
String
The preload attribute value when gettingvjs.Player
Returns the player when setting
defined in: src/js/player.js#L1259
ready( fn )
Bind a listener to the component's ready state
Different from event listeners in that if the ready event has already happened it will trigger the function immediately.
PARAMETERS:
- fn
Function
Ready listener
RETURNS:
vjs.Component
inherited from: src/js/component.js#L769
remainingTime()
Calculates how much time is left.
var timeLeft = myPlayer.remainingTime();
Not a native video element function, but useful
RETURNS:
Number
The time remaining in seconds
defined in: src/js/player.js#L754
removeChild( component )
Remove a child component from this component's list of children, and the child component's element from this component's element
PARAMETERS:
- component
vjs.Component
Component to remove
inherited from: src/js/component.js#L420
removeClass( classToRemove )
Remove a CSS class name from the component's element
PARAMETERS:
- classToRemove
String
Classname to remove
RETURNS:
vjs.Component
inherited from: src/js/component.js#L837
requestFullScreen()
Old naming for requestFullscreen Deprecated true
defined in: src/js/player.js#L1004
requestFullscreen()
Increase the size of the video to full screen
myPlayer.requestFullscreen();
In some browsers, full screen is not supported natively, so it enters "full window mode", where the video fills the browser window. In browsers and devices that support native full screen, sometimes the browser's default controls will be shown, and not the Video.js custom skin. This includes most mobile devices (iOS, Android) and older versions of Safari.
RETURNS:
vjs.Player
self
defined in: src/js/player.js#L959
seeking()
Returns whether or not the player is in the "seeking" state.
RETURNS:
Boolean
True if the player is in the seeking state, false if not.
defined in: src/js/player.js#L1480
setInterval( fn, interval )
Creates an interval and sets up disposal automatically.
PARAMETERS:
- fn
Function
The function to run every N seconds. - interval
Number
Number of ms to delay before executing specified function.
RETURNS:
Number
Returns the interval ID
inherited from: src/js/component.js#L1198
setTimeout( fn, timeout )
Creates timeout and sets up disposal automatically.
PARAMETERS:
- fn
Function
The function to run after the timeout. - timeout
Number
Number of ms to delay before executing specified function.
RETURNS:
Number
Returns the timeout ID
inherited from: src/js/component.js#L1158
show()
Show the component element if hidden
RETURNS:
vjs.Component
inherited from: src/js/component.js#L847
src( [source] )
The source function updates the video source
There are three types of variables you can pass as the argument.
URL String: A URL to the the video file. Use this method if you are sure the current playback technology (HTML5/Flash) can support the source you provide. Currently only MP4 files can be used in both HTML5 and Flash.
myPlayer.src("http://www.example.com/path/to/video.mp4");
Source Object (or element): A javascript object containing information about the source file. Use this method if you want the player to determine if it can support the file using the type information.
myPlayer.src({ type: "video/mp4", src: "http://www.example.com/path/to/video.mp4" });
Array of Source Objects: To provide multiple versions of the source so that it can be played using HTML5 across browsers you can use an array of source objects. Video.js will detect which version is supported and load that file.
myPlayer.src([ { type: "video/mp4", src: "http://www.example.com/path/to/video.mp4" }, { type: "video/webm", src: "http://www.example.com/path/to/video.webm" }, { type: "video/ogg", src: "http://www.example.com/path/to/video.ogv" } ]);
PARAMETERS:
- source
String|Object|Array
(OPTIONAL) The source URL, object, or array of sources
RETURNS:
String
The current video source when gettingString
The player when setting
defined in: src/js/player.js#L1147
trigger( event )
Trigger an event on an element
myComponent.trigger('eventName'); myComponent.trigger({'type':'eventName'});
PARAMETERS:
- event
Event|Object|String
A string (the type) or an event object with a type attribute
RETURNS:
vjs.Component
self
inherited from: src/js/component.js#L724
triggerReady()
Trigger the ready listeners
RETURNS:
vjs.Component
inherited from: src/js/component.js#L788
volume( percentAsDecimal )
Get or set the current volume of the media
// get var howLoudIsIt = myPlayer.volume(); // set myPlayer.volume(0.5); // Set volume to half
0 is off (muted), 1.0 is all the way up, 0.5 is half way.
PARAMETERS:
- percentAsDecimal
Number
The new volume as a decimal percent
RETURNS:
Number
The current volume, when gettingvjs.Player
self, when setting
defined in: src/js/player.js#L860
width( [num], skipListeners )
Set or get the width 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) Optional width number - skipListeners
Boolean
Skip the 'resize' event trigger
RETURNS:
vjs.Component
This component, when setting the widthNumber|String
The width, when getting
inherited from: src/js/component.js#L910
EVENTS
durationchange EVENT
Fired when the duration of the media resource is first known or changed
defined in: src/js/player.js#L554
ended EVENT
Fired when the end of the media resource is reached (currentTime == duration)
defined in: src/js/player.js#L541
firstplay EVENT
Fired the first time a video is played
Not part of the HLS spec, and we're not sure if this is the best implementation yet, so use sparingly. If you don't have a reason to prevent playback, use
myPlayer.one('play');
instead.
defined in: src/js/player.js#L498
fullscreenchange EVENT
Fired when the player switches in or out of fullscreen mode
defined in: src/js/player.js#L583
loadedalldata EVENT
Fired when the player has finished downloading the source data
defined in: src/js/player.js#L445
loadeddata EVENT
Fired when the player has downloaded data at the current playback position
defined in: src/js/player.js#L439
loadedmetadata EVENT
Fired when the player has initial duration and dimension information
defined in: src/js/player.js#L433
loadstart EVENT
Fired when the user agent begins looking for media data
defined in: src/js/player.js#L389
pause EVENT
Fired whenever the media has been paused
defined in: src/js/player.js#L512
play EVENT
Fired whenever the media begins or resumes playback
defined in: src/js/player.js#L451
progress EVENT
Fired while the user agent is downloading media data
defined in: src/js/player.js#L530
resize EVENT
Fired when the width and/or height of the component changes
inherited from: src/js/component.js#L1020
seeked EVENT
Fired when the player has finished jumping to a new time
defined in: src/js/player.js#L485
seeking EVENT
Fired whenever the player is jumping to a new time
defined in: src/js/player.js#L477
timeupdate EVENT
Fired when the current playback position has changed
During playback this is fired every 15-250 milliseconds, depending on the playback technology in use.
defined in: src/js/player.js#L524
volumechange EVENT
Fired when the volume changes
defined in: src/js/player.js#L577
waiting EVENT
Fired whenever the media begins waiting
defined in: src/js/player.js#L460