Html5

HTML5 Media Controller - Wrapper for HTML5 Media API

Constructor

new Html5(optionsopt, readyopt)

Create an instance of this Tech.

Parameters:
NameTypeAttributesDescription
optionsObject<optional>

The key/value store of player options.

readyfunction<optional>

Callback function to call when the HTML5 Tech is ready.

Mixes In
  • Tech~SourceHandlerAdditions

Extends

Members

featuresFullscreenResize :boolean

Boolean indicating whether the HTML5 tech currently supports automatic media resize when going into fullscreen.

Type:
  • boolean
Default Value
  • true

featuresMuteControl :boolean

Boolean indicating whether the Tech supports muting volume.

Type:
  • boolean
Default Value
  • true

featuresNativeTextTracks :boolean

Boolean indicating whether the Tech supports the native TextTracks. This will help us integrate with native TextTracks if the browser supports them.

Type:
  • boolean

featuresPlaybackRate :boolean

Boolean indicating whether the Tech supports changing the speed at which the video plays. Examples:

  • Set player to play 2x (twice) as fast
  • Set player to play 0.5x (half) as fast
Type:
  • boolean

featuresProgressEvents :boolean

Boolean indicating whether the HTML5 tech currently supports the progress event. If this is false, manual progress events will be triggered instead.

Type:
  • boolean
Default Value
  • true

featuresSourceset :boolean

Boolean indicating whether the Tech supports the sourceset event.

A tech should set this to true and then use Tech#triggerSourceset to trigger a Tech#event:sourceset at the earliest time after getting a new source.

Type:
  • boolean

featuresTimeupdateEvents

Boolean indicating whether the HTML5 tech currently supports the timeupdate event. If this is false, manual timeupdate events will be triggered instead.

Default Value
  • true

featuresVideoFrameCallback :boolean

Whether the HTML5 el supports requestVideoFrameCallback

Type:
  • boolean

featuresVolumeControl :boolean

Boolean indicating whether the Tech supports volume control.

Type:
  • boolean
Default Value
  • true

movingMediaElementInDOM :boolean

Boolean indicating whether the HTML5 tech currently supports the media element moving in the DOM. iOS breaks if you move the media element, so this is set this to false there. Everywhere else this should be true.

Type:
  • boolean

(static) nativeSourceHandler

Native source handler for Html5, simply passes the source to the media element.

Properties
NameTypeDescription
sourceTech~SourceObject

The source object

techHtml5

The instance of the HTML5 tech.

Methods

$(selector, contextopt) → {Element|null}

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

Parameters:
NameTypeAttributesDefaultDescription
selectorstring

A valid CSS selector, which will be passed to querySelector.

contextElement | string<optional>
this.contentEl()

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Overrides
Returns:

the dom element that was found, or null

Type: 
Element | null

$$(selector, contextopt) → {NodeList}

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

Parameters:
NameTypeAttributesDefaultDescription
selectorstring

A valid CSS selector, which will be passed to querySelectorAll.

contextElement | string<optional>
this.contentEl()

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Overrides
Returns:

a list of dom elements that were found

Type: 
NodeList

addChild(child, optionsopt, indexopt) → {Component}

Add a child Component inside the current Component.

Parameters:
NameTypeAttributesDefaultDescription
childstring | Component

The name or instance of a child to add.

optionsObject<optional>
{}

The key/value store of options that will get passed to children of the child.

indexnumber<optional>
this.children_.length

The index to attempt to add a child into.

Overrides
Returns:

The Component that gets added as a child. When using a string the Component will get created by this process.

Type: 
Component

addClass(…classesToAdd)

Add a CSS class name to the Components element.

Parameters:
NameTypeAttributesDescription
classesToAddstring<repeatable>

One or more CSS class name to add.

Overrides

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

Creates a remote text track object and returns an html track element.

Parameters:
NameTypeAttributesDefaultDescription
optionsObject

The object should contain values for kind, language, label, and src (location of the WebVTT file)

manualCleanupboolean<optional>
false

if set to true, the TextTrack will not be removed from the TextTrackList and HtmlTrackElementList after a source change

Returns:

An Html Track Element. This can be an emulated HTMLTrackElement or a native one.

Type: 
HTMLTrackElement

addTextTrack(kind, labelopt, languageopt) → {TextTrack}

Create and returns a remote TextTrack object.

Parameters:
NameTypeAttributesDescription
kindstring

TextTrack kind (subtitles, captions, descriptions, chapters, or metadata)

labelstring<optional>

Label to identify the text track

languagestring<optional>

Two letter language abbreviation

Returns:

The TextTrack that gets created.

Type: 
TextTrack

addWebVttScript_()

Emulate TextTracks using vtt.js if necessary

Fires:

any(type, fn)

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.

Parameters:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to be called once for each event name.

Overrides

