Tech

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

Boolean indicating whether the Tech supports muting volume.

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

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

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

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.

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

Boolean indicating whether the Tech supports requestVideoFrameCallback.

Boolean indicating whether the Tech supports volume control.

Check if the tech can support the given source

Check if the type is supported by this tech.

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

Get a Tech from the shared list by name.

Registers a Tech into a shared list for videojs.

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

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

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

Add a child Component inside the current Component.

Add a CSS class name to the Components element.

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

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

Create and returns a remote TextTrack object.

Emulate TextTracks using vtt.js if necessary

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.

Get the AudioTrackList

Remove the focus from this component

Get and create a TimeRange object for buffering.

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

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

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!

Cancels a current named animation frame if it exists.

A fallback implementation of cancelVideoFrameCallback

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

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

Get an array of all child components

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

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!

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!

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!

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.

Create the Components DOM element.

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.

Get the value of crossOrigin from the tech.

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

Uses window.getComputedStyle.

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

Uses window.getComputedStyle.

Get the computed height of the component's element.

Uses window.getComputedStyle.

Get the computed width of the component's element.

Uses window.getComputedStyle.

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

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

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

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

Get the Components DOM element

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.

Emulate texttracks

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.

Get or set an error on the Tech.

Set the focus to this component

Get the value of an attribute on the Components element.

Returns the child Component with the given name.

Returns the child Component with the given id.

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.

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

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

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

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

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

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.

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

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

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

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

Get this Components ID

Add and initialize default child Components based upon options.

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

This adds EventTarget~EventListeners for addtrack, and removetrack.

Determine whether or not this component has been disposed.

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.

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

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

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

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

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

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.

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.

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

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.

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

Attempt to force override of native audio tracks.

Attempt to force override of native video tracks.

Start playback

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.

Return the Player that the Component has attached to.

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

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.

Get the remote element HtmlTrackElementList

Get the remote element TextTrackList

Remove an attribute from the Components element.

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

Remove a CSS class name from the Components element.

Remove a remote text track from the remote TextTrackList.

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.

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

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.

A fallback implementation of requestVideoFrameCallback using requestAnimationFrame

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

Get whether we are scrubbing or not

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

Set the value of crossOrigin on the tech.

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

A method to set or unset the 'disablePictureInPicture'

Adds an SVG icon element to another element or component.

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

A method to set or unset the 'playsinline'

A method to set a poster from a Tech.

Set whether we are scrubbing or not

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.

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

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

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.

Get the TextTrackList

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.

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

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

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.

Trigger all the ready listeners for this Component.

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.

Get the VideoTrackList

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

Triggered when tracks are added or removed on the Tech AudioTrackList

Triggered when a component is resized.

Triggered when a Component is disposed.

See Player#progress

Triggered when a Component is ready.

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

Triggered when a Component is tapped.

Triggered when tracks are added or removed on the Tech TextTrackList

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.

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

A manual timeupdate event.

Triggered when tracks are added or removed on the Tech VideoTrackList

Fired when vtt.js is loaded.

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