OpenTV Player Web HTML5

OpenTV Player Web HTML5

Class: Tech

Tech

This is the base class for media playback technology controllers, such as HTML5

new Tech(options, ready)

Create an instance of this Tech.

Name Type Description
options Object optional

The key/value store of player options.
ready function optional

Callback function to call when the HTML5 Tech is ready.

Extends

Members

featuresFullscreenResizeboolean

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

featuresMuteControlboolean

Boolean indicating whether the Tech supports muting volume.

Default Value:
  • true

featuresNativeTextTracksboolean

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

featuresPlaybackRateboolean

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

featuresProgressEventsboolean

Boolean indicating whether the Tech supports the progress event. This will be used to determine if Tech#manualProgressOn should be called.

featuresSourcesetboolean

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.

featuresTimeupdateEventsboolean

Boolean indicating whether the Tech supports the timeupdate event. This will be used to determine if Tech#manualTimeUpdates should be called.

featuresVideoFrameCallbackboolean

Boolean indicating whether the Tech supports requestVideoFrameCallback.

featuresVolumeControlboolean

Boolean indicating whether the Tech supports volume control.

Default Value:
  • true

Methods

staticTech.canPlaySource(srcObj, options){string}

Check if the tech can support the given source

Name Type Description
srcObj Object

The source object
options Object

The options passed to the tech
Returns:
Type Description
string 'probably', 'maybe', or '' (empty string)

staticTech.canPlayType(_type){string}

Check if the type is supported by this tech.

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

Name Type Description
_type string

The media type to check
Returns:
Type Description
string Returns the native video element's response

staticTech.getTech(name){Tech|undefined}

Get a Tech from the shared list by name.

Name Type Description
name string

camelCase or TitleCase name of the Tech to get
Returns:
Type Description
Tech | undefined The Tech or undefined if there was no tech with the name requested.

staticTech.registerTech(name, tech)

Registers a Tech into a shared list for videojs.

Name Type Description
name string

Name of the Tech to register.
tech Object

The Tech class to register.

staticTech.withSourceHandlers(_Tech)

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

Name Type Description
_Tech Tech

The tech to add source handler functions to.

inherited overrides $(selector, context){Element|null}

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

Name Type Default Description
selector string

A valid CSS selector, which will be passed to querySelector.
context Element | string this.contentEl() optional

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.
See:
Returns:
Type Description
Element | null the dom element that was found, or null

inherited overrides $$(selector, context){NodeList}

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

Name Type Default Description
selector string

A valid CSS selector, which will be passed to querySelectorAll.
context Element | string this.contentEl() optional

A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.
See:
Returns:
Type Description
NodeList a list of dom elements that were found

inherited overrides addChild(child, options, index){Component}

Add a child Component inside the current Component.

Name Type Default Description
child string | Component

The name or instance of a child to add.
options Object {} optional

The key/value store of options that will get passed to children of the child.
index number this.children_.length optional

The index to attempt to add a child into.
Returns:
Type Description
Component The Component that gets added as a child. When using a string the Component will get created by this process.

inherited overrides addClass(classesToAdd)

Add a CSS class name to the Components element.

Name Type Description
classesToAdd string repeatable

One or more CSS class name to add.

addRemoteTextTrack(options, manualCleanup){HTMLTrackElement}

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

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

Name Type Default Description
options Object

See Tech#createRemoteTextTrack for more detailed properties.
manualCleanup boolean false optional
  • When false: the TextTrack will be automatically removed from the video element whenever the source changes - When True: The TextTrack will have to be cleaned up manually
Returns:
Type Description
HTMLTrackElement An Html Track Element.

addTextTrack(kind, label, language){TextTrack}

Create and returns a remote TextTrack object.

Name Type Description
kind string

TextTrack kind (subtitles, captions, descriptions, chapters, or metadata)
label string optional

Label to identify the text track
language string optional

Two letter language abbreviation
Returns:
Type Description
TextTrack The TextTrack that gets created.

addWebVttScript_()

Emulate TextTracks using vtt.js if necessary

Fires:

inherited overrides any(type, fn)

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

Name Type Description
type string | Array.<string>

An event name or an array of event names.
fn function

The function to be called once for each event name.

audioTracks(){AudioTrackList}

Get the AudioTrackList

Returns:
Type Description
AudioTrackList

inherited overrides blur()

Remove the focus from this component

buffered(){TimeRange}

Get and create a TimeRange object for buffering.

Returns:
Type Description
TimeRange The time range object that was created.

bufferedPercent(){number}

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

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

inherited overrides abstractbuildCSSClass(){string}

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

Returns:
Type Description
string The DOM class name for this object.

inherited overrides cancelAnimationFrame(id){number}

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

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

Name Type Description
id number

The rAF ID to clear. The return value of Component#requestAnimationFrame.
See:
Returns:
Type Description
number Returns the rAF ID that was cleared.

inherited overrides cancelNamedAnimationFrame(name)

Cancels a current named animation frame if it exists.

Name Type Description
name string

The name of the requestAnimationFrame to cancel.

cancelVideoFrameCallback(id)

A fallback implementation of cancelVideoFrameCallback

Name Type Description
id number

id of callback to be cancelled

abstractcanPlayType(_type){string}

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

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

Name Type Description
_type string

The mimetype to check for support
See:
Returns:
Type Description
string 'probably', 'maybe', or empty string

inherited overrides children(){Array}

Get an array of all child components

Returns:
Type Description
Array The children

cleanupAutoTextTracks()

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

inherited overrides clearInterval(intervalId){number}

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

Name Type Description
intervalId number

The id of the interval to clear. The return value of Component#setInterval or window.setInterval.
See:
Returns:
Type Description
number Returns the interval id that was cleared.

inherited overrides clearTimeout(timeoutId){number}

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

Name Type Description
timeoutId number

The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.
See:
Returns:
Type Description
number Returns the timeout id that was cleared.

clearTracks(types)

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

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

Name Type Description
types Array.<string> | string

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

inherited overrides contentEl(){Element}

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

Returns:
Type Description
Element The content element for this Component.

inherited overrides createEl(tagName, properties, attributes){Element}

Create the Components DOM element.

Name Type Description
tagName string optional

Element's DOM node type. e.g. 'div'
properties Object optional

An object of properties that should be set.
attributes Object optional

An object of attributes that should be set.
Returns:
Type Description
Element The element that gets created.

createRemoteTextTrack(options){HTMLTrackElement}

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.

Name Type Description
options Object

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

Name Type Description
kind string optional

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

Label to identify the text track
language string optional

Two letter language abbreviation.
Returns:
Type Description
HTMLTrackElement The track element that gets created.

abstractcrossOrigin()

Get the value of crossOrigin from the tech.

See:

inherited overrides currentDimension(widthOrHeight){number}

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

Uses window.getComputedStyle.

Name Type Description
widthOrHeight string

A string containing 'width' or 'height'. Whichever one you want to get.
Returns:
Type Description
number The dimension that gets asked for or 0 if nothing was set for that dimension.

inherited overrides currentDimensions(){Component~DimensionObject}

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

Uses window.getComputedStyle.

Returns:
Type Description
Component~DimensionObject The computed dimensions of the component's element.

inherited overrides currentHeight(){number}

Get the computed height of the component's element.

Uses window.getComputedStyle.

Returns:
Type Description
number The computed height of the component's element.

inherited overrides currentWidth(){number}

Get the computed width of the component's element.

Uses window.getComputedStyle.

Returns:
Type Description
number The computed width of the component's element.

inherited overrides dimension(widthOrHeight, num, skipListeners){number|undefined}

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

Things to know:

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

8 'width' or 'height'
num number | string optional

8 New dimension
skipListeners boolean optional

Skip componentresize event trigger
Fires:
Returns:
Type Description
number | undefined The dimension when getting or 0 if unset

inherited overrides dimensions(width, height)

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

Name Type Description
width number | string

Width to set the Components element to.
height number | string

Height to set the Components element to.

abstractdisablePictureInPicture()

A method to check for the value of the 'disablePictureInPicture'

overrides dispose()

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

Fires:

inherited overrides el(){Element}

Get the Components DOM element

Returns:
Type Description
Element The DOM element for this Component.

inherited overrides protectedemitTapEvents()

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

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

emulateTextTracks()

Emulate texttracks

inherited overrides enableTouchActivity()

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

Report user touch activity when touch events occur. User activity gets used to determine when controls should show/hide. It is simple when it comes to mouse events, because any mouse event should show the controls. So we capture mouse events that bubble up to the player and report activity when that happens. With touch events it isn't as easy as touchstart and touchend toggle player controls. So touch events can't help us at the player level either.

User activity gets checked asynchronously. So what could happen is a tap event on the video turns the controls off. Then the touchend event bubbles up to the player. Which, if it reported user activity, would turn the controls right back on. We also don't want to completely block touch events from bubbling up. Furthermore a touchmove event and anything other than a tap, should not turn controls back on.

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

error(err){MediaError|null}

Get or set an error on the Tech.

Name Type Description
err MediaError optional

Error to set on the Tech
Returns:
Type Description
MediaError | null The current error object on the tech, or null if there isn't one.

inherited overrides focus()

Set the focus to this component

inherited overrides getAttribute(attribute){string|null}

Get the value of an attribute on the Components element.

Name Type Description
attribute string

Name of the attribute to get the value from.
See:
Returns:
Type Description
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 attribute does not exist or has no value.

inherited overrides getChild(name){Component|undefined}

Returns the child Component with the given name.

Name Type Description
name string

The name of the child Component to get.
Returns:
Type Description
Component | undefined The child Component with the given name or undefined.

inherited overrides getChildById(id){Component|undefined}

Returns the child Component with the given id.

Name Type Description
id string

The id of the child Component to get.
Returns:
Type Description
Component | undefined The child Component with the given id or undefined.

inherited overrides getDescendant(names){Component|undefined}

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

Name Type Description
names ...Array.<string> | string repeatable

The name of the child Component to get.
Returns:
Type Description
Component | undefined The descendant Component following the given descendant names or undefined.

inherited overrides getIsAvailableToBeFocused(el){boolean}

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

Name Type Description
el HTMLElement

The HTML element representing the component.
Returns:
Type Description
boolean If the component can is currently visible & enabled, will be true. Otherwise, false.

inherited overrides getIsFocusable(el){boolean}

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

Name Type Description
el HTMLElement

The HTML element representing the component.
Returns:
Type Description
boolean If the component can be focused, will be true. Otherwise, false.

inherited overrides getPositions(){Object}

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

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

abstractgetVideoPlaybackQuality(){Object}

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

See:
Returns:
Type Description
Object An object with supported media playback quality metrics

inherited overrides handleKeyDown(event)

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

Name Type Description
event KeyboardEvent

The keydown event that caused this function to be called.

inherited overrides handleKeyPress(event)

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

Name Type Description
event KeyboardEvent

The event that caused this function to be called.

inherited overrides abstracthandleLanguagechange()

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

inherited overrides hasClass(classToCheck){boolean}

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

Name Type Description
classToCheck string

CSS class name to check.
Returns:
Type Description
boolean
  • True if the Component has the class. - False if the Component does not have the class`

inherited overrides height(num, skipListeners){number|undefined}

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

Name Type Description
num number | string optional

The height that you want to set postfixed with '%', 'px' or nothing.
skipListeners boolean optional

Skip the componentresize event trigger
Returns:
Type Description
number | undefined The height when getting, zero if there is no height

inherited overrides hide()

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

inherited overrides id(){string}

Get this Components ID

Returns:
Type Description
string The id of this Component

inherited overrides initChildren()

Add and initialize default child Components based upon options.

initTrackListeners()

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

This adds EventTarget~EventListeners for addtrack, and removetrack.

Fires:

inherited overrides isDisposed(){boolean}

Determine whether or not this component has been disposed.

Returns:
Type Description
boolean If the component has been disposed, will be true. Otherwise, false.

inherited overrides localize(string, tokens, defaultValue){string}

Localize a string given the string in english.

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

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

Currently, it is used for the progress bar timing.

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

It is then used like so:

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

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

Name Type Description
string string

The string to localize and the key to lookup in the language files.
tokens Array.<string> optional

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

Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.
Returns:
Type Description
string The localized string or if no localization exists the english string.

manualProgressOff()

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

manualProgressOn()

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

See:

manualTimeUpdatesOff()

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

manualTimeUpdatesOn()

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

See:

inherited overrides name(){string}

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

Returns:
Type Description
string The name of this Component.

inherited overrides off(type, fn)

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

Name Type Description
type string | Array.<string>

An event name or an array of event names.
fn function optional

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

inherited overrides on(type, fn)

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

Name Type Description
type string | Array.<string>

An event name or an array of event names.
fn function

The function to call with EventTargets

onDurationChange(event)

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

Name Type Description
event Event

The durationchange event that caused this to run.
Listens to Events:
  • Tech#event:durationchange

inherited overrides one(type, fn)

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

Name Type Description
type string | Array.<string>

An event name or an array of event names.
fn function

The function to be called once for each event name.

inherited overrides options(obj){Object}

Deep merge of options objects with new options.

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

Name Type Description
obj Object

The object that contains new options.
Returns:
Type Description
Object A new object of this.options_ and obj merged together.

abstractoverrideNativeAudioTracks(override)

Attempt to force override of native audio tracks.

Name Type Description
override boolean

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

abstractoverrideNativeVideoTracks(override)

Attempt to force override of native video tracks.

Name Type Description
override boolean

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

abstractplay()

Start playback

See:

played(){TimeRange}

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:
Type Description
TimeRange
  • A single time range if this video has played - An empty set of ranges if not.

inherited overrides player(){Player}

Return the Player that the Component has attached to.

Returns:
Type Description
Player The player that this Component has attached to.

abstractplaysinline()

A method to check for the presence of the 'playsinline'

inherited overrides ready(fn)

Bind a listener to the component's ready state. Different from event listeners in that if the ready event has already happened it will trigger the function immediately.

Name Type Description
fn ReadyCallback

Function that gets called when the Component is ready.

remoteTextTrackEls(){HtmlTrackElementList}

Get the remote element HtmlTrackElementList

Returns:
Type Description
HtmlTrackElementList

remoteTextTracks(){TextTrackList}

Get the remote element TextTrackList

Returns:
Type Description
TextTrackList

inherited overrides removeAttribute(attribute)

Remove an attribute from the Components element.

Name Type Description
attribute string

Name of the attribute to remove.
See:

inherited overrides removeChild(component)

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

Name Type Description
component Component

The child Component to remove.

inherited overrides removeClass(classesToRemove)

Remove a CSS class name from the Components element.

Name Type Description
classesToRemove string repeatable

One or more CSS class name to remove.

removeRemoteTextTrack(track)

Remove a remote text track from the remote TextTrackList.

Name Type Description
track TextTrack

TextTrack to remove from the TextTrackList

inherited overrides requestAnimationFrame(fn){number}

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

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

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

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

Name Type Description
fn Component~GenericCallback

A function that will be bound to this component and executed just before the browser's next repaint.
See:
Listens to Events:
Returns:
Type Description
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.

inherited overrides requestNamedAnimationFrame(name, fn)

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

Name Type Description
name string

The name to give this requestAnimationFrame
fn Component~GenericCallback

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

abstractrequestPictureInPicture(){Promise|undefined}

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.

See:
Returns:
Type Description
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.

requestVideoFrameCallback(cb){number}

A fallback implementation of requestVideoFrameCallback using requestAnimationFrame

Name Type Description
cb function
Returns:
Type Description
number request id

abstractreset()

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

abstractscrubbing()

Get whether we are scrubbing or not

See:

inherited overrides setAttribute(attribute, value)

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

Name Type Description
attribute string

Name of the attribute to set.
value string

Value to set the attribute to.
See:

abstractsetCrossOrigin(crossOrigin)

Set the value of crossOrigin on the tech.

Name Type Description
crossOrigin string

the crossOrigin value
See:

setCurrentTime(_seconds)

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

Name Type Description
_seconds number

Set the current time of the media to this.
Fires:

abstractsetDisablePictureInPicture()

A method to set or unset the 'disablePictureInPicture'

inherited overrides setIcon(iconName, el){Element}

Adds an SVG icon element to another element or component.

Name Type Default Description
iconName string

The name of icon. A list of all the icon names can be found at 'sandbox/svg-icons.html'
el Element this.el() optional

Element to set the title on. Defaults to the current Component's element.
Returns:
Type Description
Element The newly created icon element.

inherited overrides setInterval(fn, interval){number}

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

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

The function to run every x seconds.
interval number

Execute the specified function every x milliseconds.
See:
Listens to Events:
Returns:
Type Description
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.

abstractsetPlaysinline()

A method to set or unset the 'playsinline'

abstractsetPoster()

A method to set a poster from a Tech.

abstractsetScrubbing(_isScrubbing)

Set whether we are scrubbing or not

Name Type Description
_isScrubbing boolean
  • true for we are currently scrubbing - false for we are no longer scrubbing
See:

inherited overrides setTimeout(fn, timeout){number}

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

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

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

Name Type Description
fn Component~GenericCallback

The function that will be run after timeout.
timeout number

Timeout in milliseconds to delay before executing the specified function.
See:
Listens to Events:
Returns:
Type Description
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.

inherited overrides show()

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

stopTrackingCurrentTime()

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

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

stopTrackingProgress()

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

textTracks(){TextTrackList}

Get the TextTrackList

Returns:
Type Description
TextTrackList

inherited overrides toggleClass(classToToggle, predicate)

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

Name Type Description
classToToggle string

The class to add or remove based on (@link Component#hasClass}
predicate boolean | Dom~predicate optional

An Dom~predicate function or a boolean

trackCurrentTime()

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

Listens to Events:
  • Tech#event:play

trackProgress(event)

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

This function is called by Tech#manualProgressOn

Name Type Description
event Event

The ready event that caused this to run.
Fires:
Listens to Events:

inherited overrides trigger(event, hash)

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

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

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

Name Type Description
event string | Event | Object

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

Optionally extra argument to pass through to an event listener

inherited overrides triggerReady()

Trigger all the ready listeners for this Component.

Fires:

triggerSourceset(src)

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

Name Type Description
src string

The source string at the time of the source changing.
Fires:

videoTracks(){VideoTrackList}

Get the VideoTrackList

Returns:
Type Description
VideoTrackList

inherited overrides width(num, skipListeners){number|undefined}

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

Name Type Description
num number | string optional

The width that you want to set postfixed with '%', 'px' or nothing.
skipListeners boolean optional

Skip the componentresize event trigger
Returns:
Type Description
number | undefined The width when getting, zero if there is no width

Events

audiotrackchange

Triggered when tracks are added or removed on the Tech AudioTrackList

Type:

inherited overrides componentresize

Triggered when a component is resized.

Type:

inherited overrides dispose

Triggered when a Component is disposed.

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

set to false so that the dispose event does not bubble up
Listeners of This Event:

progress

See Player#progress

Type:

inherited overrides ready

Triggered when a Component is ready.

Type:
Listeners of This Event:

sourceset

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

Type:
See:

inherited overrides tap

Triggered when a Component is tapped.

Type:
  • MouseEvent

texttrackchange

Triggered when tracks are added or removed on the Tech TextTrackList

Type:

timeupdate

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

Type:

timeupdate

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

Type:

timeupdate

A manual timeupdate event.

Type:

videotrackchange

Triggered when tracks are added or removed on the Tech VideoTrackList

Type:

vttjsloaded

Fired when vtt.js is loaded.

Type:

vttjsloaded

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

Type: