Html5(optionsopt, ready)

HTML5 Media Controller - Wrapper for HTML5 Media API

new Html5(optionsopt, ready)

Create an instance of this Tech.

Parameters:
Name Type Attributes Description
options Object <optional>

The key/value store of player options.

ready Component~ReadyCallback

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.

Overrides:
Default Value:
  • true

featuresMuteControl :bolean

Boolean indicating whether the Tech supports muting volume.

Overrides:
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.

Overrides:

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
Overrides:

featuresProgressEvents :boolean

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

Overrides:
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.

Overrides:

featuresTimeupdateEvents

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

Overrides:
Default Value:
  • true

featuresVolumeControl :boolean

Boolean indicating whether the Tech supports volume control.

Overrides:
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.

static nativeSourceHandler

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

Properties:
Name Type Description
source Tech~SourceObject

The source object

tech Html5

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:
Name Type Attributes Default Description
selector string

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

context Element | 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.

Returns:
Element | null -

the dom element that was found, or null

Overrides:
See:

$$(selector, contextopt) → {NodeList}

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

Parameters:
Name Type Attributes Default Description
selector string

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

context Element | 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.

Returns:
NodeList -

a list of dom elements that were found

Overrides:
See:

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

Add a child Component inside the current Component.

Parameters:
Name Type Attributes Default Description
child string | Component

The name or instance of a child to add.

options Object <optional>
{}

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

index number <optional>
this.children_.length

The index to attempt to add a child into.

Returns:
Component -

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

Overrides:

addClass(classToAdd)

Add a CSS class name to the Components element.

Parameters:
Name Type Description
classToAdd string

CSS class name to add

Overrides:

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

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

Parameters:
Name Type Attributes Default Description
options Object

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

manualCleanup boolean <optional>
true

if set to false, the TextTrack will be automatically removed from the video element whenever the source changes

Returns:
HTMLTrackElement -

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

Overrides:
Deprecated:
  • The default value of the "manualCleanup" parameter will default to "false" in upcoming versions of Video.js

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

Create and returns a remote TextTrack object.

Parameters:
Name Type Attributes Description
kind string

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

label string <optional>

Label to identify the text track

language string <optional>

Two letter language abbreviation

Returns:
TextTrack -

The TextTrack that gets created.

Overrides:

addWebVttScript_()

Emulate TextTracks using vtt.js if necessary

Fires:
Overrides:

audioTracks() → {AudioTrackList}

Get the AudioTrackList

Returns:
AudioTrackList
Overrides:

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.

Returns:
boolean -
  • 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.
See:

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.

Returns:
TimeRange -

The value of buffered from the media element.

Overrides:
See:

bufferedPercent() → {number}

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

Returns:
number -

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

Overrides:

abstract buildCSSClass() → {string}

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

Returns:
string -

The DOM class name for this object.

Overrides:

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:
Name Type Description
id number

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

Returns:
number -

Returns the rAF ID that was cleared.

Overrides:
See:

children() → {Array}

Get an array of all child components

Returns:
Array -

The children

Overrides:

cleanupAutoTextTracks()

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

Overrides:

clearInterval(intervalId) → {number}

Clears an interval that gets created via window.setInterval or Component#setInterval. If you set an inteval 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:
Name Type Description
intervalId number

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

Returns:
number -

Returns the interval id that was cleared.

Overrides:
See:

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:
Name Type Description
timeoutId number

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

Returns:
number -

Returns the timeout id that was cleared.

Overrides:
See:

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:
Name Type Description
types Array.<string> | string

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

Overrides:

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:
Element -

The content element for this Component.

Overrides:

controls() → {boolean}

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

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

createEl() → {Element}

Create the Html5 Tech's DOM element.

Returns:
Element -

The element that gets created.

Overrides:

createRemoteTextTrack(options) → {HTMLTrackElement}

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

Parameters:
Name Type Description
options Object

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

Properties
Name Type Attributes Description
kind string <optional>

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

label string <optional>

Label to identify the text track

language string <optional>

Two letter language abbreviation.

default boolean <optional>

Default this track to on.

id string <optional>

The internal id to assign this track.

src string <optional>

A source url for the track.

Returns:
HTMLTrackElement -

The track element that gets created.

Overrides:

currentDimension(widthOrHeight) → {number}

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

Uses window.getComputedStyle.

Parameters:
Name Type Description
widthOrHeight string

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

Returns:
number -

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

Overrides:

