Html5

Boolean indicating whether the HTML5 tech currently supports automatic media resize when going into fullscreen.

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 HTML5 tech currently supports the progress event. If this is false, manual progress events will be triggered instead.

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 HTML5 tech currently supports the timeupdate event. If this is false, manual timeupdate events will be triggered instead.

Whether the HTML5 el supports requestVideoFrameCallback

Boolean indicating whether the Tech supports volume control.

Boolean indicating whether the HTML5 tech currently supports the media element moving in the DOM. iOS breaks if you move the media element, so this is set this to false there. Everywhere else this should be true.

Native source handler for Html5, simply passes the source to the media element.

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.

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

Get the value of autoplay from the media element. autoplay indicates that the media should start to play as soon as the page is ready.

Remove the focus from this component

Get the value of buffered from the media element. buffered is a TimeRange object that represents the parts of the media that are already downloaded and available for playback.

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.

Native or fallback requestVideoFrameCallback

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.

Get the value of controls from the media element. controls indicates whether the native media controls should be shown or hidden.

Create the Html5 Tech's DOM element.

Creates either native TextTrack or an emulated TextTrack depending on the value of featuresNativeTextTracks

Get the value of crossOrigin from the media element. crossOrigin indicates to the browser that should sent the cookies along with the requests for the different assets/playlists

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 current source on the HTML5 Tech. Falls back to returning the source from the HTML5 media element.

Get the value of currentTime from the media element. currentTime indicates the current second that the media is at in playback.

Get the computed width of the component's element.

Uses window.getComputedStyle.

Get the value of defaultMuted from the media element. defaultMuted indicates whether the media should start muted or not. Only changes the default state of the media. muted and defaultMuted can have different values. Html5#muted indicates the current state.

Get the value of defaultPlaybackRate from the media element. defaultPlaybackRate indicates the rate at which the media is currently playing back. This value will not indicate the current playbackRate after playback has started, use Html5#playbackRate for that.

Examples:

• if defaultPlaybackRate is set to 2, media will play twice as fast.
• if defaultPlaybackRate is set to 0.5, media will play half as fast.

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.

Get the value of 'disablePictureInPicture' from the video element.

Dispose of HTML5 media element and remove all tracks.

Get the current duration of the HTML5 media element.

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 the value of ended from the media element. ended indicates whether the media has reached the end or not.

Request that the HTML5 Tech enter fullscreen.

Get the value of the error from the media element. error indicates any MediaError that may have occurred during playback. If error returns null there is no current error.

Request that the HTML5 Tech exit fullscreen.

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.

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.

This will be triggered if the loadstart event has already fired, before videojs was ready. Two known examples of when this can happen are:

1. If we're loading the playback object after it has started loading
2. The media is already playing the (often with autoplay on) then

This function will fire another loadstart so that videojs can catchup.

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

Get the current height of the HTML5 media element.

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.

A wrapper around the media elements load function. This will call the HTML5s media element load function.

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.

Get the value of loop from the media element. loop indicates that the media should return to the start of the media and continue playing once it reaches the end.

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 value of muted from the media element. muted indicates that the volume for the media should be set to silent. This does not actually change the volume attribute.

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

Get the value of networkState from the media element. networkState indicates the current network state. It returns an enumeration from the following list:

• 0: NETWORK_EMPTY
• 1: NETWORK_IDLE
• 2: NETWORK_LOADING
• 3: NETWORK_NO_SOURCE

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.

A wrapper around the media elements pause function. This will call the HTML5 media elements pause function.

Get the value of paused from the media element. paused indicates whether the media element is currently paused or not.

A wrapper around the media elements play function. This will call the HTML5s media element play function.

Get the value of playbackRate from the media element. playbackRate indicates the rate at which the media is currently playing back. Examples:

• if playbackRate is set to 2, media will play twice as fast.
• if playbackRate is set to 0.5, media will play half as fast.

Get the value of played from the media element. played returns a TimeRange object representing points in the media timeline that have been played.

Return the Player that the Component has attached to.

Get the value of playsinline from the media element. playsinline indicates to the browser that non-fullscreen playback is preferred when fullscreen playback is the native default, such as in iOS Safari.

Get the value of poster from the media element. poster indicates that the url of an image file that can/will be shown when no media data is available.

Get the value of preload from the media element. preload indicates what should download before the media is interacted with. It can have the following values:

• none: nothing should be downloaded
• metadata: poster and the first few frames of the media may be downloaded to get media dimensions and other metadata
• auto: allow the media and metadata for the media to be downloaded before interaction

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 value of readyState from the media element. readyState indicates the current state of the media element. It returns an enumeration from the following list:

• 0: HAVE_NOTHING
• 1: HAVE_METADATA
• 2: HAVE_CURRENT_DATA
• 3: HAVE_FUTURE_DATA
• 4: HAVE_ENOUGH_DATA

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 remote TextTrack from TextTrackList object

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.

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.

Native requestVideoFrameCallback if supported by browser/tech, or fallback Don't use rVCF on Safari when DRM is playing, as it doesn't fire Needs to be checked later than the constructor This will be a false positive for clear sources loaded after a Fairplay source

Reset the tech by removing all sources and then calling Html5.resetMediaElement.

Get whether we are scrubbing or not.

Get the value of seekable from the media element. seekable returns a TimeRange object indicating ranges of time that can currently be seeked to.

Get the value of seeking from the media element. seeking indicates whether the media is currently seeking to a new position or not.

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

Set the value of autoplay on the media element. autoplay indicates that the media should start to play as soon as the page is ready.

Set controls attribute for the HTML5 media Element.

Set the value of crossOrigin from the media element. crossOrigin indicates to the browser that should sent the cookies along with the requests for the different assets/playlists

Set current time for the HTML5 tech.

Set the value of defaultMuted on the media element. defaultMuted indicates that the current audio level should be silent, but will only effect the muted level on initial playback..

Set the value of defaultPlaybackRate on the media element. defaultPlaybackRate indicates the rate at which the media should play back upon initial startup. Changing this value after a video has started will do nothing. Instead you should used Html5#setPlaybackRate.

Example Values:

• if playbackRate is set to 2, media will play twice as fast.
• if playbackRate is set to 0.5, media will play half as fast.

Prevents the browser from suggesting a Picture-in-Picture context menu or to request Picture-in-Picture automatically in some cases.

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

Set the value of loop on the media element. loop indicates that the media should return to the start of the media and continue playing once it reaches the end.

Set the value of muted on the media element. muted indicates that the current audio level should be silent.

Set the value of playbackRate on the media element. playbackRate indicates the rate at which the media should play back. Examples:

• if playbackRate is set to 2, media will play twice as fast.
• if playbackRate is set to 0.5, media will play half as fast.

Set the value of playsinline from the media element. playsinline indicates to the browser that non-fullscreen playback is preferred when fullscreen playback is the native default, such as in iOS Safari.

Set the value of poster on the media element. poster is the url to an image file that can/will be shown when no media data is available.

Set the value of preload on the media element. preload indicates what should download before the media is interacted with. It can have the following values:

• none: nothing should be downloaded
• metadata: poster and the first few frames of the media may be downloaded to get media dimensions and other metadata
• auto: allow the media and metadata for the media to be downloaded before interaction

Set whether we are scrubbing or not. This is used to decide whether we should use fastSeek or not. fastSeek is used to provide trick play on Safari browsers.

Set the value of src on the media element. src indicates the current Tech~SourceObject for the media.

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.

Modify the media element so that we can detect when the source is changed. Fires sourceset just after the source has changed

Set the value of volume on the media element. volume indicates the current audio level as a percentage in decimal form. This means that 1 is 100%, 0.5 is 50%, and so on.

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

A getter/setter for the Html5 Tech's source object.

Note: Please use Html5#setSource

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.

Check if fullscreen is supported on the video el.

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 value of videoHeight from the video element. videoHeight indicates the current height of the video in css pixels.

Get the VideoTrackList

Get the value of videoWidth from the video element. videoWidth indicates the current width of the video in css pixels.

Get the value of volume from the media element. volume indicates the current playback volume of audio for a media. volume will be a value from 0 (silent) to 1 (loudest and default).

Get the current width of the HTML5 media element.

Check if the playback rate can be changed in this browser/device.

Check if the volume can be changed in this browser/device. Volume cannot be changed in a lot of mobile devices. Specifically, it can't be changed from 1 on iOS.

Check if the volume can be muted in this browser/device. Some devices, e.g. iOS, don't allow changing volume but permits muting/unmuting.

Check if we can override a video/audio elements attributes, with Object.defineProperty.

Check if the tech can support the given source

Check if the tech can support the given type

Check if HTML5 media is supported by this browser/device.

Check to see if native AudioTracks are supported by this browser/device

Check to see if native TextTracks are supported by this browser/device.

Check to see if native VideoTracks are supported by this browser/device

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 when tracks are added or removed on the Tech VideoTrackList

Fired when vtt.js is loaded.