OpenTV Player Web HTML5

Class: VideoTrack

VideoTrack

A representation of a single VideoTrack.

new VideoTrack(options)

Create an instance of this class.

Name Type Default Description

options

Object

{}

optional

Object of option names and values

Name	Type	Default	Description
`kind`	string	''	optional A valid `VideoTrack~Kind`
`id`	string	'vjs_track_' + Guid.newGUID()	optional A unique id for this AudioTrack.
`label`	string	''	optional The menu label for this track.
`language`	string	''	optional A valid two character language code.
`selected`	boolean		optional If this track is the one that is currently playing.

See:

Spec

Extends

Track

Members

inherited overrides protected allowedEvents_

An object containing event names as keys and booleans as values.

NOTE: If an event name is set to a true value here EventTarget#trigger will have extra functionality. See that function for more information.

Properties:

Name	Type	Description
`EventTarget.prototype.allowedEvents_`

inherited overrides readonly idstring

The id of this track. Cannot be changed after creation.

inherited overrides readonly kindstring

The kind of track that this is. Cannot be changed after creation.

inherited overrides labelstring

The label of this track. Cannot be changed after creation.

inherited overrides readonly languagestring

The two letter language code for this track. Cannot be changed after creation.

selectedboolean

If this VideoTrack is selected or not. When setting this will fire VideoTrack#selectedchange if the state of selected changed.

Methods

inherited overrides addEventListener()

An alias of EventTarget#on. Allows EventTarget to mimic the standard DOM API.

See:

EventTarget#on

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.

inherited overrides dispatchEvent()

An alias of EventTarget#trigger. Allows EventTarget to mimic the standard DOM API.

See:

EventTarget#trigger

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	The function to remove.

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 `EventTarget`s

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 removeEventListener()

An alias of EventTarget#off. Allows EventTarget to mimic the standard DOM API.

See:

EventTarget#off

inherited overrides trigger(event)

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 \| EventTarget~Event \| Object	The name of the event, an `Event`, or an object with a key of type set to an event name.

Type Definitions

Kind

All possible VideoTrackKinds

See:

https://html.spec.whatwg.org/multipage/embedded-content.html#dom-videotrack-kind

Events

inherited overrides labelchange

An event that fires when label changes on this track.

Note: This is not part of the spec!

Type:

Event

selectedchange

An event that fires when selected changes on this track. This allows the VideoTrackList that holds this track to act accordingly.

Note: This is not part of the spec! Native tracks will do this internally without an event.

Type:

Event