currentDimensions() → {Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:
Component~DimensionObject -

The computed dimensions of the component's element.

Overrides:

currentHeight() → {number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed height of the component's element.

Overrides:

currentSrc() → {Tech~SourceObject}

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

Returns:
Tech~SourceObject -

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

currentTime() → {number}

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

Returns:
number -

The value of currentTime from the media element.

See:

currentWidth() → {number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:
number -

The computed width of the component's element.

Overrides:

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.

Returns:
boolean -
  • 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
See:

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.
Returns:
number -

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

See:

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

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:
Name Type Attributes Description
widthOrHeight string

8 'width' or 'height'

num number | string <optional>

8 New dimension

skipListeners boolean <optional>

Skip componentresize event trigger

Fires:
Returns:
number -

The dimension when getting or 0 if unset

Overrides:

dimensions(width, height)

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

Parameters:
Name Type Description
width number | string

Width to set the Components element to.

height number | string

Height to set the Components element to.

Overrides:

dispose()

Dispose of HTML5 media element and remove all tracks.

Overrides:

duration() → {number}

Get the current duration of the HTML5 media element.

Returns:
number -

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

el() → {Element}

Get the Components DOM element

Returns:
Element -

The DOM element for this Component.

Overrides:

emulateTextTracks()

Emulate texttracks

Overrides:

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
Overrides:

ended() → {boolean}

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

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

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.

Returns:
MediaError | null -

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

Overrides:
See:

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:
Name Type Description
attribute string

Name of the attribute to get the value from.

Returns:
string | null -
  • 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 attibute does not exist or has no value.
Overrides:
See:

getChild(name) → {Component|undefined}

Returns the child Component with the given name.

Parameters:
Name Type Description
name string

The name of the child Component to get.

Returns:
Component | undefined -

The child Component with the given name or undefined.

Overrides:

getChildById(id) → {Component|undefined}

Returns the child Component with the given id.

Parameters:
Name Type Description
id string

The id of the child Component to get.

Returns:
Component | undefined -

The child Component with the given id or undefined.

Overrides:

getVideoPlaybackQuality() → {Object}

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

Returns:
Object -

An object with supported media playback quality metrics

Overrides:
See:

handleKeyDown(event)

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

Parameters:
Name Type Description
event EventTarget~Event

The keydown event that caused this function to be called.

Overrides:

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:
Name Type Description
event EventTarget~Event

The event that caused this function to be called.

Overrides:

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:
undefined -

returns nothing.

hasClass(classToCheck) → {boolean}

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

Parameters:
Name Type Description
classToCheck string

CSS class name to check.

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

height() → {number}

Get the current height of the HTML5 media element.

Returns:
number -

The height of the HTML5 media element.

Overrides:

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

Returns:
string -

The id of this Component

Overrides:

initChildren()

Add and initialize default child Components based upon options.

Overrides:

initTrackListeners()

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

This adds EventTarget~EventListeners for addtrack, and removetrack.

Fires:
Overrides:

isDisposed() → {boolean}

Determine whether or not this component has been disposed.

Returns:
boolean -

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

Overrides:

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:
Name Type Attributes Description
string string

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

tokens Array.<string> <optional>

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

defaultValue string <optional>

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

Returns:
string -

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

Overrides:

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.

Returns:
boolean -
  • 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.
See:

manualProgressOff()

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

Overrides:

manualProgressOn()

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

Overrides:
See:

manualTimeUpdatesOff()

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

Overrides:

manualTimeUpdatesOn()

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

Overrides:
See:

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.

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

name() → {string}

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

Returns:
string -

The name of this Component.

Overrides:

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:
number -

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

See:

onDurationChange(event)

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

Parameters:
Name Type Description
event EventTarget~Event

The durationchange event that caused this to run.

Listens to Events:
  • Tech#event:durationchange
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:mergeOptions

Parameters:
Name Type Description
obj Object

The object that contains new options.

Returns:
Object -

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

Overrides:

overrideNativeAudioTracks(override)

Attempt to force override of native audio tracks.

Parameters:
Name Type Description
override boolean

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

Overrides:

overrideNativeVideoTracks(override)

Attempt to force override of native video tracks.

Parameters:
Name Type Description
override boolean

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

Overrides:

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.

Returns:
boolean -

The value of paused from the media element.

See:

play()

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

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.
Returns:
number -

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

See:

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.

Returns:
TimeRange -

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

Overrides:
See:

player() → {Player}

Return the Player that the Component has attached to.

Returns:
Player -

The player that this Component has attached to.

Overrides:

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.

Returns:
boolean -
  • 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.
Overrides:
See:

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.

Returns:
string -

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

See:

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
Returns:
string -

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

See:

ready() → {Component}

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:
Component -

Returns itself; method can be chained.

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:
number -

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

See:

remoteTextTrackEls() → {HtmlTrackElementList}

Get the remote element HtmlTrackElementList

Overrides:

remoteTextTracks() → {TextTrackList}

Get the remote element TextTrackList

Returns:
TextTrackList
Overrides:

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to remove.

Overrides:
See:

removeChild(component)

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

Parameters:
Name Type Description
component Component

The child Component to remove.

Overrides:

removeClass(classToRemove)

Remove a CSS class name from the Components element.

Parameters:
Name Type Description
classToRemove string

CSS class name to remove

Overrides:

removeRemoteTextTrack(track)

Remove remote TextTrack from TextTrackList object

Parameters:
Name Type Description
track TextTrack

TextTrack object to remove

Overrides:

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:
Name Type Description
fn Component~GenericCallback

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

Listens to Events:
Returns:
number -

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.

Overrides:
See:

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.

Returns:
Promise -

A promise with a Picture-in-Picture window.

Overrides:
See:

reset()

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

Overrides:

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.

Returns:
TimeRange -

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

See:

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.

Returns:
boolean -
  • 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.
See:

setAttribute(attribute, value)

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

Parameters:
Name Type Description
attribute string

Name of the attribute to set.

value string

Value to set the attribute to.

Overrides:
See:

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:
Name Type Description
autoplay boolean
  • 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:
Name Type Description
val string

Value to set the controls attribute to

setCurrentTime(seconds)

Set current time for the HTML5 tech.

Parameters:
Name Type Description
seconds number

Set the current time of the media to this.

Overrides:

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 intial playback..

Parameters:
Name Type Description
defaultMuted boolean
  • 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.
Returns:
number -

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

See:

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:
Name Type Description
fn Component~GenericCallback

The function to run every x seconds.

interval number

Execute the specified function every x milliseconds.

Listens to Events:
Returns:
number -

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

Overrides:
See:

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:
Name Type Description
loop boolean
  • 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:
Name Type Description
muted boolean
  • 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.
Returns:
number -

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

See:

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:
Name Type Description
playsinline boolean
  • True indicates that the media should play inline. - False indicates that the media should not play inline.
Overrides:
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:
Name Type Description
poster string

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

Overrides:
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:
Name Type Description
preload string

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

See:

setSrc(src)

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

Parameters:
Name Type Description
src Tech~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:
Name Type Description
fn Component~GenericCallback

The function that will be run after timeout.

timeout number

Timeout in milliseconds to delay before executing the specified function.

Listens to Events:
Returns:
number -

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.

Overrides:
See:

setupSourcesetHandling_()

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

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:
Name Type Description
percentAsDecimal number

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

See:

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:
Name Type Attributes Description
src Tech~SourceObject <optional>

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

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

stopTrackingCurrentTime()

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

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

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.

Overrides:

supportsFullScreen() → {boolean}

Check if fullscreen is supported on the current playback device.

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

textTracks() → {TextTrackList}

Get the TextTrackList

Returns:
TextTrackList
Overrides:

toggleClass(classToToggle, predicateopt)

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

Parameters:
Name Type Attributes Description
classToToggle string

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

predicate boolean | Dom~predicate <optional>

An Dom~predicate function or a boolean

Overrides:

trackCurrentTime()

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

Listens to Events:
  • Tech#event:play
Overrides:

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:
Name Type Description
event EventTarget~Event

The ready event that caused this to run.

Fires:
Listens to Events:
Overrides:

triggerReady()

Trigger all the ready listeners for this Component.

Fires:
Overrides:

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:
Name Type Description
src string

The source string at the time of the source changing.

Fires:
Overrides:

videoHeight() → {number}

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

Returns:
number -

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

See:

videoTracks() → {VideoTrackList}

Get the VideoTrackList

Returns:
VideoTrackList
Overrides:

videoWidth() → {number}

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

Returns:
number -

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

See:

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).

Returns:
number -

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

See:

width() → {number}

Get the current width of the HTML5 media element.

Returns:
number -

The width of the HTML5 media element.

Overrides:

static canControlPlaybackRate() → {boolean}

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

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

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:
boolean -
  • True if volume can be controlled - False otherwise

static canMuteVolume() → {bolean}

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:
bolean -
  • True if volume can be muted
    • False otherwise

static canOverrideAttributes() → {boolean}

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

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

static canPlaySource(srcObj, options) → {string}

Check if the tech can support the given source

Parameters:
Name Type Description
srcObj Object

The source object

options Object

The options passed to the tech

Returns:
string -

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

static canPlayType(type) → {string}

Check if the tech can support the given type

Parameters:
Name Type Description
type string

The mimetype to check

Returns:
string -

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

static isSupported() → {boolean}

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

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

static supportsNativeAudioTracks() → {boolean}

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

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

static supportsNativeTextTracks() → {boolean}

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

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

static supportsNativeVideoTracks() → {boolean}

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

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

Events

audiotrackchange

Triggered when tracks are added or removed on the Tech AudioTrackList

Type:
Overrides:

componentresize

Triggered when a component is resized.

Type:
Overrides:

dispose

Triggered when a Component is disposed.

Type:
Properties:
Name Type Attributes Default Description
bubbles boolean <optional>
false

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

Overrides:

progress

See Player#progress

Type:
Overrides:

ready

Triggered when a Component is ready.

Type:
Overrides:

sourceset

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

Type:
Overrides:
See:

tap

Triggered when a Component is tapped.

Type:
Overrides:

texttrackchange

Triggered when tracks are added or removed on the Tech TextTrackList

Type:
Overrides:

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:
Overrides:

videotrackchange

Triggered when tracks are added or removed on the Tech VideoTrackList

Type:
Overrides:

vttjsloaded

Fired when vtt.js is loaded.

Type:
Overrides: