Global

Members

(constant) defaults :TransientButtonOptions

Type:

TransientButtonOptions

Source: transient-button.js, line 19

(constant) findMimetype

Find the mime type of a given source string if possible. Uses the player source cache.

Source: utils/mimetypes.js, line 65

(constant) getMimetype

Get the mimetype of a given src url if possible

Source: utils/mimetypes.js, line 45

(constant) innerHTMLDescriptorPolyfill

our implementation of an innerHTML descriptor for browsers that do not have one.

Source: tech/setup-sourceset.js, line 79

(constant) srcDescriptorPolyfill

our implementation of a src descriptor for browsers that do not have one

Source: tech/setup-sourceset.js, line 209

Methods

constructColor(color, opacity) → {string}

Construct an rgba color from a given hex color code.

Parameters:

Name	Type	Description
`color`	number	Hex number for color, like #f0e or #f604e2.
`opacity`	number	Value for opacity, 0.0 - 1.0.

Source: tracks/text-track-display.js, line 39

Returns:

The rgba color that was created, like 'rgba(255, 0, 0, 0.3)'.

Type:: string

firstSourceWatch(tech)

Patches browser internal functions so that we can tell synchronously if a <source> was appended to the media element. For some reason this causes a sourceset if the the media element is ready and has no source. This happens when:

The page has just loaded and the media element does not have a source.
The media element was emptied of all sources, then load() was called.

It does this by patching the following functions/properties when they are supported:

append() - can be used to add a <source> element to the media element
appendChild() - can be used to add a <source> element to the media element
insertAdjacentHTML() - can be used to add a <source> element to the media element
innerHTML - can be used to add a <source> element to the media element

Parameters:

Name	Type	Description
`tech`	Html5	The tech object that sourceset is being setup on.

Source: tech/setup-sourceset.js, line 157

getDescriptor()

Get a property descriptor given a list of priorities and the property to get.

Source: tech/setup-sourceset.js, line 115

hasPlugin(name) → {boolean}

Reports whether or not a player has a plugin available.

This does not report whether or not the plugin has ever been initialized on this player. For that, usingPlugin.

Parameters:

Name	Type	Description
`name`	string	The name of a plugin.

Source: player.js, line 5374

Returns:

Whether or not this player has the requested plugin available.

Type:: boolean

hook(type, The)

Add a function hook to a specific videojs lifecycle.

Parameters:

Name	Type	Description
`type`	string	the lifecycle to hook the function to.
`The`	function \| Array.<function()>	function or array of functions to attach.

Source: utils/hooks.js, line 38

hookOnce(type, The)

Add a function hook that will only run once to a specific videojs lifecycle.

Parameters:

Name	Type	Description
`type`	string	the lifecycle to hook the function to.
`The`	function \| Array.<function()>	function or array of functions to attach.

Source: utils/hooks.js, line 76

hooks(type, fnopt) → {Array}

Get a list of hooks for a specific lifecycle

Parameters:

Name	Type	Attributes	Description
`type`	string		the lifecycle to get hooks from
`fn`	function \| Array.<function()>	<optional>	Optionally add a hook (or hooks) to the lifecycle that your are getting.

Source: utils/hooks.js, line 21

Returns:

an array of hooks, or an empty array if there are none.

Type:: Array

isActuallyDisabled(element) → {boolean}

Decide whether an element is actually disabled or not.

Parameters:

Name	Type	Description
`element`	Node

Source: component.js, line 1819
See: https://html.spec.whatwg.org/multipage/semantics-other.html#concept-element-disabled

Returns:

Type:: boolean

isBeingRendered(element) → {boolean}

Decide whether the element is being rendered or not.

If an element has the style as "visibility: hidden | collapse" or "display: none", it is not being rendered.
If an element has the style as "opacity: 0", it is not being rendered.(that is, invisible).
If width and height of an element are explicitly set to 0, it is not being rendered.
If a parent element is hidden, an element itself is not being rendered. (CSS visibility property and display property are inherited.)

Parameters:

Name	Type	Description
`element`	Node

Source: component.js, line 1881
See: https://html.spec.whatwg.org/multipage/rendering.html#being-rendered

Returns:

Type:: boolean

isExpresslyInert(element) → {boolean}

Decide whether the element is expressly inert or not.

Parameters:

Name	Type	Description
`element`	Node

Source: component.js, line 1832
See: https://html.spec.whatwg.org/multipage/interaction.html#expressly-inert

Returns:

Type:: boolean

isPromise(value) → {boolean}

Returns whether an object is Promise-like (i.e. has a then method).

Parameters:

Name	Type	Description
`value`	Object	An object that may or may not be `Promise`-like.

Source: utils/promise.js, line 11

Returns:

Whether or not the object is Promise-like.

Type:: boolean

isVisible(element) → {boolean}

Determine if the element is visible for the user or not.

If an element sum of its offsetWidth, offsetHeight, height and width is less than 1 is not visible.
If elementCenter.x is less than is not visible.
If elementCenter.x is more than the document's width is not visible.
If elementCenter.y is less than 0 is not visible.
If elementCenter.y is the document's height is not visible.

Parameters:

Name	Type	Description
`element`	Node

Source: component.js, line 1904

