new Html5(optionsopt, ready)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 25](https://docs.videojs.com/tech_html5.js.html#line25)

Create an instance of this Tech.

Parameters:

Mixes In:

• Tech~SourceHandlerAdditions

Extends

• Tech

Members

featuresFullscreenResize :boolean

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1260](https://docs.videojs.com/tech_html5.js.html#line1260)

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

• Overrides:

  • Tech#featuresFullscreenResize

  Default Value:

  • true

featuresMuteControl :bolean

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1111](https://docs.videojs.com/tech_tech.js.html#line1111)

Boolean indicating whether the Tech supports muting volume.

• Overrides:

  • Tech#featuresMuteControl

  Default Value:

  • true

featuresNativeTextTracks :boolean

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1172](https://docs.videojs.com/tech_tech.js.html#line1172)

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

• Overrides:

  • Tech#featuresNativeTextTracks

featuresPlaybackRate :boolean

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1131](https://docs.videojs.com/tech_tech.js.html#line1131)

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:

  • Tech#featuresPlaybackRate

featuresProgressEvents :boolean

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1269](https://docs.videojs.com/tech_html5.js.html#line1269)

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

• Overrides:

  • Tech#featuresProgressEvents

  Default Value:

  • true

featuresSourceset :boolean

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1153](https://docs.videojs.com/tech_tech.js.html#line1153)

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:

  • Tech#featuresSourceset

featuresTimeupdateEvents

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1277](https://docs.videojs.com/tech_html5.js.html#line1277)

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

• Overrides:

  • Tech#featuresTimeupdateEvents

  Default Value:

  • true

featuresVolumeControl :boolean

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1103](https://docs.videojs.com/tech_tech.js.html#line1103)

Boolean indicating whether the Tech supports volume control.

• Overrides:

  • Tech#featuresVolumeControl

  Default Value:

  • true

movingMediaElementInDOM :boolean

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1249](https://docs.videojs.com/tech_html5.js.html#line1249)

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

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 2013](https://docs.videojs.com/tech_html5.js.html#line2013)

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

Properties:

Methods

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

[component.js](https://docs.videojs.com/component.js.html), [line 767](https://docs.videojs.com/component.js.html#line767)

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

Parameters:

Returns:

Element | null -

the dom element that was found, or null

• Overrides:

  • Tech#$

  See:

  • Information on CSS Selectors

$$(selector, contextopt) → {NodeList}

[component.js](https://docs.videojs.com/component.js.html), [line 789](https://docs.videojs.com/component.js.html#line789)

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

Parameters:

Returns:

NodeList -

a list of dom elements that were found

• Overrides:

  • Tech#$$

  See:

  • Information on CSS Selectors

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

[component.js](https://docs.videojs.com/component.js.html), [line 458](https://docs.videojs.com/component.js.html#line458)

Add a child Component inside the current Component.

Parameters:

Returns:

Component -

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

• Overrides:

  • Tech#addChild

addClass(classToAdd)

[component.js](https://docs.videojs.com/component.js.html), [line 813](https://docs.videojs.com/component.js.html#line813)

Add a CSS class name to the Components element.

Parameters:

• Overrides:

  • Tech#addClass

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 887](https://docs.videojs.com/tech_html5.js.html#line887)

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

Parameters:

Returns:

HTMLTrackElement -

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

• Overrides:

  • Tech#addRemoteTextTrack

  Deprecated:

  • The default value of the “manualCleanup” parameter will default to “false” in upcoming versions of Video.js

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

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 811](https://docs.videojs.com/tech_html5.js.html#line811)

Create and returns a remote TextTrack object.

Parameters:

Returns:

TextTrack -

The TextTrack that gets created.

• Overrides:

  • Tech#addTextTrack

addWebVttScript_()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 593](https://docs.videojs.com/tech_tech.js.html#line593)

Emulate TextTracks using vtt.js if necessary

Fires:

• Tech#event:vttjsloaded

• Tech#event:vttjserror

• Overrides:

  • Tech#addWebVttScript_

audioTracks() → {AudioTrackList}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1036](https://docs.videojs.com/tech_tech.js.html#line1036)

Get the AudioTrackList

Returns:

AudioTrackList

• Overrides:

  • Tech#audioTracks

autoplay() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1406](https://docs.videojs.com/tech_html5.js.html#line1406)

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:

  • Spec

blur()

[component.js](https://docs.videojs.com/component.js.html), [line 1153](https://docs.videojs.com/component.js.html#line1153)

Remove the focus from this component

• Overrides:

  • Tech#blur

buffered() → {TimeRange}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1586](https://docs.videojs.com/tech_html5.js.html#line1586)

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:

  • Tech#buffered

  See:

  • Spec

bufferedPercent() → {number}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 291](https://docs.videojs.com/tech_tech.js.html#line291)

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:

  • Tech#bufferedPercent

abstract buildCSSClass() → {string}

[component.js](https://docs.videojs.com/component.js.html), [line 684](https://docs.videojs.com/component.js.html#line684)

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

Returns:

string -

The DOM class name for this object.

• Overrides:

  • Tech#buildCSSClass

cancelAnimationFrame(id) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1585](https://docs.videojs.com/component.js.html#line1585)

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:

Returns:

number -

Returns the rAF ID that was cleared.

• Overrides:

  • Tech#cancelAnimationFrame

  See:

  • Similar to

cancelNamedAnimationFrame(name)

[component.js](https://docs.videojs.com/component.js.html), [line 1560](https://docs.videojs.com/component.js.html#line1560)

Cancels a current named animation frame if it exists.

Parameters:

• Overrides:

  • Tech#cancelNamedAnimationFrame

children() → {Array}

[component.js](https://docs.videojs.com/component.js.html), [line 375](https://docs.videojs.com/component.js.html#line375)

Get an array of all child components

Returns:

Array -

The children

• Overrides:

  • Tech#children

cleanupAutoTextTracks()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 421](https://docs.videojs.com/tech_tech.js.html#line421)

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

• Overrides:

  • Tech#cleanupAutoTextTracks

clearInterval(intervalId) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1464](https://docs.videojs.com/component.js.html#line1464)

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:

Returns:

number -

Returns the interval id that was cleared.

• Overrides:

  • Tech#clearInterval

  See:

  • Similar to

clearTimeout(timeoutId) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1408](https://docs.videojs.com/component.js.html#line1408)

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:

Returns:

number -

Returns the timeout id that was cleared.

• Overrides:

  • Tech#clearTimeout

  See:

  • Similar to

clearTracks(types)

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 399](https://docs.videojs.com/tech_tech.js.html#line399)

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:

• Overrides:

  • Tech#clearTracks

contentEl() → {Element}

[component.js](https://docs.videojs.com/component.js.html), [line 344](https://docs.videojs.com/component.js.html#line344)

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:

  • Tech#contentEl

controls() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1420](https://docs.videojs.com/tech_html5.js.html#line1420)

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:

  • Spec

createEl() → {Element}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 362](https://docs.videojs.com/tech_html5.js.html#line362)

Create the Html5 Tech’s DOM element.

Returns:

Element -

The element that gets created.

• Overrides:

  • Tech#createEl

createRemoteTextTrack(options) → {HTMLTrackElement}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 847](https://docs.videojs.com/tech_html5.js.html#line847)

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

Parameters:

Returns:

HTMLTrackElement -

The track element that gets created.

• Overrides:

  • Tech#createRemoteTextTrack

crossOrigin() → {string}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1820](https://docs.videojs.com/tech_html5.js.html#line1820)

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

Returns:

string -

• anonymous indicates that the media should not sent cookies. - use-credentials indicates that the media should sent cookies along the requests.

• Overrides:

  • Tech#crossOrigin

  See:

  • Spec

currentDimension(widthOrHeight) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1066](https://docs.videojs.com/component.js.html#line1066)

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

Uses window.getComputedStyle.

Parameters:

Returns:

number -

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

• Overrides:

  • Tech#currentDimension

currentDimensions() → {Component~DimensionObject}

[component.js](https://docs.videojs.com/component.js.html), [line 1112](https://docs.videojs.com/component.js.html#line1112)

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:

  • Tech#currentDimensions

currentHeight() → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1139](https://docs.videojs.com/component.js.html#line1139)

Get the computed height of the component’s element.

Uses window.getComputedStyle.

Returns:

number -

The computed height of the component’s element.

• Overrides:

  • Tech#currentHeight

currentSrc() → {Tech~SourceObject}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 779](https://docs.videojs.com/tech_html5.js.html#line779)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1574](https://docs.videojs.com/tech_html5.js.html#line1574)

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:

  • Spec

currentWidth() → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1127](https://docs.videojs.com/component.js.html#line1127)

Get the computed width of the component’s element.

Uses window.getComputedStyle.

Returns:

number -

The computed width of the component’s element.

• Overrides:

  • Tech#currentWidth

defaultMuted() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1390](https://docs.videojs.com/tech_html5.js.html#line1390)

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:

  • Spec

defaultPlaybackRate() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1714](https://docs.videojs.com/tech_html5.js.html#line1714)

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:

  • Spec

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

[component.js](https://docs.videojs.com/component.js.html), [line 1003](https://docs.videojs.com/component.js.html#line1003)

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:

Fires:

• Component#event:componentresize

Returns:

number -

The dimension when getting or 0 if unset

• Overrides:

  • Tech#dimension

dimensions(width, height)

[component.js](https://docs.videojs.com/component.js.html), [line 969](https://docs.videojs.com/component.js.html#line969)

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

Parameters:

• Overrides:

  • Tech#dimensions

disablePictureInPicture() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1732](https://docs.videojs.com/tech_html5.js.html#line1732)

Get the value of ‘disablePictureInPicture’ from the video element.

Returns:

boolean -

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

• Overrides:

  • Tech#disablePictureInPicture

  See:

  • Spec

dispose()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 123](https://docs.videojs.com/tech_html5.js.html#line123)

Dispose of HTML5 media element and remove all tracks.

• Overrides:

  • Tech#dispose

duration() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 578](https://docs.videojs.com/tech_html5.js.html#line578)

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}

[component.js](https://docs.videojs.com/component.js.html), [line 237](https://docs.videojs.com/component.js.html#line237)

Get the Components DOM element

Returns:

Element -

The DOM element for this Component.

• Overrides:

  • Tech#el

emulateTextTracks()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 652](https://docs.videojs.com/tech_tech.js.html#line652)

Emulate texttracks

• Overrides:

  • Tech#emulateTextTracks

enableTouchActivity()

[component.js](https://docs.videojs.com/component.js.html), [line 1307](https://docs.videojs.com/component.js.html#line1307)

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:

  • Tech#enableTouchActivity

ended() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1685](https://docs.videojs.com/tech_html5.js.html#line1685)

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:

  • Spec

enterFullScreen()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 688](https://docs.videojs.com/tech_html5.js.html#line688)

Request that the HTML5 Tech enter fullscreen.

error() → {MediaError|null}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1644](https://docs.videojs.com/tech_html5.js.html#line1644)

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:

  • Tech#error

  See:

  • Spec

exitFullScreen()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 718](https://docs.videojs.com/tech_html5.js.html#line718)

Request that the HTML5 Tech exit fullscreen.

focus()

[component.js](https://docs.videojs.com/component.js.html), [line 1146](https://docs.videojs.com/component.js.html#line1146)

Set the focus to this component

• Overrides:

  • Tech#focus

getAttribute(attribute) → {string|null}

[component.js](https://docs.videojs.com/component.js.html), [line 893](https://docs.videojs.com/component.js.html#line893)

Get the value of an attribute on the Components element.

Parameters:

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:

  • Tech#getAttribute

  See:

  • DOM API

getChild(name) → {Component|undefined}

[component.js](https://docs.videojs.com/component.js.html), [line 401](https://docs.videojs.com/component.js.html#line401)

Returns the child Component with the given name.

Parameters:

Returns:

Component | undefined -

The child Component with the given name or undefined.

• Overrides:

  • Tech#getChild

getChildById(id) → {Component|undefined}

[component.js](https://docs.videojs.com/component.js.html), [line 388](https://docs.videojs.com/component.js.html#line388)

Returns the child Component with the given id.

Parameters:

Returns:

Component | undefined -

The child Component with the given id or undefined.

• Overrides:

  • Tech#getChildById

getDescendant(…names) → {Component|undefined}

[component.js](https://docs.videojs.com/component.js.html), [line 423](https://docs.videojs.com/component.js.html#line423)

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:

Returns:

Component | undefined -

The descendant Component following the given descendant names or undefined.

• Overrides:

  • Tech#getDescendant

getVideoPlaybackQuality() → {Object}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 928](https://docs.videojs.com/tech_html5.js.html#line928)

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:

  • Tech#getVideoPlaybackQuality

  See:

  • Spec

handleKeyDown(event)

[component.js](https://docs.videojs.com/component.js.html), [line 1164](https://docs.videojs.com/component.js.html#line1164)

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

Parameters:

• Overrides:

  • Tech#handleKeyDown

handleKeyPress(event)

[component.js](https://docs.videojs.com/component.js.html), [line 1183](https://docs.videojs.com/component.js.html#line1183)

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:

• Overrides:

  • Tech#handleKeyPress

abstract handleLanguagechange()

[component.js](https://docs.videojs.com/component.js.html), [line 335](https://docs.videojs.com/component.js.html#line335)

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

• Overrides:

  • Tech#handleLanguagechange

handleLateInit_() → {undefined}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 449](https://docs.videojs.com/tech_html5.js.html#line449)

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}

[component.js](https://docs.videojs.com/component.js.html), [line 803](https://docs.videojs.com/component.js.html#line803)

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

Parameters:

Returns:

boolean -

• True if the Component has the class. - False if the Component does not have the class`

• Overrides:

  • Tech#hasClass

height() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 623](https://docs.videojs.com/tech_html5.js.html#line623)

Get the current height of the HTML5 media element.

Returns:

number -

The height of the HTML5 media element.

• Overrides:

  • Tech#height

hide()

[component.js](https://docs.videojs.com/component.js.html), [line 854](https://docs.videojs.com/component.js.html#line854)

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

• Overrides:

  • Tech#hide

id() → {string}

[component.js](https://docs.videojs.com/component.js.html), [line 354](https://docs.videojs.com/component.js.html#line354)

Get this Components ID

Returns:

string -

The id of this Component

• Overrides:

  • Tech#id

initChildren()

[component.js](https://docs.videojs.com/component.js.html), [line 581](https://docs.videojs.com/component.js.html#line581)

Add and initialize default child Components based upon options.

• Overrides:

  • Tech#initChildren

initTrackListeners()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 548](https://docs.videojs.com/tech_tech.js.html#line548)

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

This adds EventTarget~EventListeners for addtrack, and removetrack.

Fires:

• Tech#event:audiotrackchange
• Tech#event:videotrackchange

• Tech#event:texttrackchange

• Overrides:

  • Tech#initTrackListeners

isDisposed() → {boolean}

[component.js](https://docs.videojs.com/component.js.html), [line 197](https://docs.videojs.com/component.js.html#line197)

Determine whether or not this component has been disposed.

Returns:

boolean -

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

• Overrides:

  • Tech#isDisposed

load()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1979](https://docs.videojs.com/tech_html5.js.html#line1979)

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

• See:

  • Spec

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

[component.js](https://docs.videojs.com/component.js.html), [line 298](https://docs.videojs.com/component.js.html#line298)

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:

Returns:

string -

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

• Overrides:

  • Tech#localize

loop() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1434](https://docs.videojs.com/tech_html5.js.html#line1434)

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:

  • Spec

manualProgressOff()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 215](https://docs.videojs.com/tech_tech.js.html#line215)

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

• Overrides:

  • Tech#manualProgressOff

manualProgressOn()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 202](https://docs.videojs.com/tech_tech.js.html#line202)

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

• Overrides:

  • Tech#manualProgressOn

  See:

  • Tech#trackProgress

manualTimeUpdatesOff()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 321](https://docs.videojs.com/tech_tech.js.html#line321)

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

• Overrides:

  • Tech#manualTimeUpdatesOff

manualTimeUpdatesOn()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 310](https://docs.videojs.com/tech_tech.js.html#line310)

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

• Overrides:

  • Tech#manualTimeUpdatesOn

  See:

  • Tech#trackCurrentTime

muted() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1376](https://docs.videojs.com/tech_html5.js.html#line1376)

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:

  • Spec

name() → {string}

[component.js](https://docs.videojs.com/component.js.html), [line 365](https://docs.videojs.com/component.js.html#line365)

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:

  • Tech#name

networkState() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1758](https://docs.videojs.com/tech_html5.js.html#line1758)

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:

  • https://www.w3.org/TR/html5/embedded-content-0.html#dom-media-networkstate

onDurationChange(event)

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 269](https://docs.videojs.com/tech_tech.js.html#line269)

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

Parameters:

Listens to Events:

• Tech#event:durationchange

• Overrides:

  • Tech#onDurationChange

options(obj) → {Object}

[component.js](https://docs.videojs.com/component.js.html), [line 222](https://docs.videojs.com/component.js.html#line222)

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:

Returns:

Object -

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

• Overrides:

  • Tech#options

overrideNativeAudioTracks(override)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 247](https://docs.videojs.com/tech_html5.js.html#line247)

Attempt to force override of native audio tracks.

Parameters:

• Overrides:

  • Tech#overrideNativeAudioTracks

overrideNativeVideoTracks(override)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 257](https://docs.videojs.com/tech_html5.js.html#line257)

Attempt to force override of native video tracks.

Parameters:

• Overrides:

  • Tech#overrideNativeVideoTracks

pause()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1970](https://docs.videojs.com/tech_html5.js.html#line1970)

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

• See:

  • Spec

paused() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1562](https://docs.videojs.com/tech_html5.js.html#line1562)

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:

  • Spec

play()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1988](https://docs.videojs.com/tech_html5.js.html#line1988)

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

• Overrides:

  • Tech#play

  See:

  • Spec

playbackRate() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1699](https://docs.videojs.com/tech_html5.js.html#line1699)

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:

  • Spec

played() → {TimeRange}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1745](https://docs.videojs.com/tech_html5.js.html#line1745)

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:

  • Tech#played

  See:

  • Spec

player() → {Player}

[component.js](https://docs.videojs.com/component.js.html), [line 207](https://docs.videojs.com/component.js.html#line207)

Return the Player that the Component has attached to.

Returns:

Player -

The player that this Component has attached to.

• Overrides:

  • Tech#player

playsinline() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1451](https://docs.videojs.com/tech_html5.js.html#line1451)

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:

  • Tech#playsinline

  See:

  • Spec

poster() → {string}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1612](https://docs.videojs.com/tech_html5.js.html#line1612)

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:

  • Spec

preload() → {string}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1625](https://docs.videojs.com/tech_html5.js.html#line1625)

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:

  • Spec

ready() → {Component}

[component.js](https://docs.videojs.com/component.js.html), [line 698](https://docs.videojs.com/component.js.html#line698)

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:

  • Tech#ready

readyState() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1775](https://docs.videojs.com/tech_html5.js.html#line1775)

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:

  • https://www.w3.org/TR/html5/embedded-content-0.html#ready-states

remoteTextTrackEls() → {HtmlTrackElementList}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1057](https://docs.videojs.com/tech_tech.js.html#line1057)

Get the remote element HtmlTrackElementList

Returns:

HtmlTrackElementList

• Overrides:

  • Tech#remoteTextTrackEls

remoteTextTracks() → {TextTrackList}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1050](https://docs.videojs.com/tech_tech.js.html#line1050)

Get the remote element TextTrackList

Returns:

TextTrackList

• Overrides:

  • Tech#remoteTextTracks

removeAttribute(attribute)

[component.js](https://docs.videojs.com/component.js.html), [line 920](https://docs.videojs.com/component.js.html#line920)

Remove an attribute from the Components element.

Parameters:

• Overrides:

  • Tech#removeAttribute

  See:

  • DOM API

removeChild(component)

[component.js](https://docs.videojs.com/component.js.html), [line 542](https://docs.videojs.com/component.js.html#line542)

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

Parameters:

• Overrides:

  • Tech#removeChild

removeClass(classToRemove)

[component.js](https://docs.videojs.com/component.js.html), [line 823](https://docs.videojs.com/component.js.html#line823)

Remove a CSS class name from the Components element.

Parameters:

• Overrides:

  • Tech#removeClass

removeRemoteTextTrack(track)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 903](https://docs.videojs.com/tech_html5.js.html#line903)

Remove remote TextTrack from TextTrackList object

Parameters:

• Overrides:

  • Tech#removeRemoteTextTrack

requestAnimationFrame(fn) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1498](https://docs.videojs.com/component.js.html#line1498)

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:

Listens to Events:

• Component#event:dispose

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:

  • Tech#requestAnimationFrame

  See:

  • Similar to

requestNamedAnimationFrame(name, fn)

[component.js](https://docs.videojs.com/component.js.html), [line 1534](https://docs.videojs.com/component.js.html#line1534)

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

Parameters:

• Overrides:

  • Tech#requestNamedAnimationFrame

requestPictureInPicture() → {Promise}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 737](https://docs.videojs.com/tech_html5.js.html#line737)

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:

  • Tech#requestPictureInPicture

  See:

  • Spec

reset()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 767](https://docs.videojs.com/tech_html5.js.html#line767)

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

• Overrides:

  • Tech#reset

scrubbing() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 549](https://docs.videojs.com/tech_html5.js.html#line549)

Get whether we are scrubbing or not.

Returns:

boolean -

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

• Overrides:

  • Tech#scrubbing

seekable() → {TimeRange}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1672](https://docs.videojs.com/tech_html5.js.html#line1672)

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:

  • Spec

seeking() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1658](https://docs.videojs.com/tech_html5.js.html#line1658)

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:

  • Spec

setAttribute(attribute, value)

[component.js](https://docs.videojs.com/component.js.html), [line 908](https://docs.videojs.com/component.js.html#line908)

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

Parameters:

• Overrides:

  • Tech#setAttribute

  See:

  • DOM API

setAutoplay(autoplay)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1502](https://docs.videojs.com/tech_html5.js.html#line1502)

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:

• See:

  • Spec

setControls(val)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 792](https://docs.videojs.com/tech_html5.js.html#line792)

Set controls attribute for the HTML5 media Element.

Parameters:

setCrossOrigin(crossOrigin)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1947](https://docs.videojs.com/tech_html5.js.html#line1947)

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:

• Overrides:

  • Tech#setCrossOrigin

  See:

  • Spec

setCurrentTime(seconds)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 559](https://docs.videojs.com/tech_html5.js.html#line559)

Set current time for the HTML5 tech.

Parameters:

• Overrides:

  • Tech#setCurrentTime

setDefaultMuted(defaultMuted)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1489](https://docs.videojs.com/tech_html5.js.html#line1489)

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:

• See:

  • Spec

setDefaultPlaybackRate() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1917](https://docs.videojs.com/tech_html5.js.html#line1917)

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:

  • Spec

setDisablePictureInPicture(value)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1935](https://docs.videojs.com/tech_html5.js.html#line1935)

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

Parameters:

• Overrides:

  • Tech#setDisablePictureInPicture

  See:

  • Spec

setInterval(fn, interval) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1437](https://docs.videojs.com/component.js.html#line1437)

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:

Listens to Events:

• Component#event:dispose

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:

  • Tech#setInterval

  See:

  • Similar to

setLoop(loop)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1515](https://docs.videojs.com/tech_html5.js.html#line1515)

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:

• See:

  • Spec

setMuted(muted)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1476](https://docs.videojs.com/tech_html5.js.html#line1476)

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

Parameters:

• See:

  • Spec

setPlaybackRate() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1902](https://docs.videojs.com/tech_html5.js.html#line1902)

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:

  • Spec

setPlaysinline(playsinline)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1531](https://docs.videojs.com/tech_html5.js.html#line1531)

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:

• Overrides:

  • Tech#setPlaysinline

  See:

  • Spec

setPoster(poster)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1870](https://docs.videojs.com/tech_html5.js.html#line1870)

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:

• Overrides:

  • Tech#setPoster

  See:

  • Spec

setPreload(preload)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1883](https://docs.videojs.com/tech_html5.js.html#line1883)

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:

• See:

  • Spec

setScrubbing(isScrubbing)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 538](https://docs.videojs.com/tech_html5.js.html#line538)

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:

• Overrides:

  • Tech#setScrubbing

setSrc(src)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1858](https://docs.videojs.com/tech_html5.js.html#line1858)

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

Parameters:

• See:

  • Spec

setTimeout(fn, timeout) → {number}

[component.js](https://docs.videojs.com/component.js.html), [line 1372](https://docs.videojs.com/component.js.html#line1372)

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:

Listens to Events:

• Component#event:dispose

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:

  • Tech#setTimeout

  See:

  • Similar to

setupSourcesetHandling_()

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 138](https://docs.videojs.com/tech_html5.js.html#line138)

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

setVolume(percentAsDecimal)

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1845](https://docs.videojs.com/tech_html5.js.html#line1845)

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:

• See:

  • [Spec]Spec

show()

[component.js](https://docs.videojs.com/component.js.html), [line 846](https://docs.videojs.com/component.js.html#line846)

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

• Overrides:

  • Tech#show

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

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 754](https://docs.videojs.com/tech_html5.js.html#line754)

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

Note: Please use Html5#setSource

Parameters:

Returns:

Tech~SourceObject | undefined -

• The current source object when a source is not passed in. - undefined when setting

• Deprecated:

  • Since version 5.

stopTrackingCurrentTime()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 358](https://docs.videojs.com/tech_tech.js.html#line358)

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

Listens to Events:

• {Tech#event:pause}

• Overrides:

  • Tech#stopTrackingCurrentTime

stopTrackingProgress()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 301](https://docs.videojs.com/tech_tech.js.html#line301)

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:

  • Tech#stopTrackingProgress

supportsFullScreen() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 673](https://docs.videojs.com/tech_html5.js.html#line673)

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}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1043](https://docs.videojs.com/tech_tech.js.html#line1043)

Get the TextTrackList

Returns:

TextTrackList

• Overrides:

  • Tech#textTracks

toggleClass(classToToggle, predicateopt)

[component.js](https://docs.videojs.com/component.js.html), [line 838](https://docs.videojs.com/component.js.html#line838)

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

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

Parameters:

• Overrides:

  • Tech#toggleClass

trackCurrentTime()

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 335](https://docs.videojs.com/tech_tech.js.html#line335)

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

Listens to Events:

• Tech#event:play

• Overrides:

  • Tech#trackCurrentTime

trackProgress(event)

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 235](https://docs.videojs.com/tech_tech.js.html#line235)

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:

Fires:

• Tech#event:progress

Listens to Events:

• Tech#event:ready

• Overrides:

  • Tech#trackProgress

triggerReady()

[component.js](https://docs.videojs.com/component.js.html), [line 722](https://docs.videojs.com/component.js.html#line722)

Trigger all the ready listeners for this Component.

Fires:

• Component#event:ready

• Overrides:

  • Tech#triggerReady

triggerSourceset(src)

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 173](https://docs.videojs.com/tech_tech.js.html#line173)

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:

Fires:

• Tech#event:sourceset

• Overrides:

  • Tech#triggerSourceset

videoHeight() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1807](https://docs.videojs.com/tech_html5.js.html#line1807)

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:

  • [Spec] https://www.w3.org/TR/html5/embedded-content-0.html#dom-video-videowidth

videoTracks() → {VideoTrackList}

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 1029](https://docs.videojs.com/tech_tech.js.html#line1029)

Get the VideoTrackList

Returns:

VideoTrackList

• Overrides:

  • Tech#videoTracks

videoWidth() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1794](https://docs.videojs.com/tech_html5.js.html#line1794)

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:

  • [Spec] https://www.w3.org/TR/html5/embedded-content-0.html#dom-video-videowidth

volume() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1599](https://docs.videojs.com/tech_html5.js.html#line1599)

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:

  • [Spec]Spec

width() → {number}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 613](https://docs.videojs.com/tech_html5.js.html#line613)

Get the current width of the HTML5 media element.

Returns:

number -

The width of the HTML5 media element.

• Overrides:

  • Tech#width

static canControlPlaybackRate() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1075](https://docs.videojs.com/tech_html5.js.html#line1075)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1029](https://docs.videojs.com/tech_html5.js.html#line1029)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1050](https://docs.videojs.com/tech_html5.js.html#line1050)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1100](https://docs.videojs.com/tech_html5.js.html#line1100)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1016](https://docs.videojs.com/tech_html5.js.html#line1016)

Check if the tech can support the given source

Parameters:

Returns:

string -

‘probably’, ‘maybe’, or ‘’ (empty string)

static canPlayType(type) → {string}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1003](https://docs.videojs.com/tech_html5.js.html#line1003)

Check if the tech can support the given type

Parameters:

Returns:

string -

‘probably’, ‘maybe’, or ‘’ (empty string)

static isSupported() → {boolean}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 985](https://docs.videojs.com/tech_html5.js.html#line985)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1146](https://docs.videojs.com/tech_html5.js.html#line1146)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1124](https://docs.videojs.com/tech_html5.js.html#line1124)

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}

[tech/html5.js](https://docs.videojs.com/tech_html5.js.html), [line 1135](https://docs.videojs.com/tech_html5.js.html#line1135)

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

Returns:

boolean -

• True if native VideoTracks are supported. - False otherwise

Events

audiotrackchange

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 549](https://docs.videojs.com/tech_tech.js.html#line549)

Triggered when tracks are added or removed on the Tech AudioTrackList

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:audiotrackchange

componentresize

[component.js](https://docs.videojs.com/component.js.html), [line 1021](https://docs.videojs.com/component.js.html#line1021)

Triggered when a component is resized.

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:componentresize

dispose

[component.js](https://docs.videojs.com/component.js.html), [line 145](https://docs.videojs.com/component.js.html#line145)

Triggered when a Component is disposed.

Type:

• EventTarget~Event

Properties:

• Overrides:

  • Tech#event:dispose

progress

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 243](https://docs.videojs.com/tech_tech.js.html#line243)

See Player#progress

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:progress

ready

[component.js](https://docs.videojs.com/component.js.html), [line 739](https://docs.videojs.com/component.js.html#line739)

Triggered when a Component is ready.

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:ready

sourceset

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 180](https://docs.videojs.com/tech_tech.js.html#line180)

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

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:sourceset

  See:

  • Player#event:sourceset

tap

[component.js](https://docs.videojs.com/component.js.html), [line 1269](https://docs.videojs.com/component.js.html#line1269)

Triggered when a Component is tapped.

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:tap

texttrackchange

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 563](https://docs.videojs.com/tech_tech.js.html#line563)

Triggered when tracks are added or removed on the Tech TextTrackList

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:texttrackchange

timeupdate

[control-bar/progress-control/seek-bar.js](https://docs.videojs.com/control-bar_progress-control_seek-bar.js.html), [line 363](https://docs.videojs.com/control-bar_progress-control_seek-bar.js.html#line363)

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:

• EventTarget~Event

• Overrides:

  • Tech#event:timeupdate

videotrackchange

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 556](https://docs.videojs.com/tech_tech.js.html#line556)

Triggered when tracks are added or removed on the Tech VideoTrackList

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:videotrackchange

vttjsloaded

[tech/tech.js](https://docs.videojs.com/tech_tech.js.html), [line 617](https://docs.videojs.com/tech_tech.js.html#line617)

Fired when vtt.js is loaded.

Type:

• EventTarget~Event

• Overrides:

  • Tech#event:vttjsloaded