audioTracks() → {AudioTrackList}

Returns:
Type: 
AudioTrackList

autoplay() → {boolean}

Get the value of autoplay from the media element. autoplay indicates that the media should start to play as soon as the page is ready.

See
Returns:
  • The value of autoplay from the media element. - True indicates that the media should start as soon as the page loads. - False indicates that the media should not start as soon as the page loads.
Type: 
boolean

blur()

Remove the focus from this component

Overrides

buffered() → {TimeRange}

Get the value of buffered from the media element. buffered is a TimeRange object that represents the parts of the media that are already downloaded and available for playback.

Overrides
See
Returns:

The value of buffered from the media element.

Type: 
TimeRange

bufferedPercent() → {number}

Get the percentage of the current video that is currently buffered.

Returns:

A number from 0 to 1 that represents the decimal percentage of the video that is buffered.

Type: 
number

(abstract) buildCSSClass() → {string}

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

Returns:

The DOM class name for this object.

Type: 
string

(abstract) canPlayType(_type) → {string}

Check if the tech can support the given mime-type.

The base tech does not support any type, but source handlers might overwrite this.

Parameters:
NameTypeDescription
_typestring

The mimetype to check for support

See
Returns:

'probably', 'maybe', or empty string

Type: 
string

cancelAnimationFrame(id) → {number}

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!

Parameters:
NameTypeDescription
idnumber

The rAF ID to clear. The return value of Component#requestAnimationFrame.

Returns:

Returns the rAF ID that was cleared.

Type: 
number

cancelNamedAnimationFrame(name)

Cancels a current named animation frame if it exists.

Parameters:
NameTypeDescription
namestring

The name of the requestAnimationFrame to cancel.

cancelVideoFrameCallback(id)

Native or fallback requestVideoFrameCallback

Parameters:
NameTypeDescription
idnumber

request id to cancel

children() → {Array}

Get an array of all child components

Overrides
Returns:

The children

Type: 
Array

cleanupAutoTextTracks()

Remove any TextTracks added via addRemoteTextTrack that are flagged for automatic garbage collection

clearInterval(intervalId) → {number}

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!

Parameters:
NameTypeDescription
intervalIdnumber

The id of the interval to clear. The return value of Component#setInterval or window.setInterval.

Returns:

Returns the interval id that was cleared.

Type: 
number

clearTimeout(timeoutId) → {number}

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!

Parameters:
NameTypeDescription
timeoutIdnumber

The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.

Returns:

Returns the timeout id that was cleared.

Type: 
number

clearTracks(types)

Clear out a single TrackList or an array of TrackLists given their names.

Note: Techs without source handlers should call this between sources for video & audio tracks. You don't want to use them between tracks!

Parameters:
NameTypeDescription
typesArray.<string> | string

TrackList names to clear, valid names are video, audio, and text.

contentEl() → {Element}

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.

Returns:

The content element for this Component.

Type: 
Element

controls() → {boolean}

Get the value of controls from the media element. controls indicates whether the native media controls should be shown or hidden.

See
Returns:
  • The value of controls from the media element. - True indicates that native controls should be showing. - False indicates that native controls should be hidden.
Type: 
boolean

createEl() → {Element}

Create the Html5 Tech's DOM element.

Overrides
Returns:

The element that gets created.

Type: 
Element

createRemoteTextTrack(options) → {HTMLTrackElement}

Creates either native TextTrack or an emulated TextTrack depending on the value of featuresNativeTextTracks

Parameters:
NameTypeDescription
optionsObject

The object should contain the options to initialize the TextTrack with.

Properties
NameTypeAttributesDescription
kindstring<optional>

TextTrack kind (subtitles, captions, descriptions, chapters, or metadata).

labelstring<optional>

Label to identify the text track

languagestring<optional>

Two letter language abbreviation.

defaultboolean<optional>

Default this track to on.

idstring<optional>

The internal id to assign this track.

srcstring<optional>

A source url for the track.

Returns:

The track element that gets created.

Type: 
HTMLTrackElement

crossOrigin() → {string}

Get the value of crossOrigin from the media element. crossOrigin indicates to the browser that should sent the cookies along with the requests for the different assets/playlists

See
Returns:
  • anonymous indicates that the media should not sent cookies. - use-credentials indicates that the media should sent cookies along the requests.
Type: 
string

currentDimension(widthOrHeight) → {number}

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

Uses window.getComputedStyle.

Parameters:
NameTypeDescription
widthOrHeightstring

A string containing 'width' or 'height'. Whichever one you want to get.

Returns:

The dimension that gets asked for or 0 if nothing was set for that dimension.

Type: 
number

currentDimensions() → {Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:

The computed dimensions of the component's element.

Type: 
Component~DimensionObject

currentHeight() → {number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:

The computed height of the component's element.

Type: 
number

currentSrc() → {Tech~SourceObject}

Get the current source on the HTML5 Tech. Falls back to returning the source from the HTML5 media element.

Returns:

The current source object from the HTML5 tech. With a fallback to the elements source.

Type: 
Tech~SourceObject

currentTime() → {number}

Get the value of currentTime from the media element. currentTime indicates the current second that the media is at in playback.

See
Returns:

The value of currentTime from the media element.

Type: 
number

currentWidth() → {number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:

The computed width of the component's element.

Type: 
number

defaultMuted() → {boolean}

Get the value of defaultMuted from the media element. defaultMuted indicates whether the media should start muted or not. Only changes the default state of the media. muted and defaultMuted can have different values. Html5#muted indicates the current state.

See
Returns:
  • The value of defaultMuted from the media element. - True indicates that the media should start muted. - False indicates that the media should not start muted
Type: 
boolean

defaultPlaybackRate() → {number}

Get the value of defaultPlaybackRate from the media element. defaultPlaybackRate indicates the rate at which the media is currently playing back. This value will not indicate the current playbackRate after playback has started, use Html5#playbackRate for that.

Examples:

  • if defaultPlaybackRate is set to 2, media will play twice as fast.
  • if defaultPlaybackRate is set to 0.5, media will play half as fast.
See
Returns:

The value of defaultPlaybackRate from the media element. A number indicating the current playback speed of the media, where 1 is normal speed.

Type: 
number

dimension(widthOrHeight, numopt, skipListenersopt) → {number|undefined}

Get or set width or height of the Component element. This is the shared code for the Component#width and Component#height.

Things to know:

  • If the width or height in an number this will return the number postfixed with 'px'.
  • If the width/height is a percent this will return the percent postfixed with '%'
  • Hidden elements have a width of 0 with window.getComputedStyle. This function defaults to the Components style.width and falls back to window.getComputedStyle. See this for more information
  • If you want the computed style of the component, use Component#currentWidth and {Component#currentHeight
Parameters:
NameTypeAttributesDescription
widthOrHeightstring

8 'width' or 'height'

numnumber | string<optional>

8 New dimension

skipListenersboolean<optional>

Skip componentresize event trigger

Returns:

The dimension when getting or 0 if unset

Type: 
number | undefined

dimensions(width, height)

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

Parameters:
NameTypeDescription
widthnumber | string

Width to set the Components element to.

heightnumber | string

Height to set the Components element to.

disablePictureInPicture() → {boolean}

Get the value of 'disablePictureInPicture' from the video element.

See
Returns:

value - The value of disablePictureInPicture from the video element. - True indicates that the video can't be played in Picture-In-Picture mode - False indicates that the video can be played in Picture-In-Picture mode

Type: 
boolean

dispose()

Dispose of HTML5 media element and remove all tracks.

Overrides

duration() → {number}

Get the current duration of the HTML5 media element.

Returns:

The duration of the media or 0 if there is no duration.

Type: 
number

el() → {Element}

Get the Components DOM element

Overrides
Returns:

The DOM element for this Component.

Type: 
Element

(protected) emitTapEvents()

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.

Listens to Events:
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchleave
  • Component#event:touchcancel
  • Component#event:touchend

emulateTextTracks()

Emulate texttracks

enableTouchActivity()

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.

Listens to Events:
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchend
  • Component#event:touchcancel

ended() → {boolean}

Get the value of ended from the media element. ended indicates whether the media has reached the end or not.

See
Returns:
  • The value of ended from the media element. - True indicates that the media has ended. - False indicates that the media has not ended.
Type: 
boolean

enterFullScreen()

Request that the HTML5 Tech enter fullscreen.

error() → {MediaError|null}

Get the value of the error from the media element. error indicates any MediaError that may have occurred during playback. If error returns null there is no current error.

Overrides
See
Returns:

The value of error from the media element. Will be MediaError if there is a current error and null otherwise.

Type: 
MediaError | null

exitFullScreen()

Request that the HTML5 Tech exit fullscreen.

focus()

Set the focus to this component

Overrides

getAttribute(attribute) → {string|null}

Get the value of an attribute on the Components element.

Parameters:
NameTypeDescription
attributestring

Name of the attribute to get the value from.

Returns:
  • The value of the attribute that was asked for. - Can be an empty string on some browsers if the attribute does not exist or has no value - Most browsers will return null if the attribute does not exist or has no value.
Type: 
string | null

getChild(name) → {Component|undefined}

Returns the child Component with the given name.

Parameters:
NameTypeDescription
namestring

The name of the child Component to get.

Overrides
Returns:

The child Component with the given name or undefined.

Type: 
Component | undefined

getChildById(id) → {Component|undefined}

Returns the child Component with the given id.

Parameters:
NameTypeDescription
idstring

The id of the child Component to get.

Returns:

The child Component with the given id or undefined.

Type: 
Component | undefined

getDescendant(…names) → {Component|undefined}

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.

Parameters:
NameTypeAttributesDescription
names...Array.<string> | string<repeatable>

The name of the child Component to get.

Returns:

The descendant Component following the given descendant names or undefined.

Type: 
Component | undefined

getIsAvailableToBeFocused(el) → {boolean}

Determine whether or not this component is currently visible/enabled/etc...

Parameters:
NameTypeDescription
elHTMLElement

The HTML element representing the component.

Returns:

If the component can is currently visible & enabled, will be true. Otherwise, false.

Type: 
boolean

getIsFocusable(el) → {boolean}

Determine whether or not this component can be considered as focusable component.

Parameters:
NameTypeDescription
elHTMLElement

The HTML element representing the component.

Returns:

If the component can be focused, will be true. Otherwise, false.

Type: 
boolean

getPositions() → {Object}

Retrieves the position and size information of the component's element.

Returns:

An object with boundingClientRect and center properties. - boundingClientRect: An object with properties x, y, width, height, top, right, bottom, and left, representing the bounding rectangle of the element. - center: An object with properties x and y, representing the center point of the element. width and height are set to 0.

Type: 
Object

getVideoPlaybackQuality() → {Object}

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

See
Returns:

An object with supported media playback quality metrics

Type: 
Object

handleKeyDown(event)

When this Component receives a keydown event which it does not process, it passes the event to the Player for handling.

Parameters:
NameTypeDescription
eventKeyboardEvent

The keydown event that caused this function to be called.

handleKeyPress(event)

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.

Parameters:
NameTypeDescription
eventKeyboardEvent

The event that caused this function to be called.

(abstract) handleLanguagechange()

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

handleLateInit_() → {undefined}

This will be triggered if the loadstart event has already fired, before videojs was ready. Two known examples of when this can happen are:

  1. If we're loading the playback object after it has started loading
  2. The media is already playing the (often with autoplay on) then

This function will fire another loadstart so that videojs can catchup.

Fires:
  • Tech#event:loadstart
Returns:

returns nothing.

Type: 
undefined

hasClass(classToCheck) → {boolean}

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

Parameters:
NameTypeDescription
classToCheckstring

CSS class name to check.

Overrides
Returns:
  • True if the Component has the class. - False if the Component does not have the class`
Type: 
boolean

height() → {number}

Get the current height of the HTML5 media element.

Overrides
Returns:

The height of the HTML5 media element.

Type: 
number

hide()

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

Overrides

id() → {string}

Get this Components ID

Overrides
Returns:

The id of this Component

Type: 
string

initChildren()

Add and initialize default child Components based upon options.

initTrackListeners()

Turn on listeners for VideoTrackList, {AudioTrackList, and TextTrackList events.

This adds EventTarget~EventListeners for addtrack, and removetrack.

isDisposed() → {boolean}

Determine whether or not this component has been disposed.

Returns:

If the component has been disposed, will be true. Otherwise, false.

Type: 
boolean

load()

A wrapper around the media elements load function. This will call the HTML5s media element load function.

See

localize(string, tokensopt, defaultValueopt) → {string}

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.

Parameters:
NameTypeAttributesDescription
stringstring

The string to localize and the key to lookup in the language files.

tokensArray.<string><optional>

If the current item has token replacements, provide the tokens here.

defaultValuestring<optional>

Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.

Overrides
Returns:

The localized string or if no localization exists the english string.

Type: 
string

loop() → {boolean}

Get the value of loop from the media element. loop indicates that the media should return to the start of the media and continue playing once it reaches the end.

See
Returns:
  • The value of loop from the media element. - True indicates that playback should seek back to start once the end of a media is reached. - False indicates that playback should not loop back to the start when the end of the media is reached.
Type: 
boolean

manualProgressOff()

Turn off the polyfill for progress events that was created in Tech#manualProgressOn

manualProgressOn()

Polyfill the progress event for browsers that don't support it natively.

manualTimeUpdatesOff()

Turn off the polyfill for timeupdate events that was created in Tech#manualTimeUpdatesOn

manualTimeUpdatesOn()

Polyfill the timeupdate event for browsers that don't support it.

muted() → {boolean}

Get the value of muted from the media element. muted indicates that the volume for the media should be set to silent. This does not actually change the volume attribute.

See
Returns:
  • True if the value of volume should be ignored and the audio set to silent. - False if the value of volume should be used.
Type: 
boolean

name() → {string}

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

Overrides
Returns:

The name of this Component.

Type: 
string

networkState() → {number}

Get the value of networkState from the media element. networkState indicates the current network state. It returns an enumeration from the following list:

  • 0: NETWORK_EMPTY
  • 1: NETWORK_IDLE
  • 2: NETWORK_LOADING
  • 3: NETWORK_NO_SOURCE
Returns:

The value of networkState from the media element. This will be a number from the list in the description.

Type: 
number

off(type, fnopt)

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.

Parameters:
NameTypeAttributesDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction<optional>

The function to remove. If not specified, all listeners managed by Video.js will be removed.

Overrides

on(type, fn)

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.

Parameters:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to call with EventTargets

Overrides

onDurationChange(event)

Update our internal duration on a durationchange event by calling Tech#duration.

Parameters:
NameTypeDescription
eventEvent

The durationchange event that caused this to run.

Listens to Events:
  • Tech#event:durationchange

one(type, fn)

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.

Parameters:
NameTypeDescription
typestring | Array.<string>

An event name or an array of event names.

fnfunction

The function to be called once for each event name.

Overrides

options(obj) → {Object}

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

Parameters:
NameTypeDescription
objObject

The object that contains new options.

Overrides
Returns:

A new object of this.options_ and obj merged together.

Type: 
Object

overrideNativeAudioTracks(override)

Attempt to force override of native audio tracks.

Parameters:
NameTypeDescription
overrideboolean

If set to true native audio will be overridden, otherwise native audio will potentially be used.

overrideNativeVideoTracks(override)

Attempt to force override of native video tracks.

Parameters:
NameTypeDescription
overrideboolean

If set to true native video will be overridden, otherwise native video will potentially be used.

pause()

A wrapper around the media elements pause function. This will call the HTML5 media elements pause function.

See

paused() → {boolean}

Get the value of paused from the media element. paused indicates whether the media element is currently paused or not.

See
Returns:

The value of paused from the media element.

Type: 
boolean

play()

A wrapper around the media elements play function. This will call the HTML5s media element play function.

Overrides
See

playbackRate() → {number}

Get the value of playbackRate from the media element. playbackRate indicates the rate at which the media is currently playing back. Examples:

  • if playbackRate is set to 2, media will play twice as fast.
  • if playbackRate is set to 0.5, media will play half as fast.
See
Returns:

The value of playbackRate from the media element. A number indicating the current playback speed of the media, where 1 is normal speed.

Type: 
number

played() → {TimeRange}

Get the value of played from the media element. played returns a TimeRange object representing points in the media timeline that have been played.

Overrides
See
Returns:

The value of played from the media element. A TimeRange object indicating the ranges of time that have been played.

Type: 
TimeRange

player() → {Player}

Return the Player that the Component has attached to.

Overrides
Returns:

The player that this Component has attached to.

Type: 
Player

playsinline() → {boolean}

Get the value of playsinline from the media element. playsinline indicates to the browser that non-fullscreen playback is preferred when fullscreen playback is the native default, such as in iOS Safari.

See
Returns:
  • The value of playsinline from the media element. - True indicates that the media should play inline. - False indicates that the media should not play inline.
Type: 
boolean

poster() → {string}

Get the value of poster from the media element. poster indicates that the url of an image file that can/will be shown when no media data is available.

See
Returns:

The value of poster from the media element. Value will be a url to an image.

Type: 
string

preload() → {string}

Get the value of preload from the media element. preload indicates what should download before the media is interacted with. It can have the following values:

  • none: nothing should be downloaded
  • metadata: poster and the first few frames of the media may be downloaded to get media dimensions and other metadata
  • auto: allow the media and metadata for the media to be downloaded before interaction
See
Returns:

The value of preload from the media element. Will be 'none', 'metadata', or 'auto'.

Type: 
string

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:
NameTypeDescription
fnReadyCallback

Function that gets called when the Component is ready.

Overrides

readyState() → {number}

Get the value of readyState from the media element. readyState indicates the current state of the media element. It returns an enumeration from the following list:

  • 0: HAVE_NOTHING
  • 1: HAVE_METADATA
  • 2: HAVE_CURRENT_DATA
  • 3: HAVE_FUTURE_DATA
  • 4: HAVE_ENOUGH_DATA
Returns:

The value of readyState from the media element. This will be a number from the list in the description.

Type: 
number

remoteTextTrackEls() → {HtmlTrackElementList}

Get the remote element HtmlTrackElementList

Returns:
Type: 
HtmlTrackElementList

remoteTextTracks() → {TextTrackList}

Get the remote element TextTrackList

Returns:
Type: 
TextTrackList

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
NameTypeDescription
attributestring

Name of the attribute to remove.

removeChild(component)

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

Parameters:
NameTypeDescription
componentComponent

The child Component to remove.

removeClass(…classesToRemove)

Remove a CSS class name from the Components element.

Parameters:
NameTypeAttributesDescription
classesToRemovestring<repeatable>

One or more CSS class name to remove.

removeRemoteTextTrack(track)

Remove remote TextTrack from TextTrackList object

Parameters:
NameTypeDescription
trackTextTrack

TextTrack object to remove

requestAnimationFrame(fn) → {number}

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.

Parameters:
NameTypeDescription
fnComponent~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.

Listens to Events:
Returns:

Returns an rAF ID that gets used to identify the timeout. It can also be used in Component#cancelAnimationFrame to cancel the animation frame callback.

Type: 
number

requestNamedAnimationFrame(name, fn)

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

Parameters:
NameTypeDescription
namestring

The name to give this requestAnimationFrame

fnComponent~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.

requestPictureInPicture() → {Promise}

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.

See
Returns:

A promise with a Picture-in-Picture window.

Type: 
Promise

requestVideoFrameCallback(cb) → {number}

Native requestVideoFrameCallback if supported by browser/tech, or fallback Don't use rVCF on Safari when DRM is playing, as it doesn't fire Needs to be checked later than the constructor This will be a false positive for clear sources loaded after a Fairplay source

Parameters:
NameTypeDescription
cbfunction

function to call

Returns:

id of request

Type: 
number

reset()

Reset the tech by removing all sources and then calling Html5.resetMediaElement.

Overrides

scrubbing() → {boolean}

Get whether we are scrubbing or not.

Returns:

isScrubbing - true for we are currently scrubbing - false for we are no longer scrubbing

Type: 
boolean

seekable() → {TimeRange}

Get the value of seekable from the media element. seekable returns a TimeRange object indicating ranges of time that can currently be seeked to.

See
Returns:

The value of seekable from the media element. A TimeRange object indicating the current ranges of time that can be seeked to.

Type: 
TimeRange

seeking() → {boolean}

Get the value of seeking from the media element. seeking indicates whether the media is currently seeking to a new position or not.

See
Returns:
  • The value of seeking from the media element. - True indicates that the media is currently seeking to a new position. - False indicates that the media is not seeking to a new position at this time.
Type: 
boolean

setAttribute(attribute, value)

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

Parameters:
NameTypeDescription
attributestring

Name of the attribute to set.

valuestring

Value to set the attribute to.

setAutoplay(autoplay)

Set the value of autoplay on the media element. autoplay indicates that the media should start to play as soon as the page is ready.

Parameters:
NameTypeDescription
autoplayboolean
  • True indicates that the media should start as soon as the page loads. - False indicates that the media should not start as soon as the page loads.
See

setControls(val)

Set controls attribute for the HTML5 media Element.

Parameters:
NameTypeDescription
valstring

Value to set the controls attribute to

setCrossOrigin(crossOrigin)

Set the value of crossOrigin from the media element. crossOrigin indicates to the browser that should sent the cookies along with the requests for the different assets/playlists

Parameters:
NameTypeDescription
crossOriginstring
  • anonymous indicates that the media should not sent cookies. - use-credentials indicates that the media should sent cookies along the requests.
See

setCurrentTime(seconds)

Set current time for the HTML5 tech.

Parameters:
NameTypeDescription
secondsnumber

Set the current time of the media to this.

setDefaultMuted(defaultMuted)

Set the value of defaultMuted on the media element. defaultMuted indicates that the current audio level should be silent, but will only effect the muted level on initial playback..

Parameters:
NameTypeDescription
defaultMutedboolean
  • True if the audio should be set to silent - False otherwise
See

setDefaultPlaybackRate() → {number}

Set the value of defaultPlaybackRate on the media element. defaultPlaybackRate indicates the rate at which the media should play back upon initial startup. Changing this value after a video has started will do nothing. Instead you should used Html5#setPlaybackRate.

Example Values:

  • if playbackRate is set to 2, media will play twice as fast.
  • if playbackRate is set to 0.5, media will play half as fast.
See
Returns:

The value of defaultPlaybackRate from the media element. A number indicating the current playback speed of the media, where 1 is normal speed.

Type: 
number

setDisablePictureInPicture(value)

Prevents the browser from suggesting a Picture-in-Picture context menu or to request Picture-in-Picture automatically in some cases.

Parameters:
NameTypeDescription
valueboolean

The true value will disable Picture-in-Picture mode.

See

setIcon(iconName, elopt) → {Element}

Adds an SVG icon element to another element or component.

Parameters:
NameTypeAttributesDefaultDescription
iconNamestring

The name of icon. A list of all the icon names can be found at 'sandbox/svg-icons.html'

elElement<optional>
this.el()

Element to set the title on. Defaults to the current Component's element.

Overrides
Returns:

The newly created icon element.

Type: 
Element

setInterval(fn, interval) → {number}

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
Parameters:
NameTypeDescription
fnComponent~GenericCallback

The function to run every x seconds.

intervalnumber

Execute the specified function every x milliseconds.

Listens to Events:
Returns:

Returns an id that can be used to identify the interval. It can also be be used in Component#clearInterval to clear the interval.

Type: 
number

setLoop(loop)

Set the value of loop on the media element. loop indicates that the media should return to the start of the media and continue playing once it reaches the end.

Parameters:
NameTypeDescription
loopboolean
  • True indicates that playback should seek back to start once the end of a media is reached. - False indicates that playback should not loop back to the start when the end of the media is reached.
See

setMuted(muted)

Set the value of muted on the media element. muted indicates that the current audio level should be silent.

Parameters:
NameTypeDescription
mutedboolean
  • True if the audio should be set to silent - False otherwise
See

setPlaybackRate() → {number}

Set the value of playbackRate on the media element. playbackRate indicates the rate at which the media should play back. Examples:

  • if playbackRate is set to 2, media will play twice as fast.
  • if playbackRate is set to 0.5, media will play half as fast.
See
Returns:

The value of playbackRate from the media element. A number indicating the current playback speed of the media, where 1 is normal speed.

Type: 
number

setPlaysinline(playsinline)

Set the value of playsinline from the media element. playsinline indicates to the browser that non-fullscreen playback is preferred when fullscreen playback is the native default, such as in iOS Safari.

Parameters:
NameTypeDescription
playsinlineboolean
  • True indicates that the media should play inline. - False indicates that the media should not play inline.
See

setPoster(poster)

Set the value of poster on the media element. poster is the url to an image file that can/will be shown when no media data is available.

Parameters:
NameTypeDescription
posterstring

The url to an image that should be used as the poster for the media element.

See

setPreload(preload)

Set the value of preload on the media element. preload indicates what should download before the media is interacted with. It can have the following values:

  • none: nothing should be downloaded
  • metadata: poster and the first few frames of the media may be downloaded to get media dimensions and other metadata
  • auto: allow the media and metadata for the media to be downloaded before interaction
Parameters:
NameTypeDescription
preloadstring

The value of preload to set on the media element. Must be 'none', 'metadata', or 'auto'.

See

setScrubbing(isScrubbing)

Set whether we are scrubbing or not. This is used to decide whether we should use fastSeek or not. fastSeek is used to provide trick play on Safari browsers.

Parameters:
NameTypeDescription
isScrubbingboolean
  • true for we are currently scrubbing - false for we are no longer scrubbing

setSrc(src)

Set the value of src on the media element. src indicates the current Tech~SourceObject for the media.

Parameters:
NameTypeDescription
srcTech~SourceObject

The source object to set as the current source.

See

setTimeout(fn, timeout) → {number}

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.

Parameters:
NameTypeDescription
fnComponent~GenericCallback

The function that will be run after timeout.

timeoutnumber

Timeout in milliseconds to delay before executing the specified function.

Listens to Events:
Returns:

Returns a timeout ID that gets used to identify the timeout. It can also get used in Component#clearTimeout to clear the timeout that was set.

Type: 
number

setVolume(percentAsDecimal)

Set the value of volume on the media element. volume indicates the current audio level as a percentage in decimal form. This means that 1 is 100%, 0.5 is 50%, and so on.

Parameters:
NameTypeDescription
percentAsDecimalnumber

The volume percent as a decimal. Valid range is from 0-1.

See

setupSourcesetHandling_()

Modify the media element so that we can detect when the source is changed. Fires sourceset just after the source has changed

show()

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

Overrides

src(srcopt) → {Tech~SourceObject|undefined}

A getter/setter for the Html5 Tech's source object.

Note: Please use Html5#setSource

Parameters:
NameTypeAttributesDescription
srcTech~SourceObject<optional>

The source object you want to set on the HTML5 techs element.

Deprecated
  • Since version 5.
Returns:
  • The current source object when a source is not passed in. - undefined when setting
Type: 
Tech~SourceObject | undefined

stopTrackingCurrentTime()

Stop the interval function created in Tech#trackCurrentTime so that the timeupdate event is no longer triggered.

Listens to Events:
  • {Tech#event:pause}

stopTrackingProgress()

Turn off the polyfill for progress events that was created in Tech#manualProgressOn Stop manually tracking progress events by clearing the interval that was set in Tech#trackProgress.

supportsFullScreen() → {boolean}

Check if fullscreen is supported on the video el.

Returns:
  • True if fullscreen is supported. - False if fullscreen is not supported.
Type: 
boolean

textTracks() → {TextTrackList}

Returns:
Type: 
TextTrackList

toggleClass(classToToggle, predicateopt)

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

Parameters:
NameTypeAttributesDescription
classToTogglestring

The class to add or remove based on (@link Component#hasClass}

predicateboolean | Dom~predicate<optional>

An Dom~predicate function or a boolean

trackCurrentTime()

Sets up an interval function to track current time and trigger timeupdate every 250 milliseconds.

Listens to Events:
  • Tech#event:play

trackProgress(event)

This is used to trigger a progress event when the buffered percent changes. It sets an interval function that will be called every 500 milliseconds to check if the buffer end percent has changed.

This function is called by Tech#manualProgressOn

Parameters:
NameTypeDescription
eventEvent

The ready event that caused this to run.

Listens to Events:

trigger(event, hashopt)

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.

Parameters:
NameTypeAttributesDescription
eventstring | Event | Object

The name of the event, an Event, or an object with a key of type set to an event name.

hashObject<optional>

Optionally extra argument to pass through to an event listener

Overrides

triggerReady()

Trigger all the ready listeners for this Component.

triggerSourceset(src)

A special function to trigger source set in a way that will allow player to re-trigger if the player or tech are not ready yet.

Parameters:
NameTypeDescription
srcstring

The source string at the time of the source changing.

videoHeight() → {number}

Get the value of videoHeight from the video element. videoHeight indicates the current height of the video in css pixels.

Returns:

The value of videoHeight from the video element. This will be a number in css pixels.

Type: 
number

videoTracks() → {VideoTrackList}

Returns:
Type: 
VideoTrackList

videoWidth() → {number}

Get the value of videoWidth from the video element. videoWidth indicates the current width of the video in css pixels.

Returns:

The value of videoWidth from the video element. This will be a number in css pixels.

Type: 
number

volume() → {number}

Get the value of volume from the media element. volume indicates the current playback volume of audio for a media. volume will be a value from 0 (silent) to 1 (loudest and default).

See
Returns:

The value of volume from the media element. Value will be between 0-1.

Type: 
number

width() → {number}

Get the current width of the HTML5 media element.

Overrides
Returns:

The width of the HTML5 media element.

Type: 
number

(static) canControlPlaybackRate() → {boolean}

Check if the playback rate can be changed in this browser/device.

Returns:
  • True if playback rate can be controlled - False otherwise
Type: 
boolean

(static) canControlVolume() → {boolean}

Check if the volume can be changed in this browser/device. Volume cannot be changed in a lot of mobile devices. Specifically, it can't be changed from 1 on iOS.

Returns:
  • True if volume can be controlled - False otherwise
Type: 
boolean

(static) canMuteVolume() → {boolean}

Check if the volume can be muted in this browser/device. Some devices, e.g. iOS, don't allow changing volume but permits muting/unmuting.

Returns:
  • True if volume can be muted
    • False otherwise
Type: 
boolean

(static) canOverrideAttributes() → {boolean}

Check if we can override a video/audio elements attributes, with Object.defineProperty.

Returns:
  • True if builtin attributes can be overridden - False otherwise
Type: 
boolean

(static) canPlaySource(srcObj, options) → {string}

Check if the tech can support the given source

Parameters:
NameTypeDescription
srcObjObject

The source object

optionsObject

The options passed to the tech

Returns:

'probably', 'maybe', or '' (empty string)

Type: 
string

(static) canPlayType(type) → {string}

Check if the tech can support the given type

Parameters:
NameTypeDescription
typestring

The mimetype to check

Returns:

'probably', 'maybe', or '' (empty string)

Type: 
string

(static) isSupported() → {boolean}

Check if HTML5 media is supported by this browser/device.

Returns:
  • True if HTML5 media is supported. - False if HTML5 media is not supported.
Type: 
boolean

(static) supportsNativeAudioTracks() → {boolean}

Check to see if native AudioTracks are supported by this browser/device

Returns:
  • True if native AudioTracks are supported. - False otherwise
Type: 
boolean

(static) supportsNativeTextTracks() → {boolean}

Check to see if native TextTracks are supported by this browser/device.

Returns:
  • True if native TextTracks are supported. - False otherwise
Type: 
boolean

(static) supportsNativeVideoTracks() → {boolean}

Check to see if native VideoTracks are supported by this browser/device

Returns:
  • True if native VideoTracks are supported. - False otherwise
Type: 
boolean

Events

audiotrackchange

Triggered when tracks are added or removed on the Tech AudioTrackList

Type:

componentresize

Triggered when a component is resized.

Type:

dispose

Triggered when a Component is disposed.

Type:
Properties
NameTypeAttributesDefaultDescription
bubblesboolean<optional>
false

set to false so that the dispose event does not bubble up

progress

See Player#progress

Type:

ready

Triggered when a Component is ready.

Type:

sourceset

Fired when the source is set on the tech causing the media element to reload.

Type:

tap

Triggered when a Component is tapped.

Type:
  • MouseEvent

texttrackchange

Triggered when tracks are added or removed on the Tech TextTrackList

Type:

timeupdate

Trigger timeupdate because we're done seeking and the time has changed. This is particularly useful for if the player is paused to time the time displays.

Type:

videotrackchange

Triggered when tracks are added or removed on the Tech VideoTrackList

Type:

vttjsloaded

Fired when vtt.js is loaded.

Type: