new Tech(optionsopt, ready)

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

Create an instance of this Tech.

Parameters:

Extends

• Component

Members

featuresFullscreenResize :boolean

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

Boolean indicating whether the Tech supports fullscreen resize control. Resizing plugins using request fullscreen reloads the plugin

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.

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

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

featuresProgressEvents :boolean

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

Boolean indicating whether the Tech supports the progress event. This is currently not triggered by video-js-swf. This will be used to determine if Tech#manualProgressOn should be called.

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.

featuresTimeupdateEvents :boolean

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

Boolean indicating whether the Tech supports the timeupdate event. This is currently not triggered by video-js-swf. This will be used to determine if Tech#manualTimeUpdates should be called.

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.

• Default Value:

  • true

Methods

static canPlaySource(srcObj, options) → {string}

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

Check if the tech can support the given source

Parameters:

Returns:

string -

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

static canPlayType(type) → {string}

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

Check if the type is supported by this tech.

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

Parameters:

Returns:

string -

Returns the native video element’s response

static getTech(name) → {Tech|undefined}

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

Get a Tech from the shared list by name.

Parameters:

Returns:

Tech | undefined -

The Tech or undefined if there was no tech with the name requested.

static registerTech(name, tech)

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

Registers a Tech into a shared list for videojs.

Parameters:

static withSourceHandlers(_Tech)

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

A functional mixin for techs that want to use the Source Handler pattern. Source handlers are scripts for handling specific formats. The source handler pattern is used for adaptive formats (HLS, DASH) that manually load video data and feed it into a Source Buffer (Media Source Extensions) Example: Tech.withSourceHandlers.call(MyTech);

Parameters:

• Mixes In:

  • Tech~SourceHandlerAdditions