Returns:

Type:: boolean

isVisibleStyleProperty(element) → {boolean}

Decide the style property of this element is specified whether it's visible or not.

Parameters:

Name	Type	Description
`element`	CSSStyleDeclaration

Source: component.js, line 1865

Returns:

Type:: boolean

percentify()

Source: control-bar/progress-control/load-progress-bar.js, line 12

removeHook(type, fn) → {boolean}

Remove a hook from a specific videojs lifecycle.

Parameters:

Name	Type	Description
`type`	string	the lifecycle that the function hooked to
`fn`	function	The hooked function to remove

Source: utils/hooks.js, line 54

Returns:

The function that was removed or undef

Type:: boolean

setupSourceset(tech)

setup sourceset handling on the Html5 tech. This function patches the following element properties/functions:

src - to determine when src is set
setAttribute() - to determine when src is set
load() - this re-triggers the source selection algorithm, and can cause a sourceset.

If there is no source when we are adding sourceset support or during a load() we also patch the functions listed in firstSourceWatch.

Parameters:

Name	Type	Description
`tech`	Html5	The tech to patch

Source: tech/setup-sourceset.js, line 241

silencePromise(value)

Silence a Promise-like object.

This is useful for avoiding non-harmful, but potentially confusing "uncaught play promise" rejection error messages.

Parameters:

Name	Type	Description
`value`	Object	An object that may or may not be `Promise`-like.

Source: utils/promise.js, line 24

sourcesetLoad(tech) → {boolean}

This function is used to fire a sourceset when there is something similar to mediaEl.load() being called. It will try to find the source via the src attribute and then the <source> elements. It will then fire sourceset with the source that was found or empty string if we cannot know. If it cannot find a source then sourceset will not be fired.

Parameters:

Name	Type	Description
`tech`	Html5	The tech object that sourceset was setup on

Source: tech/setup-sourceset.js, line 21

Returns:

returns false if the sourceset was not fired and true otherwise.

Type:: boolean

Type Definitions

ErrorMetadata

An object containing an error type, as well as other information regarding the error.

Type:

Object

Properties

Name	Type	Description
`errorType`	string	Error type

Source: media-error.js, line 78

Event

A Custom DOM event.

Type:

CustomEvent

Source: event-target.js, line 161
See: Properties

EventListener(event, hashopt)

All event listeners should follow the following format.

This:

{EventTarget}

Parameters:

Name	Type	Attributes	Description
`event`	Event		the event that triggered this function
`hash`	Object	<optional>	hash of data sent during the event

Source: event-target.js, line 168

PlayerReadyCallback() → {void}

This:

{Player}

Source: player.js, line 66

Returns:

Type:: void

PlayerVersion

An object that contains Video.js version.

Type:

Object

Properties

Name	Type	Description
`'video.js'`	string	Video.js version

Source: player.js, line 1368

PluginEventHash

Type:

Object

Properties

Name	Type	Description
`instance`	string	For basic plugins, the return value of the plugin function. For advanced plugins, the plugin instance on which the event is fired.
`name`	string	The name of the plugin.
`plugin`	string	For basic plugins, the plugin function. For advanced plugins, the plugin class/constructor.

Source: plugin.js, line 511

ReadyCallback() → {void}

A callback to be called if and when the component is ready. this will be the Component instance.

Source: component.js, line 18

Returns:

Type:: void

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

TransientButtonOptions

Type:

object

Properties

Name	Type	Attributes	Default	Description
`controlText`	string	<optional>		Control text, usually visible for these buttons
`initialDisplay`	number	<optional>	4000	Time in ms that button should initially remain visible
`position`	Array.<('top'\|'neartop'\|'bottom'\|'left'\|'right')>	<optional>		Array of position strings to add basic styles for positioning
`className`	string	<optional>		Class(es) to add
`takeFocus`	boolean	<optional>	false	Whether element sohuld take focus when shown
`clickHandler`	function	<optional>		Function called on button activation

Source: transient-button.js, line 8

Members

(constant) LOCAL_STORAGE_KEY

(constant) MODAL_CLASS_NAME

(constant) STEP_SECONDS

(constant) darkGray

(constant) defaults

(constant) defaults :TransientButtonOptions

(constant) findMimetype

(constant) getMimetype

(constant) innerHTMLDescriptorPolyfill

(constant) srcDescriptorPolyfill

Methods

constructColor(color, opacity) → {string}

firstSourceWatch(tech)

getDescriptor()

hasPlugin(name) → {boolean}

hook(type, The)

hookOnce(type, The)

hooks(type, fnopt) → {Array}

isActuallyDisabled(element) → {boolean}

isBeingRendered(element) → {boolean}

isExpresslyInert(element) → {boolean}

isPromise(value) → {boolean}

isVisible(element) → {boolean}

isVisibleStyleProperty(element) → {boolean}

percentify()

removeHook(type, fn) → {boolean}

setupSourceset(tech)

silencePromise(value)

sourcesetLoad(tech) → {boolean}

Type Definitions

ErrorMetadata

Event

EventListener(event, hashopt)

PlayerReadyCallback() → {void}

PlayerVersion

PluginEventHash

ReadyCallback() → {void}

SourceObject

TransientButtonOptions