Brightcove Player v5.22.2

Class: Tech

Tech

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

new Tech( [options], ready)

Create an instance of this Tech.

Parameters:
Name Type Argument Description
options Object <optional>

The key/value store of player options.
ready Component~ReadyCallback

Callback function to call when the HTML5 Tech is ready.
Source:
tech/tech.js

Extends

Members

featuresFullscreenResize :boolean

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

Type:
  • boolean
Source:
tech/tech.js

featuresNativeTextTracks :boolean

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

Type:
  • boolean
Source:
tech/tech.js

featuresPlaybackRate :boolean

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
Type:
  • boolean
Source:
tech/tech.js

featuresProgressEvents :boolean

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.

Type:
  • boolean
Source:
tech/tech.js

featuresTimeupdateEvents :boolean

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.

Type:
  • boolean
Source:
tech/tech.js

featuresVolumeControl :boolean

Boolean indicating wether the Tech supports volume control.

Type:
  • boolean
Default Value:
  • true
Source:
tech/tech.js

Methods

<static> getTech(name)

Get a Tech from the shared list by name.

Parameters:
Name Type Description
name string

Name of the component to get
Source:
tech/tech.js
Returns:

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

Type
Tech | undefined

<static> registerTech(name, tech)

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.
Source:
tech/tech.js

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

Parameters:
Name Type Description
_Tech Tech

The tech to add source handler functions to.
Mixes In:
  • Tech~SourceHandlerAdditions
Source:
tech/tech.js

$(selector [, context])

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

Parameters:
Name Type Argument 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.
Inherited From:
Source:
component.js
See:
Returns:

the dom element that was found, or null

Type
Element | null

$$(selector [, context])

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

Parameters:
Name Type Argument 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.
Inherited From:
Source:
component.js
See:
Returns:

a list of dom elements that were found

Type
NodeList

addChild(child [, options] [, index])

Add a child Component inside the current Component.

Parameters:
Name Type Argument 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.
Inherited From:
Source:
component.js
Returns:

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

Type
Component

addClass(classToAdd)

Add a CSS class name to the Components element.

Parameters:
Name Type Description
classToAdd string

CSS class name to add
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

addRemoteTextTrack(options [, manualCleanup])

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 Argument 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
Deprecated:
  • The default functionality for this function will be equivalent to "manualCleanup=false" in the future. The manualCleanup parameter will also be removed.
Source:
tech/tech.js
Returns:

An Html Track Element.

Type
HTMLTrackElement

addTextTrack(kind [, label] [, language])

Create and returns a remote TextTrack object.

Parameters:
Name Type Argument 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
Source:
tech/tech.js
Returns:

The TextTrack that gets created.

Type
TextTrack

addWebVttScript_()

Emulate TextTracks using vtt.js if necessary

Source:
tech/tech.js
Fires:

audioTracks()

Get the Techs AudioTrackList.

Source:
tech/tech.js
Returns:

The audio track list that the Tech is currently using.

Type
AudioTrackList

blur()

Remove the focus from this component

Inherited From:
Source:
component.js

buffered()

Get and create a TimeRange object for buffering.

Source:
tech/tech.js
Returns:

The time range object that was created.

Type
TimeRange

bufferedPercent()

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

Source:
tech/tech.js
Returns:

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

Type
number

<abstract> buildCSSClass()

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

Inherited From:
Source:
component.js
Returns:

The DOM class name for this object.

Type
string

children()

Get an array of all child components

Inherited From:
Source:
component.js
Returns:

The children

Type
Array

cleanupAutoTextTracks()

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

Source:
tech/tech.js

clearInterval(intervalId)

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.
Inherited From:
Source:
component.js
See:
Returns:

Returns the interval id that was cleared.

Type
number

clearTimeout(timeoutId)

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.
Inherited From:
Source:
component.js
See:
Returns:

Returns the timeout id that was cleared.

Type
number

clearTracks(types)

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

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

Parameters:
Name Type Description
types Array.<string> | string

TrackList names to clear, valid names are video, audio, and text.
Source:
tech/tech.js

contentEl()

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.

Inherited From:
Source:
component.js
Returns:

The content element for this Component.

Type
Element

createEl( [tagName] [, properties] [, attributes])

Create the Components DOM element.

Parameters:
Name Type Argument 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.
Inherited From:
Source:
component.js
Returns:

The element that gets created.

Type
Element

createRemoteTextTrack(options)

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 Argument 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.
Source:
tech/tech.js
Returns:

The track element that gets created.

Type
HTMLTrackElement

currentDimension(widthOrHeight)

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.
Inherited From:
Source:
component.js
Returns:

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

Type
number

currentDimensions()

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

Inherited From:
Source:
component.js
Returns:

The dimensions of the components element

Type
Component~DimensionObject

currentHeight()

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

Inherited From:
Source:
component.js
Returns:

height The height of the Components computed style.

Type
number

currentWidth()

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

Inherited From:
Source:
component.js
Returns:

width The width of the Components computed style.

Type
number

dimension(widthOrHeight [, num] [, skipListeners])

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 Argument Description
widthOrHeight string

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

8 New dimension
skipListeners boolean <optional>

Skip resize event trigger
Inherited From:
Source:
component.js
Fires:
Returns:
  • the dimension when getting or 0 if unset
      - Returns itself when setting; method can be chained.
Type
Component

dimensions(width, height)

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

Parameters:
Name Type Description
width number | string

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

Height to set the Components element to.
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

dispose()

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

Overrides:
Source:
tech/tech.js
Fires:

el()

Get the Components DOM element

Inherited From:
Source:
component.js
Returns:

The DOM element for this Component.

Type
Element

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.

Inherited From:
Source:
component.js
Listens to Events:
  • Component#event:touchstart
  • Component#event:touchmove
  • Component#event:touchend
  • Component#event:touchcancel

error( [err])

Get or set an error on the Tech.

Parameters:
Name Type Argument Description
err MediaError <optional>

Error to set on the Tech
Source:
tech/tech.js
Returns:

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

Type
MediaError | null

focus()

Set the focus to this component

Inherited From:
Source:
component.js

getAttribute(attribute)

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.
Inherited From:
Source:
component.js
See:
Returns:
  • 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.
Type
string | null

getChild(name)

Returns the child Component with the given name.

Parameters:
Name Type Description
name string

The name of the child Component to get.
Inherited From:
Source:
component.js
Returns:

The child Component with the given name or undefined.

Type
Component | undefined

getChildById(id)

Returns the child Component with the given id.

Parameters:
Name Type Description
id string

The id of the child Component to get.
Inherited From:
Source:
component.js
Returns:

The child Component with the given id or undefined.

Type
Component | undefined

<abstract> getVideoPlaybackQuality()

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

Source:
tech/tech.js
See:
Returns:

An object with supported media playback quality metrics

Type
Object

hasClass(classToCheck)

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

Parameters:
Name Type Description
classToCheck string

CSS class name to check.
Inherited From:
Source:
component.js
Returns:
  • True if the Component has the class.
      - False if the `Component` does not have the class`
Type
boolean

height( [num] [, skipListeners])

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

Parameters:
Name Type Argument Description
num number | string <optional>

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

Skip the resize event trigger
Inherited From:
Source:
component.js
Returns:
  • The width when getting, zero if there is no width. Can be a string
        postpixed with '%' or 'px'.
  - Returns itself when setting; method can be chained.
Type
Component | number | string

hide()

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

Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

id()

Get this Components ID

Inherited From:
Source:
component.js
Returns:

The id of this Component

Type
string

initChildren()

Add and initialize default child Components based upon options.

Inherited From:
Source:
component.js

initTextTrackListeners()

Turn on listeners for TextTrackList events. This adds EventTarget~EventListeners for texttrackchange, addtrack and removetrack.

Source:
tech/tech.js
Fires:

initTrackListeners()

Turn on listeners for VideoTrackList and {AudioTrackList events. This adds EventTarget~EventListeners for addtrack, and removetrack.

Source:
tech/tech.js
Fires:

localize(string)

Localize a string given the string in english.

Parameters:
Name Type Description
string string

The string to localize.
Inherited From:
Source:
component.js
Returns:

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

Type
string

manualProgressOff()

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

Source:
tech/tech.js

manualProgressOn()

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

Source:
tech/tech.js
See:

manualTimeUpdatesOff()

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

Source:
tech/tech.js

manualTimeUpdatesOn()

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

Source:
tech/tech.js
See:

name()

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

Inherited From:
Source:
component.js
Returns:

The name of this Component.

Type
string

off( [first] [, second] [, third])

Remove an event listener from this Components element. If the second argument is exluded all listeners for the type passed in as the first argument will be removed.

Parameters:
Name Type Argument Description
first string | Component | Array.<string> <optional>

The event name, and array of event names, or another Component.
second EventTarget~EventListener | string | Array.<string> <optional>

The listener function, an event name, or an Array of events names.
third EventTarget~EventListener <optional>

The event handler if first is a Component and second is an event name or an Array of event names.
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

on( [first] [, second] [, third])

Add an event listener to this Components element.

The benefit of using this over the following:

  • VjsEvents.on(otherElement, 'eventName', myFunc)

  • otherComponent.on('eventName', myFunc)

  • Is that the listeners will get cleaned up when either component gets disposed.

  • It will also bind myComponent as the context of myFunc.

    NOTE: If you remove the element from the DOM that has used on you need to

     clean up references using: `myComponent.trigger(el, 'dispose')`
 This will also allow the browser to garbage collect it. In special
 cases such as with `window` and `document`, which are both permanent,
 this is not necessary.
Parameters:
Name Type Argument Description
first string | Component | Array.<string> <optional>

The event name, and array of event names, or another Component.
second EventTarget~EventListener | string | Array.<string> <optional>

The listener function, an event name, or an Array of events names.
third EventTarget~EventListener <optional>

The event handler if first is a Component and second is an event name or an Array of event names.
Inherited From:
Source:
component.js
Listens to Events:
Returns:

Returns itself; method can be chained.

Type
Component

onDurationChange(event)

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

Parameters:
Name Type Description
event EventTarget~Event

The durationchange event that caused this to run.
Source:
tech/tech.js
Listens to Events:
  • Tech#event:durationchange

one( [first] [, second] [, third])

Add an event listener that gets triggered only once and then gets removed.

Parameters:
Name Type Argument Description
first string | Component | Array.<string> <optional>

The event name, and array of event names, or another Component.
second EventTarget~EventListener | string | Array.<string> <optional>

The listener function, an event name, or an Array of events names.
third EventTarget~EventListener <optional>

The event handler if first is a Component and second is an event name or an Array of event names.
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

options(obj)

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.
Inherited From:
Deprecated:
  • since version 5
Source:
component.js
Returns:

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

Type
Object

played()

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.

Source:
tech/tech.js
Returns:
  • A single time range if this video has played
      - An empty set of ranges if not.
Type
TimeRange

player()

Return the Player that the Component has attached to.

Inherited From:
Source:
component.js
Returns:

The player that this Component has attached to.

Type
Player

<abstract> playsinline()

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

Source:
tech/tech.js

ready(fn [, sync])

Bind a listener to the component's ready state. If the ready event has already happened it will trigger the function immediately.

Parameters:
Name Type Argument Default Description
fn Component~ReadyCallback

A function to call when ready is triggered.
sync boolean <optional>
 false

Execute the listener synchronously if Component is ready.
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

remoteTextTrackEls()

Get The Techs {HTMLTrackElementList}, which are the elements in the DOM that are being used as TextTracks.

Source:
tech/tech.js
Returns:

The current HTML track elements that exist for the tech.

Type
HTMLTrackElementList

remoteTextTracks()

Get the Techs remote TextTrackList, which is created from elements that were added to the DOM.

Source:
tech/tech.js
Returns:

The remote text track list that the Tech is currently using.

Type
TextTrackList

removeAttribute(attribute)

Remove an attribute from the Components element.

Parameters:
Name Type Description
attribute string

Name of the attribute to remove.
Inherited From:
Source:
component.js
See:
Returns:

Returns itself; method can be chained.

Type
Component

removeChild(component)

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

Parameters:
Name Type Description
component Component

The child Component to remove.
Inherited From:
Source:
component.js

removeClass(classToRemove)

Remove a CSS class name from the Components element.

Parameters:
Name Type Description
classToRemove string

CSS class name to remove
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

removeRemoteTextTrack(track)

Remove a remote text track from the remote TextTrackList.

Parameters:
Name Type Description
track TextTrack

TextTrack to remove from the TextTrackList
Source:
tech/tech.js

<abstract> reset()

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

Source:
tech/tech.js

setAttribute(attribute, value)

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

Parameters:
Name Type Description
attribute string

Name of the attribute to set.
value string

Value to set the attribute to.
Inherited From:
Source:
component.js
See:
Returns:

Returns itself; method can be chained.

Type
Component

setCurrentTime()

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

Source:
tech/tech.js
Fires:

setInterval(fn, interval)

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.
Inherited From:
Source:
component.js
See:
Listens to Events:
Returns:

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

Type
number

<abstract> setPlaysinline()

A method to set or unset the 'playsinine'

Source:
tech/tech.js

<abstract> setPoster()

A method to set a poster from a Tech.

Source:
tech/tech.js

setTimeout(fn, timeout)

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.
Inherited From:
Source:
component.js
See:
Listens to Events:
Returns:

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.

Type
number

show()

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

Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

stopTrackingCurrentTime()

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

Source:
tech/tech.js
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.

Source:
tech/tech.js

textTracks()

Get the Techs TextTrackList.

Source:
tech/tech.js
Returns:

The text track list that the Tech is currently using.

Type
TextTrackList

toggleClass(classToToggle [, predicate])

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

Parameters:
Name Type Argument 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:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

trackCurrentTime()

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

Source:
tech/tech.js
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

Parameters:
Name Type Description
event EventTarget~Event

The ready event that caused this to run.
Source:
tech/tech.js
Fires:
Listens to Events:

trigger(event [, hash])

Trigger an event on an element.

Parameters:
Name Type Argument Description
event EventTarget~Event | Object | string

The event name, and Event, or an event-like object with a type attribute set to the event name.
hash Object <optional>

Data hash to pass along with the event
Inherited From:
Source:
component.js
Returns:

Returns itself; method can be chained.

Type
Component

triggerReady()

Trigger all the ready listeners for this Component.

Inherited From:
Source:
component.js
Fires:

videoTracks()

Get the Techs VideoTrackList.

Source:
tech/tech.js
Returns:

The video track list that the Tech is currently using.

Type
VideoTrackList

width( [num] [, skipListeners])

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

Parameters:
Name Type Argument Description
num number | string <optional>

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

Skip the resize event trigger
Inherited From:
Source:
component.js
Returns:
  • The width when getting, zero if there is no width. Can be a string
        postpixed with '%' or 'px'.
  - Returns itself when setting; method can be chained.
Type
Component | number | string

Type Definitions

SourceObject

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';
Type:
  • Object | string
Properties:
Name Type Description
src string

The url to the source
type string

The mime type of the source
Source:
tech/tech.js

Events

audiotrackchange

Triggered when tracks are added or removed on the Tech AudioTrackList

Type: EventTarget~Event
Source:
tech/tech.js

dispose

Triggered when a Component is disposed.

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

set to false so that the close event does not bubble up
Inherited From:
Source:
component.js
Listeners of This Event:

progress

See Player#progress

Type: EventTarget~Event
Source:
tech/tech.js

ready

Triggered when a Component is ready.

Type: EventTarget~Event
Inherited From:
Source:
component.js
Listeners of This Event:

resize

Triggered when a component is resized.

Type: EventTarget~Event
Inherited From:
Source:
component.js

tap

Triggered when a Component is tapped.

Type: EventTarget~Event
Inherited From:
Source:
component.js

texttrackchange

Triggered when tracks are added or removed on the Tech TextTrackList

Type: EventTarget~Event
Source:
tech/tech.js

timeupdate

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

Type: EventTarget~Event
Source:
tech/tech.js

timeupdate

A manual timeupdate event.

Type: EventTarget~Event
Source:
tech/tech.js

videotrackchange

Triggered when tracks are added or removed on the Tech VideoTrackList

Type: EventTarget~Event
Source:
tech/tech.js

vttjsloaded

Fired when vtt.js is loaded.

Type: EventTarget~Event
Source:
tech/tech.js

vttjsloaded

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

Type: EventTarget~Event
Source:
tech/tech.js