Extends

• Component

Members

featuresFullscreenResize :boolean

tech/tech.js, line 969

Boolean indicating wether the Tech support fullscreen resize control. Resizing plugins using request fullscreen reloads the plugin

featuresNativeTextTracks :boolean

tech/tech.js, line 1009

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

featuresPlaybackRate :boolean

tech/tech.js, line 980

Boolean indicating wether 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, line 990

Boolean indicating wether 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.

featuresTimeupdateEvents :boolean

tech/tech.js, line 1000

Boolean indicating wether 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, line 960

Boolean indicating wether the Tech supports volume control.

Default Value:

• true

Methods

static canPlaySource(srcObj, options) → {string}

tech/tech.js, line 802

Check if the tech can support the given source

Parameters:

Name	Type	Description
srcObj	Object	The source object
options	Object	The options passed to the tech

Returns:

string -

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

static canPlayType(type) → {string}

tech/tech.js, line 790

Check if the type is supported by this tech.

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

Parameters:

Name	Type	Description
type	string	The media type to check

Returns:

string -

Returns the native video element's response

static getTech(name) → {Tech|undefined}

tech/tech.js, line 868

Get a Tech from the shared list by name.

Parameters:

Name	Type	Description
name	string	camelCase or TitleCase name of the Tech to get

Returns:

Tech | undefined -

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

static registerTech(name, tech)

tech/tech.js, line 833

Registers a Tech into a shared list for videojs.

Parameters:

Name	Type	Description
name	string	Name of the Tech to register.
tech	Object	The Tech class to register.

static withSourceHandlers(_Tech)

tech/tech.js, line 1023

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:

Name	Type	Description
_Tech	Tech	The tech to add source handler functions to.

Mixes In:

• Tech~SourceHandlerAdditions

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

component.js, line 675

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

Parameters:

Name	Type	Attributes	Default	Description
selector	string			A valid CSS selector, which will be passed to querySelector.
context	Element | string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:

Element | null -

the dom element that was found, or null

Inherited From:

• Component#$

See:

• Information on CSS Selectors

$$(selector, contextopt) → {NodeList}

component.js, line 697

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

Parameters:

Name	Type	Attributes	Default	Description
selector	string			A valid CSS selector, which will be passed to querySelectorAll.
context	Element | string	<optional>	this.contentEl()	A DOM element within which to query. Can also be a selector string in which case the first matching element will get used as context. If missing this.contentEl() gets used. If this.contentEl() returns nothing it falls back to document.

Returns:

NodeList -

a list of dom elements that were found

Inherited From:

• Component#$$

See:

• Information on CSS Selectors

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

component.js, line 383

Add a child Component inside the current Component.

Parameters:

Name	Type	Attributes	Default	Description
child	string | Component			The name or instance of a child to add.
options	Object	<optional>	{}	The key/value store of options that will get passed to children of the child.
index	number	<optional>	this.children_.length	The index to attempt to add a child into.

Returns:

Component -

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

Inherited From:

• Component#addChild

addClass(classToAdd)

component.js, line 721

Add a CSS class name to the Components element.

Parameters:

Name	Type	Description
classToAdd	string	CSS class name to add

Inherited From:

• Component#addClass

addRemoteTextTrack(options, manualCleanupopt) → {HTMLTrackElement}

tech/tech.js, line 688

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

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

Parameters:

Name	Type	Attributes	Default	Description
options	Object			See Tech#createRemoteTextTrack for more detailed properties.
manualCleanup	boolean	<optional>	true	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:

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, line 631

Create and returns a remote TextTrack object.

Parameters:

Name	Type	Attributes	Description
kind	string		TextTrack kind (subtitles, captions, descriptions, chapters, or metadata)
label	string	<optional>	Label to identify the text track
language	string	<optional>	Two letter language abbreviation

Returns:

TextTrack -

The TextTrack that gets created.

addWebVttScript_()

tech/tech.js, line 511

Emulate TextTracks using vtt.js if necessary

Fires:

• Tech#event:vttjsloaded
• Tech#event:vttjserror

audioTracks() → {AudioTrackList}

tech/tech.js, line 893

Get the AudioTrackList

Returns:

AudioTrackList

blur()

component.js, line 1058

Remove the focus from this component

Inherited From:

• Component#blur

buffered() → {TimeRange}

tech/tech.js, line 243

Get and create a TimeRange object for buffering.

Returns:

TimeRange -

The time range object that was created.

bufferedPercent() → {number}

tech/tech.js, line 255

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, line 592

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

Returns:

string -

The DOM class name for this object.

Inherited From:

• Component#buildCSSClass

cancelAnimationFrame(id) → {number}

component.js, line 1406

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

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

Parameters:

Name	Type	Description
id	number	The rAF ID to clear. The return value of Component#requestAnimationFrame.

Returns:

number -

Returns the rAF ID that was cleared.

Inherited From:

• Component#cancelAnimationFrame

See:

• Similar to

children() → {Array}

component.js, line 329

Get an array of all child components

Returns:

Array -

The children

Inherited From:

• Component#children

cleanupAutoTextTracks()

tech/tech.js, line 385

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

clearInterval(intervalId) → {number}

component.js, line 1336

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

Parameters:

Name	Type	Description
intervalId	number	The id of the interval to clear. The return value of Component#setInterval or window.setInterval.

Returns:

number -

Returns the interval id that was cleared.

Inherited From:

• Component#clearInterval

See:

• Similar to

clearTimeout(timeoutId) → {number}

component.js, line 1275

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

Parameters:

Name	Type	Description
timeoutId	number	The id of the timeout to clear. The return value of Component#setTimeout or window.setTimeout.

Returns:

number -

Returns the timeout id that was cleared.

Inherited From:

• Component#clearTimeout

See:

• Similar to

clearTracks(types)

tech/tech.js, line 363

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

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

Parameters:

Name	Type	Description
types	Array.<string> | string	TrackList names to clear, valid names are video, audio, and text.

contentEl() → {Element}

component.js, line 298

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.

Inherited From:

• Component#contentEl

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

component.js, line 218

Create the Components DOM element.

Parameters:

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

Element -

The element that gets created.

Inherited From:

• Component#createEl

createRemoteTextTrack(options) → {HTMLTrackElement}

tech/tech.js, line 660

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:

Name	Type	Description
options	Object	The object should contain the options to initialize the TextTrack with. Properties Name Type Attributes Description kind string <optional> TextTrack kind (subtitles, captions, descriptions, chapters, or metadata). label string <optional> Label to identify the text track language string <optional> Two letter language abbreviation.

Returns:

HTMLTrackElement -

The track element that gets created.

currentDimension(widthOrHeight) → {number}

component.js, line 973

Get the width or the height of the Component elements computed style. Uses window.getComputedStyle.

Parameters:

Name	Type	Description
widthOrHeight	string	A string containing 'width' or 'height'. Whichever one you want to get.

Returns:

number -

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

Inherited From:

• Component#currentDimension

currentDimensions() → {Component~DimensionObject}

component.js, line 1021

Get an object that contains width and height values of the Components computed style.

Returns:

Component~DimensionObject -

The dimensions of the components element

Inherited From:

• Component#currentDimensions

currentHeight() → {number}

component.js, line 1044

Get the height of the Components computed style. Uses window.getComputedStyle.

Returns:

number -

height The height of the Components computed style.

Inherited From:

• Component#currentHeight

currentWidth() → {number}

component.js, line 1034

Get the width of the Components computed style. Uses window.getComputedStyle.

Returns:

number -

width The width of the Components computed style.

Inherited From:

• Component#currentWidth

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

component.js, line 911

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

Things to know:

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

Parameters:

Name	Type	Attributes	Description
widthOrHeight	string		8 'width' or 'height'
num	number | string	<optional>	8 New dimension
skipListeners	boolean	<optional>	Skip componentresize event trigger

Fires:

• Component#event:componentresize

Returns:

number -

The dimension when getting or 0 if unset

Inherited From:

• Component#dimension

dimensions(width, height)

component.js, line 877

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

Parameters:

Name	Type	Description
width	number | string	Width to set the Components element to.
height	number | string	Height to set the Components element to.

Inherited From:

• Component#dimensions

dispose()

tech/tech.js, line 336

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, line 199

Get the Components DOM element

Returns:

Element -

The DOM element for this Component.

Inherited From:

• Component#el

emulateTextTracks()

tech/tech.js, line 570

Emulate texttracks

enableTouchActivity()

component.js, line 1182

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

Inherited From:

• Component#enableTouchActivity

error(erropt) → {MediaError|null}

tech/tech.js, line 412

Get or set an error on the Tech.

Parameters:

Name	Type	Attributes	Description
err	MediaError	<optional>	Error to set on the Tech

Returns:

MediaError | null -

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

focus()

component.js, line 1051

Set the focus to this component

Inherited From:

• Component#focus

getAttribute(attribute) → {string|null}

component.js, line 801

Get the value of an attribute on the Components element.

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to get the value from.

Returns:

string | null -

• The value of the attribute that was asked for.

    - Can be an empty string on some browsers if the attribute does not exist
      or has no value
    - Most browsers will return null if the attibute does not exist or has
      no value.

Inherited From:

• Component#getAttribute

See:

• DOM API

getChild(name) → {Component|undefined}

component.js, line 355

Returns the child Component with the given name.

Parameters:

Name	Type	Description
name	string	The name of the child Component to get.

Returns:

Component | undefined -

The child Component with the given name or undefined.

Inherited From:

• Component#getChild

getChildById(id) → {Component|undefined}

component.js, line 342

Returns the child Component with the given id.

Parameters:

Name	Type	Description
id	string	The id of the child Component to get.

Returns:

Component | undefined -

The child Component with the given id or undefined.

Inherited From:

• Component#getChildById

abstract getVideoPlaybackQuality() → {Object}

tech/tech.js, line 735

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

hasClass(classToCheck) → {boolean}

component.js, line 711

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

Parameters:

Name	Type	Description
classToCheck	string	CSS class name to check.

Returns:

boolean -

• True if the Component has the class.

    - False if the `Component` does not have the class`

Inherited From:

• Component#hasClass

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

component.js, line 864

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

Parameters:

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

number | string -

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

Inherited From:

• Component#height

hide()

component.js, line 762

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

Inherited From:

• Component#hide

id() → {string}

component.js, line 308

Get this Components ID

Returns:

string -

The id of this Component

Inherited From:

• Component#id

initChildren()

component.js, line 489

Add and initialize default child Components based upon options.

Inherited From:

• Component#initChildren

initTrackListeners()

tech/tech.js, line 466

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

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

component.js, line 260

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 loooks for look like {1} with the index being 1-indexed into the tokens array.

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

Currently, it is used for the progress bar timing.

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

It is then used like so:

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

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

Parameters:

Name	Type	Attributes	Description
string	string		The string to localize and the key to lookup in the language files.
tokens	Array.<string>	<optional>	If the current item has token replacements, provide the tokens here.
defaultValue	string	<optional>	Defaults to string. Can be a default value to use for token replacement if the lookup key is needed to be separate.

Returns:

string -

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

Inherited From:

• Component#localize

manualProgressOff()

tech/tech.js, line 179

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

manualProgressOn()

tech/tech.js, line 166

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

See:

• Tech#trackProgress

manualTimeUpdatesOff()

tech/tech.js, line 285

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

manualTimeUpdatesOn()

tech/tech.js, line 274

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

See:

• Tech#trackCurrentTime

name() → {string}

component.js, line 319

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

Returns:

string -

The name of this Component.

Inherited From:

• Component#name

onDurationChange(event)

tech/tech.js, line 233

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

Parameters:

Name	Type	Description
event	EventTarget~Event	The durationchange event that caused this to run.

Listens to Events:

• Tech#event:durationchange

options(obj) → {Object}

component.js, line 182

Deep merge of options objects with new options.

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

Parameters:

Name	Type	Description
obj	Object	The object that contains new options.

Returns:

Object -

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

Inherited From:

• Component#options

Deprecated:

• since version 5

played() → {TimeRange}

tech/tech.js, line 430

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 wether 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, line 165

Return the Player that the Component has attached to.

Returns:

Player -

The player that this Component has attached to.

Inherited From:

• Component#player

abstract playsinline()

tech/tech.js, line 751

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

ready() → {Component}

component.js, line 606

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.

Inherited From:

• Component#ready

remoteTextTrackEls() → {HtmlTrackElementList}

tech/tech.js, line 914

Get the remote element HtmlTrackElementList

Returns:

HtmlTrackElementList

remoteTextTracks() → {TextTrackList}

tech/tech.js, line 907

Get the remote element TextTrackList

Returns:

TextTrackList

removeAttribute(attribute)

component.js, line 828

Remove an attribute from the Components element.

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to remove.

Inherited From:

• Component#removeAttribute

See:

• DOM API

removeChild(component)

component.js, line 453

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

Parameters:

Name	Type	Description
component	Component	The child Component to remove.

Inherited From:

• Component#removeChild

removeClass(classToRemove)

component.js, line 731

Remove a CSS class name from the Components element.

Parameters:

Name	Type	Description
classToRemove	string	CSS class name to remove

Inherited From:

• Component#removeClass

removeRemoteTextTrack(track)

tech/tech.js, line 715

Remove a remote text track from the remote TextTrackList.

Parameters:

Name	Type	Description
track	TextTrack	TextTrack to remove from the TextTrackList

requestAnimationFrame(fn) → {number}

component.js, line 1373

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

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

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

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

Parameters:

Name	Type	Description
fn	Component~GenericCallback	A function that will be bound to this component and executed just before the browser's next repaint.

Listens to Events:

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

Inherited From:

• Component#requestAnimationFrame

See:

• Similar to

abstract reset()

tech/tech.js, line 401

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

setAttribute(attribute, value)

component.js, line 816

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

Parameters:

Name	Type	Description
attribute	string	Name of the attribute to set.
value	string	Value to set the attribute to.

Inherited From:

• Component#setAttribute

See:

• DOM API

setCurrentTime()

tech/tech.js, line 443

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

Fires:

• Tech#event:timeupdate

setInterval(fn, interval) → {number}

component.js, line 1307

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

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

Parameters:

Name	Type	Description
fn	Component~GenericCallback	The function to run every x seconds.
interval	number	Execute the specified function every x milliseconds.

Listens to Events:

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

Inherited From:

• Component#setInterval

See:

• Similar to

abstract setPlaysinline()

tech/tech.js, line 758

A method to set or unset the 'playsinine'

abstract setPoster()

tech/tech.js, line 744

A method to set a poster from a Tech.

setTimeout(fn, timeout) → {number}

component.js, line 1247

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

Parameters:

Name	Type	Description
fn	Component~GenericCallback	The function that will be run after timeout.
timeout	number	Timeout in milliseconds to delay before executing the specified function.

Listens to Events:

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

Inherited From:

• Component#setTimeout

See:

• Similar to

show()

component.js, line 754

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

Inherited From:

• Component#show

stopTrackingCurrentTime()

tech/tech.js, line 322

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, line 265

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, line 900

Get the TextTrackList

Returns:

TextTrackList

toggleClass(classToToggle, predicateopt)

component.js, line 746

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:

Name	Type	Attributes	Description
classToToggle	string		The class to add or remove based on (@link Component#hasClass}
predicate	boolean | Dom~predicate	<optional>	An Dom~predicate function or a boolean

Inherited From:

• Component#toggleClass

trackCurrentTime()

tech/tech.js, line 299

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, line 199

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

This function is called by Tech#manualProgressOn

Parameters:

Name	Type	Description
event	EventTarget~Event	The ready event that caused this to run.

Fires:

• Tech#event:progress

Listens to Events:

• Tech#event:ready

triggerReady()

component.js, line 630

Trigger all the ready listeners for this Component.

Fires:

• Component#event:ready

Inherited From:

• Component#triggerReady

videoTracks() → {VideoTrackList}

tech/tech.js, line 886

Get the VideoTrackList

Returns:

VideoTrackList

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

component.js, line 846

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

Parameters:

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

number | string -

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

Inherited From:

• Component#width

Type Definitions

SourceObject

tech/tech.js, line 19

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:

Name	Type	Description
src	string	The url to the source
type	string	The mime type of the source

Events

audiotrackchange

tech/tech.js, line 467

Triggered when tracks are added or removed on the Tech AudioTrackList

Type:

• EventTarget~Event

componentresize

component.js, line 929

Triggered when a component is resized.

Type:

• EventTarget~Event

Inherited From:

• Component#event:componentresize

dispose

component.js, line 119

Triggered when a Component is disposed.

Type:

• EventTarget~Event

Listeners of This Event:

• _Tech#disposeSourceHandler

Properties:

Name	Type	Attributes	Default	Description
bubbles	boolean	<optional>	false	set to false so that the close event does not bubble up

Inherited From:

• Component#event:dispose

progress

tech/tech.js, line 207

See Player#progress

Type:

• EventTarget~Event

ready

component.js, line 647

Triggered when a Component is ready.

Type:

• EventTarget~Event

Listeners of This Event:

• Html5#trackProgress
• Tech#trackProgress

Inherited From:

• Component#event:ready

tap

component.js, line 1144

Triggered when a Component is tapped.

Type:

• EventTarget~Event

Inherited From:

• Component#event:tap

texttrackchange

tech/tech.js, line 481

Triggered when tracks are added or removed on the Tech TextTrackList

Type:

• EventTarget~Event

timeupdate

tech/tech.js, line 304

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

Type:

• EventTarget~Event

timeupdate

tech/tech.js, line 446

A manual timeupdate event.

Type:

• EventTarget~Event

timeupdate

control-bar/progress-control/seek-bar.js, line 248

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

videotrackchange

tech/tech.js, line 474

Triggered when tracks are added or removed on the Tech VideoTrackList

Type:

• EventTarget~Event

vttjsloaded

tech/tech.js, line 535

Fired when vtt.js is loaded.

Type:

• EventTarget~Event

vttjsloaded

tech/tech.js, line 544

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

Type:

• EventTarget~Event