Player

Global enumeration of players.

The keys are the player IDs and the values are either the Player instance or null for disposed players.

Get or set the Player's crossorigin option. For the HTML5 player, this sets the crossOrigin property on the <video> tag to control the CORS behavior.

Gets tag settings

Find a single DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Finds all DOM element matching a selector. This can be within the Components contentEl() or another custom context.

Add a child Component inside the current Component.

Add a CSS class name to the Components element.

Create a remote TextTrack and an HTMLTrackElement.

A helper method for adding a TextTrack to our TextTrackList.

In addition to the W3C settings we allow adding additional info through options.

This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.

A getter/setter for the Player's aspect ratio.

Get the current audioOnlyMode state or set audioOnlyMode to true or false.

Setting this to true will hide all player components except the control bar, as well as control bar components needed only for video.

Get the current audioPosterMode state or set audioPosterMode to true or false

Get the AudioTrackList

Get or set the autoplay option. When this is a boolean it will modify the attribute on the tech. When this is a string the attribute on the tech will be removed and Player will handle autoplay on loadstarts.

Remove the focus from this component

Get or set breakpoints on the player.

Calling this method with an object or true will remove any previous custom breakpoints and start from the defaults again.

Get a TimeRange object with an array of the times of the video that have been downloaded. If you just want the percent of the video that's been downloaded, use bufferedPercent.

Get the ending time of the last buffered time range This is used in the progress bar to encapsulate all time ranges.

Get the percent (as a decimal) of the video that's been downloaded. This method is not a part of the native HTML video API.

Builds the default DOM class name. Should be overridden by sub-components.

Cancels a queued callback passed to Component#requestAnimationFrame (rAF).

If you queue an rAF callback via Component#requestAnimationFrame, use this function instead of window.cancelAnimationFrame. If you don't, your dispose listener will not get cleaned up until Component#dispose!

Cancels a current named animation frame if it exists.

Check whether the player can play a given mimetype

Get an array of all child components

Clears an interval that gets created via window.setInterval or Component#setInterval. If you set an interval via Component#setInterval use this function instead of window.clearInterval. If you don't your dispose listener will not get cleaned up until Component#dispose!

Clears a timeout that gets created via window.setTimeout or Component#setTimeout. If you set a timeout via Component#setTimeout use this function instead of window.clearTimout. If you don't your dispose listener will not get cleaned up until Component#dispose!

Return the Components DOM element. This is where children get inserted. This will usually be the the same as the element returned in Component#el.

Get or set whether or not the controls are showing.

Create the Player's DOM element.

Creates a simple modal dialog (an instance of the ModalDialog component) that immediately overlays the player with arbitrary content and removes itself when closed.

Get or set the Player's crossOrigin option. For the HTML5 player, this sets the crossOrigin property on the <video> tag to control the CORS behavior.

Get current breakpoint name, if any.

Get the current breakpoint class name.

Get the computed width or the height of the component's element.

Uses window.getComputedStyle.

Get an object that contains computed width and height values of the component's element.

Uses window.getComputedStyle.

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns the current source object.

Returns all of the current source objects.

Returns the fully qualified URL of the current source value e.g. http://mysite.com/video.mp4 Can be used in conjunction with currentType to assist in rebuilding the current source object.

Get or set the current time (in seconds)

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

Get the computed width of the component's element.

Uses window.getComputedStyle.

Set debug mode to enable/disable logs at info level.

Get the current defaultMuted state, or turn defaultMuted on or off. defaultMuted indicates the state of muted on initial playback.

  var myPlayer = videojs('some-player-id');

  myPlayer.src("http://www.example.com/path/to/video.mp4");

  // get, should be false
  console.log(myPlayer.defaultMuted());
  // set to true
  myPlayer.defaultMuted(true);
  // get should be true
  console.log(myPlayer.defaultMuted());

Gets or sets the current default playback rate. A default playback rate of 1.0 represents normal speed and 0.5 would indicate half-speed playback, for instance. defaultPlaybackRate will only represent what the initial playbackRate of a video was, not not the current playbackRate.

A getter/setter for the Player's width & height.

Set both the width and height of the Component element at the same time.

Get or set disable Picture-in-Picture mode.

Destroys the video player and does any necessary cleanup.

This is especially helpful if you are dynamically adding and removing videos to/from the DOM.

when the document fschange event triggers it calls this

Normally gets the length in time of the video in seconds; in all but the rarest use cases an argument will NOT be passed to the method

NOTE: The video must have started loading before the duration can be known, and depending on preload behaviour may not be known until the video starts playing.

Get the Components DOM element

Emit a 'tap' events when touch event support gets detected. This gets used to support toggling the controls through a tap on the video. They get enabled because every sub-component would have extra overhead otherwise.

This function reports user activity whenever touch events happen. This can get turned off by any sub-components that wants touch events to act another way.

Report user touch activity when touch events occur. User activity gets used to determine when controls should show/hide. It is 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 as touchstart and touchend toggle player controls. So touch events can't help us at the player level either.

User activity gets 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. Furthermore a touchmove event and anything other than a tap, should not turn controls back on.

Returns whether the player is in the "ended" state.

When fullscreen isn't supported we can stretch the video container to as wide as the browser will let us.

Set or get the current MediaError

Return the video to its normal size after having been in full screen mode

Exit full window

Exit Picture-in-Picture mode.

A getter/setter/toggler for the vjs-fill className on the Player.

Turning this on will turn off fluid mode.

A getter/setter/toggler for the vjs-fluid className on the Player.

Turning this on will turn off fill mode.

Set the focus to this component

Check for call to either exit full window or full screen on ESC key

Get the value of an attribute on the Components element.

Get object for cached values.

Returns the child Component with the given name.

Returns the child Component with the given id.

Returns the descendant Component following the givent descendant names. For instance ['foo', 'bar', 'baz'] would try to get 'foo' on the current component, 'bar' on the 'foo' component and 'baz' on the 'bar' component and return undefined if any of those don't exist.

Get a clone of the current Player~MediaObject for this player.

If the loadMedia method has not been used, will attempt to return a Player~MediaObject based on the current state of the player.

Gets available media playback quality metrics as specified by the W3C's Media Playback Quality API.

Called when this Player receives a hotkey keydown event. Supported player-wide hotkeys are:

f - toggle fullscreen m - toggle mute k or Space - toggle play/pause

Called when this Player has focus and a key gets pressed down, or when any Component of this player receives a key press that it doesn't handle. This allows player-wide hotkeys (either as defined below, or optionally by an external function).

Many components used to have a handleKeyPress method, which was poorly named because it listened to a keydown event. This method name now delegates to handleKeyDown. This means anyone calling handleKeyPress will not see their method calls stop working.

Handles language change for the player in components. Should be overridden by sub-components.

Executes source setting and getting logic

Check if a component's element has a CSS class name.

Reports whether or not a player has a plugin available.

This does not report whether or not the plugin has ever been initialized on this player. For that, usingPlugin.

Add/remove the vjs-has-started class

A getter/setter for the Player's height. Returns the player's configured value. To get the current height use currentheight().

Hide the Components element if it is currently showing by adding the 'vjs-hidden` class name to it.

Get this Components ID

Add and initialize default child Components based upon options.

Gets or sets the audio flag

Determine whether or not this component has been disposed.

Check if the player is in fullscreen mode or tell the player that it is or is not in fullscreen mode.

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.

Check if the player is in Picture-in-Picture mode or tell the player that it is or is not in Picture-in-Picture mode.

Set or get the player's language code.

Changing the language will trigger languagechange which Components can use to update control text. ClickableComponent will update its control text by default on languagechange.

Get the player's language dictionary Merge every time, because a newly added plugin might call videojs.addLanguage() at any time Languages specified directly in the player options have precedence

Begin loading the src data.

Populate the player using a MediaObject.

Localize a string given the string in english.

If tokens are provided, it'll try and run a simple token replacement on the provided string. The tokens it looks for look like {1} with the index being 1-indexed into the tokens array.

If a defaultValue is provided, it'll use that over string, if a value isn't found in provided language files. This is useful if you want to have a descriptive key for token replacement but have a succinct localized string and not require en.json to be included.

Currently, it is used for the progress bar timing.

{
  "progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}

It is then used like so:

this.localize('progress bar timing: currentTime={1} duration{2}',
              [this.player_.currentTime(), this.player_.duration()],
              '{1} of {2}');

Which outputs something like: 01:23 of 24:56.

Get or set the loop attribute on the video element.

Handle autoplay string values, rather than the typical boolean values that should be handled by the tech. Note that this is not part of any specification. Valid values and what they do can be found on the autoplay getter at Player#autoplay()

Get the current muted state, or turn mute on or off

Get the Components name. The name gets used to reference the Component and is set during registration.

Returns the current state of network activity for the element, from the codes in the list below.

• NETWORK_EMPTY (numeric value 0) The element has not yet been initialised. All attributes are in their initial states.
• NETWORK_IDLE (numeric value 1) The element's resource selection algorithm is active and has selected a resource, but it is not actually using the network at this time.
• NETWORK_LOADING (numeric value 2) The user agent is actively trying to download data.
• NETWORK_NO_SOURCE (numeric value 3) The element's resource selection algorithm is active, but it has not yet found a resource to use.

Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.

Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.

This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.

Deep merge of options objects with new options.

Note: When both obj and options contain properties whose values are objects. The two properties get merged using module:obj.merge

Pause the video playback

Check if the player is paused or has yet to play

Attempt to begin playback at the first opportunity.

Gets or sets the current playback rate. A playback rate of 1.0 represents normal speed and 0.5 would indicate half-speed playback, for instance.

Set or get current playback rates. Takes an array and updates the playback rates menu with the new items. Pass in an empty array to hide the menu. Values other than arrays are ignored.

Get a TimeRange object representing the current ranges of time that the user has played.

Return the Player that the Component has attached to.

Set or unset the playsinline attribute. Playsinline tells the browser that non-fullscreen playback is preferred.

Get or set the poster image source url

Get or set the preload attribute

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.

Returns a value that expresses the current state of the element with respect to rendering the current playback position, from the codes in the list below.

• HAVE_NOTHING (numeric value 0) No information regarding the media resource is available.
• HAVE_METADATA (numeric value 1) Enough of the resource has been obtained that the duration of the resource is available.
• HAVE_CURRENT_DATA (numeric value 2) Data for the immediate current playback position is available.
• HAVE_FUTURE_DATA (numeric value 3) Data for the immediate current playback position is available, as well as enough data for the user agent to advance the current playback position in the direction of playback.
• HAVE_ENOUGH_DATA (numeric value 4) The user agent estimates that enough data is available for playback to proceed uninterrupted.

Calculates how much time is left in the video. Not part of the native video API.

A remaining time function that is intended to be used when the time is to be displayed directly to the user.

Get the remote HtmlTrackElementList tracks.

Get the remote TextTrackList

Remove an attribute from the Components element.

Remove a child Component from this Components list of children. Also removes the child Components element from this Components element.

Remove a CSS class name from the Components element.

Remove a remote TextTrack from the respective TextTrackList and HtmlTrackElementList.

Report user activity

Queues up a callback to be passed to requestAnimationFrame (rAF), but with a few extra bonuses:

• Supports browsers that do not support rAF by falling back to Component#setTimeout.

• The callback is turned into a Component~GenericCallback (i.e. bound to the component).

• Automatic cancellation of the rAF callback is handled if the component is disposed before it is called.

Increase the size of the video to full screen 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.

Request an animation frame, but only one named animation frame will be queued. Another will never be added until the previous one finishes.

Create a floating video window always on top of other windows so that users may continue consuming media while they interact with other content sites, or applications on their device.

This can use document picture-in-picture or element picture in picture

Set enableDocumentPictureInPicture to true to use docPiP on a supported browser Else set disablePictureInPicture to false to disable elPiP on a supported browser

Reset the player. Loads the first tech in the techOrder, removes all the text tracks in the existing tech, and calls reset on the tech.

Reset Control Bar's UI by calling sub-methods that reset all of Control Bar's components

Reset Playback ratio

Reset tech's progress so progress bar is reset in the UI

Reset Volume bar

Get or set a flag indicating whether or not this player should adjust its UI based on its dimensions.

When a callback to play is delayed we have to run these callbacks when play is actually called on the tech. This function runs the callbacks that were delayed and accepts the return value from the tech.

These functions will be run when if play is terminated. If play runPlayCallbacks_ is run these function will not be run. This allows us to differentiate between a terminated play and an actual call to play.

Sets or returns whether or not the user is "scrubbing". Scrubbing is when the user has clicked the progress bar handle and is dragging it along the progress bar.

Get the TimeRanges of the media that are currently available for seeking to.

Returns whether the player is in the "seeking" state.

Select source based on tech-order or source-order Uses source-order selection if options.sourceOrder is truthy. Otherwise, defaults to tech-order selection

Set the value of an attribute on the Component's element

Adds an SVG icon element to another element or component.

Creates a function that gets run every x milliseconds. This function is a wrapper around window.setInterval. There are a few reasons to use this one instead though.

1. It gets cleared via Component#clearInterval when Component#dispose gets called.
2. The function callback will be a Component~GenericCallback

Creates a function that runs after an x millisecond timeout. This function is a wrapper around window.setTimeout. There are a few reasons to use this one instead though:

1. It gets cleared via Component#clearTimeout when Component#dispose gets called.
2. The function callback will gets turned into a Component~GenericCallback

Note: You can't use window.clearTimeout on the id returned by this function. This will cause its dispose listener not to get cleaned up! Please use Component#clearTimeout or Component#dispose instead.

Show the Components element if it is hidden by removing the 'vjs-hidden' class name from it.

Get or set the video source.

Check if current tech can support native fullscreen (e.g. with built in controls like iOS)

Return a reference to the current Tech. It will print a warning by default about the danger of using the tech directly but any argument that is passed in will silence the warning.

Get the TextTrackList

Add or remove a CSS class name from the component's element.

• classToToggle gets added when Component#hasClass would return false.
• classToToggle gets removed when Component#hasClass would return true.

returns a JavaScript object representing the current track information. DOES not return it as JSON

This function causes an event to happen. This will then cause any event listeners that are waiting for that event, to get called. If there are no event listeners for an event then nothing will happen.

If the name of the Event that is being triggered is in EventTarget.allowedEvents_. Trigger will also call the on + uppercaseEventName function.

Example: 'click' is in EventTarget.allowedEvents_, so, trigger will attempt to call onClick if it exists.

Trigger all the ready listeners for this Component.

Update the internal source caches so that we return the correct source from src(), currentSource(), and currentSources().

Note: currentSources will not be updated if the source that is passed in exists in the current currentSources cache.

Get/set if user is active

Toggle native controls on/off. Native controls are the controls built into devices (e.g. default iPhone controls) or other techs (e.g. Vimeo Controls) This should only be set by the current tech, because only the tech knows if it can support native controls

Reports whether or not a player is using a plugin by name.

For basic plugins, this only reports whether the plugin has ever been initialized on this player.

Returns an object with Video.js version.

Get video height

Get the VideoTrackList

Get video width

Get or set the current volume of the media

A getter/setter for the Player's width. Returns the player's configured value. To get the current width use currentWidth().

An object that describes a single piece of media.

Properties that are not part of this type description will be retained; so, this can be viewed as a generic metadata storage mechanism as well.

Signals that a plugin is about to be set up on a player - by name. The name is the name of the plugin.

Fires when the loading of an audio/video is aborted.

Signals that a plugin is about to be set up on a player.

The media has a readyState of HAVE_FUTURE_DATA or greater.

The media has a readyState of HAVE_ENOUGH_DATA or greater. This means that the entire media file can be played without buffering.

Triggered when a component is resized.

Called when the player is being disposed of.

Fires when the current playlist is empty.

Fired when the end of the media resource is reached (currentTime == duration)

This event fires when the player enters picture in picture mode

fires when the player language change

This event fires when the player leaves picture in picture mode

Fires when the browser has loaded the current frame of the audio/video.

Fired when the player has downloaded data at the current playback position

Fires when the browser has loaded meta data for the audio/video.

Fired when the player has initial duration and dimension information

Fired when the user agent begins looking for media data

Fired whenever the media has been paused

Triggered whenever an Tech#play event happens. Indicates that playback has started or resumed.

fires when the playback rates in a player are changed

Called when the player size has changed

The media is no longer blocked from playback, and has started playing.

Signals that a plugin has just been set up on a player.

This event fires when the poster image is changed on the player.

Fired while the user agent is downloading media data.

Fires when the playing speed of the audio/video is changed

Triggered when a Component is ready.

Fires when the video's intrinsic dimensions change

Fired when the player has finished jumping to a new time

Fired whenever the player is jumping to a new time

EXPERIMENTAL Fired when the source is set or changed on the Tech causing the media element to reload.

It will fire for the initial source and each subsequent source. This event is a custom event from Video.js and is triggered by the Tech.

The event object for this event contains a src property that will contain the source that was available when the event was triggered. This is generally only necessary if Video.js is switching techs while the source was being changed.

It is also fired when load is called on the player (or media element) because the specification for load says that the resource selection algorithm needs to be aborted and restarted. In this case, it is very likely that the src property will be set to the empty string "" to indicate we do not know what the source will be but that it is changing.

This event is currently still experimental and may change in minor releases. To use this, pass enableSourceset option to the player.

Fires when the browser is trying to get media data, but data is not available.

Fires when the browser is intentionally not getting media data.

Triggered when a Component is tapped.

Fires when we get a textdata event from tech

Fires when the text track has been changed

Fires when the current playback position has changed.

Fired when the current playback position has changed * During playback this is fired every 15-250 milliseconds, depending on the playback technology in use.

player is using the custom HTML controls

player is using the native device controls

Fires when the volume has been changed

Fired when the volume changes

A readyState change on the DOM element has caused playback to stop.

Signals that a plugin has just been set up on a player - by name. The name is the name of the plugin.