$(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:

  • Component#$

  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:

  • Component#$$

  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:

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

  • Component#addClass

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

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

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

Note: This can be an emulated HTMLTrackElement or a native one.

Parameters:

Returns:

HTMLTrackElement -

An Html Track Element.

• Deprecated:

  • The default functionality for this function will be equivalent to “manualCleanup=false” in the future. The manualCleanup parameter will also be removed.

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

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

Create and returns a remote TextTrack object.

Parameters:

Returns:

TextTrack -

The TextTrack that gets created.

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

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

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:

  • Component#blur

buffered() → {TimeRange}

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

Get and create a TimeRange object for buffering.

Returns:

TimeRange -

The time range object that was created.

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.

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:

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

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

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

  • Component#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

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:

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

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

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:

  • Component#contentEl

createEl(tagNameopt, propertiesopt, attributesopt) → {Element}

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

Create the Components DOM element.

Parameters:

Returns:

Element -

The element that gets created.

• Overrides:

  • Component#createEl

createRemoteTextTrack(options) → {HTMLTrackElement}

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

Create an emulated TextTrack for use by addRemoteTextTrack

This is intended to be overridden by classes that inherit from Tech in order to create native or custom TextTracks.

Parameters:

Returns:

HTMLTrackElement -

The track element that gets created.

abstract crossOrigin()

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

Get the value of crossOrigin from the tech.

• See:

  • {Html5#crossOrigin}

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:

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

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

  • Component#currentHeight

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:

  • Component#currentWidth

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:

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

  • Component#dimensions

abstract disablePictureInPicture()

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

A method to check for the value of the ‘disablePictureInPicture’ property. Defaults to true, as it should be considered disabled if the tech does not support pip

dispose()

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

Turn off all event polyfills, clear the Techs AudioTrackList, VideoTrackList, and TextTrackList, and dispose of this Tech.

Fires:

• Component#event:dispose

• Overrides:

  • Component#dispose

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:

  • Component#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

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:

  • Component#enableTouchActivity

error(erropt) → {MediaError|null}

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

Get or set an error on the Tech.

Parameters:

Returns:

MediaError | null -

The current error object on the tech, or null if there isn’t one.

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:

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

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

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

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

  • Component#getDescendant

abstract getVideoPlaybackQuality() → {Object}

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

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

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

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

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

  • Component#handleLanguagechange

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:

  • Component#hasClass

height(numopt, skipListenersopt) → {number|string}

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

Get or set the height of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Returns:

number | string -

The width when getting, zero if there is no width. Can be a string postpixed with ‘%’ or ‘px’.

• Overrides:

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

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

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

  • Component#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

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:

  • Component#isDisposed

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:

  • Component#localize

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

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.

• 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

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.

• See:

  • Tech#trackCurrentTime

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:

  • Component#name

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

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:

  • Component#options

abstract overrideNativeAudioTracks(override)

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

Attempt to force override of native audio tracks.

Parameters:

abstract overrideNativeVideoTracks(override)

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

Attempt to force override of native video tracks.

Parameters:

abstract play()

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

Start playback

• See:

  • {Html5#play}

played() → {TimeRange}

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

Returns the TimeRanges that have been played through for the current source.

NOTE: This implementation is incomplete. It does not track the played TimeRange. It only checks whether the source has played at all or not.

Returns:

TimeRange -

• A single time range if this video has played - An empty set of ranges if not.

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:

  • Component#player

abstract playsinline()

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

A method to check for the presence of the ‘playsinline’ attribute.

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:

  • Component#ready

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

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

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:

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

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

  • Component#removeClass

removeRemoteTextTrack(track)

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

Remove a remote text track from the remote TextTrackList.

Parameters:

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:

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

  • Component#requestNamedAnimationFrame

abstract requestPictureInPicture() → {Promise|undefined}

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

Attempt to 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 | undefined -

A promise with a Picture-in-Picture window if the browser supports Promises (or one was passed in as an option). It returns undefined otherwise.

• See:

  • Spec

abstract reset()

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

Reset the tech, which will removes all sources and reset the internal readyState.

abstract scrubbing()

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

Get whether we are scrubbing or not

• See:

  • {Html5#scrubbing}

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:

  • Component#setAttribute

  See:

  • DOM API

abstract setCrossOrigin(crossOrigin)

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

Set the value of crossOrigin on the tech.

Parameters:

• See:

  • {Html5#setCrossOrigin}

setCurrentTime()

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

Causes a manual time update to occur if Tech#manualTimeUpdatesOn was previously called.

Fires:

• Tech#event:timeupdate

abstract setDisablePictureInPicture()

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

A method to set or unset the ‘disablePictureInPicture’ property.

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:

  • Component#setInterval

  See:

  • Similar to

abstract setPlaysinline()

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

A method to set or unset the ‘playsinline’ attribute.

abstract setPoster()

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

A method to set a poster from a Tech.

abstract setScrubbing()

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

Set whether we are scrubbing or not

• See:

  • {Html5#setScrubbing}

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:

  • Component#setTimeout

  See:

  • Similar to

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:

  • Component#show

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}

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.

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

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:

  • Component#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

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

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:

  • Component#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

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

width(numopt, skipListenersopt) → {number|string}

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

Get or set the width of the component based upon the CSS styles. See Component#dimension for more detailed information.

Parameters:

Returns:

number | string -

The width when getting, zero if there is no width. Can be a string postpixed with ‘%’ or ‘px’.

• Overrides:

  • Component#width

Type Definitions

SourceObject

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

An Object containing a structure like: {src: 'url', type: 'mimetype'} or string that just contains the src url alone.

• var SourceObject = {src: 'http://ex.com/video.mp4', type: 'video/mp4'}; var SourceString = 'http://example.com/some-video.mp4';

Properties:

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

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:

  • Component#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

Listeners of This Event:

• _Tech#disposeSourceHandler

Properties:

• Overrides:

  • Component#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

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

Listeners of This Event:

• Html5#trackProgress

• Tech#trackProgress

• Overrides:

  • Component#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

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

  • Component#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

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

timeupdate

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

Triggered at an interval of 250ms to indicated that time is passing in the video.

Type:

• EventTarget~Event

timeupdate

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

A manual timeupdate event.

Type:

• EventTarget~Event

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

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

vttjsloaded

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

Fired when vtt.js was not loaded due to an error

Type:

• EventTarget~Event