diff --git a/docs/legacy-docs/api/audio-track-button.html b/docs/legacy-docs/api/audio-track-button.html index 123b0f71d..376249e4e 100644 --- a/docs/legacy-docs/api/audio-track-button.html +++ b/docs/legacy-docs/api/audio-track-button.html @@ -1,6 +1,9 @@ AudioTrackButton

API Index

AudioTrackButton Methods

Class Methods

Inherited Methods from MenuButton

Inherited Methods from Button

Inherited Methods from ClickableComponent

Inherited Methods from Component

AudioTrackButton

The base class for buttons that toggle specific text track types (e.g. subtitles)

DEFINED IN: audio-track-button.js line number: 9

EXTENDS: track-button.js

Constructor

AudioTrackButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handleClick()

When you click the button it adds focus, which + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

AudioTrackButton

The base class for buttons that toggle specific text track types (e.g. subtitles)

DEFINED IN: audio-track-button.js line number: 9

EXTENDS: track-button.js

Constructor

AudioTrackButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handleClick()

When you click the button it adds focus, which will show the menu indefinitely. So we'll remove focus when the mouse leaves the button. Focus is needed for tab navigation. diff --git a/docs/legacy-docs/api/big-play-button.html b/docs/legacy-docs/api/big-play-button.html index 4765bb6f3..28619b632 100644 --- a/docs/legacy-docs/api/big-play-button.html +++ b/docs/legacy-docs/api/big-play-button.html @@ -1,6 +1,9 @@ BigPlayButton

API Index

BigPlayButton

Initial play button. Shows before the video has played. The hiding of the + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

BigPlayButton

Initial play button. Shows before the video has played. The hiding of the big play button is done via CSS and player states.

DEFINED IN: big-play-button.js line number: 7

EXTENDS: button.js

Constructor

BigPlayButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values

Methods

buildCSSClass()

Allow sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/big-play-button.js line number: 22

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used diff --git a/docs/legacy-docs/api/button.html b/docs/legacy-docs/api/button.html index 2328c1eae..5d22a28bb 100644 --- a/docs/legacy-docs/api/button.html +++ b/docs/legacy-docs/api/button.html @@ -1,6 +1,9 @@ Button

API Index

Button

Base class for all buttons

DEFINED IN: button.js line number: 12

EXTENDS: clickable-component.js

Constructor

Button( player,[options] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleClick()

Handle Click - Override with specific functionality for component

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 132

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Button

Base class for all buttons

DEFINED IN: button.js line number: 12

EXTENDS: clickable-component.js

Constructor

Button( player,[options] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleClick()

Handle Click - Override with specific functionality for component

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 132

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/caption-settings-menu-item.html b/docs/legacy-docs/api/caption-settings-menu-item.html index 987590972..5d46e68e0 100644 --- a/docs/legacy-docs/api/caption-settings-menu-item.html +++ b/docs/legacy-docs/api/caption-settings-menu-item.html @@ -1,6 +1,9 @@ CaptionSettingsMenuItem

API Index

CaptionSettingsMenuItem

The menu item for caption track settings menu

DEFINED IN: caption-settings-menu-item.js line number: 7

EXTENDS: text-track-menu-item.js

Constructor

CaptionSettingsMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

CaptionSettingsMenuItem

The menu item for caption track settings menu

DEFINED IN: caption-settings-menu-item.js line number: 7

EXTENDS: text-track-menu-item.js

Constructor

CaptionSettingsMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/captions-button.html b/docs/legacy-docs/api/captions-button.html index 074fca386..538ca53a4 100644 --- a/docs/legacy-docs/api/captions-button.html +++ b/docs/legacy-docs/api/captions-button.html @@ -1,6 +1,9 @@ CaptionsButton

API Index

CaptionsButton

The button component for toggling and selecting captions

DEFINED IN: captions-button.js line number: 8

EXTENDS: text-track-button.js

Constructor

CaptionsButton( player,[options],[ready] )

Parameters

nameTypeRequiredDescription
playerObjectyesPlayer object
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

handleClick()

When you click the button it adds focus, which + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

CaptionsButton

The button component for toggling and selecting captions

DEFINED IN: captions-button.js line number: 8

EXTENDS: text-track-button.js

Constructor

CaptionsButton( player,[options],[ready] )

Parameters

nameTypeRequiredDescription
playerObjectyesPlayer object
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

handleClick()

When you click the button it adds focus, which will show the menu indefinitely. So we'll remove focus when the mouse leaves the button. Focus is needed for tab navigation. diff --git a/docs/legacy-docs/api/captions-track.html b/docs/legacy-docs/api/captions-track.html index 750a49635..67725e8da 100644 --- a/docs/legacy-docs/api/captions-track.html +++ b/docs/legacy-docs/api/captions-track.html @@ -9,8 +9,11 @@ - + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. + diff --git a/docs/legacy-docs/api/chapters-button.html b/docs/legacy-docs/api/chapters-button.html index 5c23d0043..a65f16b19 100644 --- a/docs/legacy-docs/api/chapters-button.html +++ b/docs/legacy-docs/api/chapters-button.html @@ -1,6 +1,9 @@ ChaptersButton

API Index

ChaptersButton

The button component for toggling and selecting chapters + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ChaptersButton

The button component for toggling and selecting chapters Chapters act much differently than other text tracks Cues are navigation vs. other tracks of alternative languages

DEFINED IN: chapters-button.js line number: 14

EXTENDS: text-track-button.js

Constructor

ChaptersButton( player,[options],[ready] )

Parameters

nameTypeRequiredDescription
playerObjectyesPlayer object
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

handleClick()

When you click the button it adds focus, which will show the menu indefinitely. diff --git a/docs/legacy-docs/api/chapters-track-menu-item.html b/docs/legacy-docs/api/chapters-track-menu-item.html index 6882c069b..bf9b2c6a1 100644 --- a/docs/legacy-docs/api/chapters-track-menu-item.html +++ b/docs/legacy-docs/api/chapters-track-menu-item.html @@ -1,6 +1,9 @@ ChaptersTrackMenuItem

API Index

ChaptersTrackMenuItem

The chapter track menu item

DEFINED IN: chapters-track-menu-item.js line number: 8

EXTENDS: menu-item.js

Constructor

ChaptersTrackMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ChaptersTrackMenuItem

The chapter track menu item

DEFINED IN: chapters-track-menu-item.js line number: 8

EXTENDS: menu-item.js

Constructor

ChaptersTrackMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/chapters-track.html b/docs/legacy-docs/api/chapters-track.html index 750a49635..67725e8da 100644 --- a/docs/legacy-docs/api/chapters-track.html +++ b/docs/legacy-docs/api/chapters-track.html @@ -9,8 +9,11 @@ - + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. + diff --git a/docs/legacy-docs/api/clickable-component.html b/docs/legacy-docs/api/clickable-component.html index 2ef31f2de..5d947017b 100644 --- a/docs/legacy-docs/api/clickable-component.html +++ b/docs/legacy-docs/api/clickable-component.html @@ -1,6 +1,9 @@ ClickableComponent

API Index

ClickableComponent

Clickable Component which is clickable or keyboard actionable, but is not a native HTML button

DEFINED IN: clickable-component.js line number: 12

EXTENDS: component.js

Constructor

ClickableComponent( player,[options] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values

Methods

addChild( child, [options] )

Adds a child component inside this clickable-component

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 112

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 33

[back to top]

handleClick()

Handle Click - Override with specific functionality for component

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 132

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Trigger click when Space or Enter key is pressed

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 148

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ClickableComponent

Clickable Component which is clickable or keyboard actionable, but is not a native HTML button

DEFINED IN: clickable-component.js line number: 12

EXTENDS: component.js

Constructor

ClickableComponent( player,[options] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values

Methods

addChild( child, [options] )

Adds a child component inside this clickable-component

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 112

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 33

[back to top]

handleClick()

Handle Click - Override with specific functionality for component

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 132

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Trigger click when Space or Enter key is pressed

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 148

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/close-button.html b/docs/legacy-docs/api/close-button.html index 0605cc948..d3ce7bcd5 100644 --- a/docs/legacy-docs/api/close-button.html +++ b/docs/legacy-docs/api/close-button.html @@ -1,6 +1,9 @@ CloseButton

API Index

CloseButton

The CloseButton component is a button which fires a "close" event + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

CloseButton

The CloseButton component is a button which fires a "close" event when it is activated.

DEFINED IN: close-button.js line number: 4

EXTENDS: button.js

Constructor

CloseButton()

API Index

Component

Base UI Component class + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Component

Base UI Component class Components are embeddable UI objects that are represented by both a javascript object and an element in the DOM. They can be children of other components, and can have many children themselves.

diff --git a/docs/legacy-docs/api/control-bar.html b/docs/legacy-docs/api/control-bar.html index 19d5fe87f..7eb1192b6 100644 --- a/docs/legacy-docs/api/control-bar.html +++ b/docs/legacy-docs/api/control-bar.html @@ -1,6 +1,9 @@ ControlBar

API Index

ControlBar

Container of main controls

DEFINED IN: control-bar.js line number: 24

EXTENDS: component.js

Constructor

ControlBar()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ControlBar

Container of main controls

DEFINED IN: control-bar.js line number: 24

EXTENDS: component.js

Constructor

ControlBar()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/css/api-docs.css b/docs/legacy-docs/api/css/api-docs.css index ae1691f3f..9ee8adcfb 100644 --- a/docs/legacy-docs/api/css/api-docs.css +++ b/docs/legacy-docs/api/css/api-docs.css @@ -118,4 +118,19 @@ div.section { .deprecated { color: #990000; +} + +.legacydocsnote { + background-color: #ffdddd; + border: 2px solid #ff0000; + text-align: center; + margin: 1em auto; + padding: 1em; + width: 80%; +} + +.legacydocsnote::before { + content: "⚠️"; + font-size: 200%; + vertical-align: middle; } \ No newline at end of file diff --git a/docs/legacy-docs/api/css/api-index.css b/docs/legacy-docs/api/css/api-index.css index 0df09b14e..31247d3e2 100644 --- a/docs/legacy-docs/api/css/api-index.css +++ b/docs/legacy-docs/api/css/api-index.css @@ -50,4 +50,19 @@ div.indexColumn { } div, .section { border: none; +} + +.legacydocsnote { + background-color: #ffdddd; + border: 2px solid #ff0000; + text-align: center; + margin: 1em auto; + padding: 1em; + width: 80%; +} + +.legacydocsnote::before { + content: "⚠️"; + font-size: 200%; + vertical-align: middle; } \ No newline at end of file diff --git a/docs/legacy-docs/api/current-time-display.html b/docs/legacy-docs/api/current-time-display.html index 93e6aa3e5..ef77f9017 100644 --- a/docs/legacy-docs/api/current-time-display.html +++ b/docs/legacy-docs/api/current-time-display.html @@ -1,6 +1,9 @@ CurrentTimeDisplay

API Index

CurrentTimeDisplay

Displays the current time

DEFINED IN: current-time-display.js line number: 8

EXTENDS: component.js

Constructor

CurrentTimeDisplay( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

CurrentTimeDisplay

Displays the current time

DEFINED IN: current-time-display.js line number: 8

EXTENDS: component.js

Constructor

CurrentTimeDisplay( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/custom-control-spacer.html b/docs/legacy-docs/api/custom-control-spacer.html index df18596a1..123b3a605 100644 --- a/docs/legacy-docs/api/custom-control-spacer.html +++ b/docs/legacy-docs/api/custom-control-spacer.html @@ -1,6 +1,9 @@ CustomControlSpacer

API Index

CustomControlSpacer

Spacer specifically meant to be used as an insertion point for new plugins, etc.

DEFINED IN: custom-control-spacer.js line number: 7

EXTENDS: spacer.js

Constructor

CustomControlSpacer()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

CustomControlSpacer

Spacer specifically meant to be used as an insertion point for new plugins, etc.

DEFINED IN: custom-control-spacer.js line number: 7

EXTENDS: spacer.js

Constructor

CustomControlSpacer()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/duration-display.html b/docs/legacy-docs/api/duration-display.html index aaf3d79b1..42dfdf14d 100644 --- a/docs/legacy-docs/api/duration-display.html +++ b/docs/legacy-docs/api/duration-display.html @@ -1,6 +1,9 @@ DurationDisplay

API Index

DurationDisplay

Displays the duration

DEFINED IN: duration-display.js line number: 8

EXTENDS: component.js

Constructor

DurationDisplay( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

DurationDisplay

Displays the duration

DEFINED IN: duration-display.js line number: 8

EXTENDS: component.js

Constructor

DurationDisplay( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/error-display.html b/docs/legacy-docs/api/error-display.html index 06d395c88..1a0c86cf5 100644 --- a/docs/legacy-docs/api/error-display.html +++ b/docs/legacy-docs/api/error-display.html @@ -1,6 +1,9 @@ ErrorDisplay

API Index

ErrorDisplay

Display that an error has occurred making the video unplayable.

DEFINED IN: error-display.js line number: 10

EXTENDS: modal-dialog.js

Constructor

ErrorDisplay()

Methods

buildCSSClass() (deprecated)

Include the old class for backward-compatibility.

+ + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ErrorDisplay

Display that an error has occurred making the video unplayable.

DEFINED IN: error-display.js line number: 10

EXTENDS: modal-dialog.js

Constructor

ErrorDisplay()

Methods

buildCSSClass() (deprecated)

Include the old class for backward-compatibility.

This can be removed in 6.0.

Defined in https://github.com/videojs/video.js/blob/master/src/js/error-display.js line number: 29

[back to top]

closeable( [value] )

Whether or not the modal is closeable via the UI.

Parameters

nameTypeRequiredDescription
valueBooleannoIf given as a Boolean, it will set the closeable option.

Defined in https://github.com/videojs/video.js/blob/master/src/js/modal-dialog.js line number: 239

[back to top]

content( [value] )

Gets or sets the modal content, which gets normalized before being rendered into the DOM.

This does not update the DOM or fill the modal, but it is called during diff --git a/docs/legacy-docs/api/flash.html b/docs/legacy-docs/api/flash.html index 6a5db682e..5b4914f32 100644 --- a/docs/legacy-docs/api/flash.html +++ b/docs/legacy-docs/api/flash.html @@ -1,6 +1,9 @@ Flash

API Index

Flash

Flash Media Controller - Wrapper for fallback SWF API

DEFINED IN: flash.js line number: 18

EXTENDS: tech.js

Constructor

Flash( [options],[ready] )

Parameters

nameTypeRequiredDescription
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

currentTime( [time] )

Get current time

Parameters

nameTypeRequiredDescription
timeNumbernoCurrent time of video

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 203

[back to top]

enterFullScreen()

Request to enter fullscreen + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Flash

Flash Media Controller - Wrapper for fallback SWF API

DEFINED IN: flash.js line number: 18

EXTENDS: tech.js

Constructor

Flash( [options],[ready] )

Parameters

nameTypeRequiredDescription
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

currentTime( [time] )

Get current time

Parameters

nameTypeRequiredDescription
timeNumbernoCurrent time of video

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 203

[back to top]

enterFullScreen()

Request to enter fullscreen Flash does not allow fullscreen through javascript so always returns false

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 297

[back to top]

setCurrentTime( time )

Set current time

Parameters

nameTypeRequiredDescription
timeNumberyesCurrent time of video

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 183

[back to top]

setPoster()

Poster images are not handled by the Flash tech so make this a no-op

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 250

[back to top]

setSrc( [src] ) (deprecated)

Set video

Parameters

nameTypeRequiredDescription
srcObjectnoSource object

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 155

[back to top]

src( [src] )

Get/set video

Parameters

nameTypeRequiredDescription
srcObjectnoSource object

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 139

[back to top]

supportsFullScreen()

Get fullscreen support - Flash does not allow fullscreen through javascript diff --git a/docs/legacy-docs/api/fullscreen-toggle.html b/docs/legacy-docs/api/fullscreen-toggle.html index 23d4c8651..b7f6c4a24 100644 --- a/docs/legacy-docs/api/fullscreen-toggle.html +++ b/docs/legacy-docs/api/fullscreen-toggle.html @@ -1,6 +1,9 @@ FullscreenToggle

API Index

FullscreenToggle

Toggle fullscreen video

DEFINED IN: fullscreen-toggle.js line number: 7

EXTENDS: button.js

Constructor

FullscreenToggle()

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

FullscreenToggle

Toggle fullscreen video

DEFINED IN: fullscreen-toggle.js line number: 7

EXTENDS: button.js

Constructor

FullscreenToggle()

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/html-track-element.html b/docs/legacy-docs/api/html-track-element.html index c0dd61544..2f1e94cdf 100644 --- a/docs/legacy-docs/api/html-track-element.html +++ b/docs/legacy-docs/api/html-track-element.html @@ -1,6 +1,9 @@ HTMLTrackElement

API Index

HTMLTrackElement

https://html.spec.whatwg.org/multipage/embedded-content.html#htmltrackelement

+ + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

HTMLTrackElement

https://html.spec.whatwg.org/multipage/embedded-content.html#htmltrackelement

interface HTMLTrackElement : HTMLElement { attribute DOMString kind; attribute DOMString src; diff --git a/docs/legacy-docs/api/html5.html b/docs/legacy-docs/api/html5.html index e5db64f48..21271773d 100644 --- a/docs/legacy-docs/api/html5.html +++ b/docs/legacy-docs/api/html5.html @@ -1,6 +1,9 @@ Html5

API Index

Html5

HTML5 Media Controller - Wrapper for HTML5 Media API

DEFINED IN: html5.js line number: 18

EXTENDS: tech.js

Constructor

Html5( [options],[ready] )

Parameters

nameTypeRequiredDescription
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

addRemoteTextTrack( options )

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

Parameters

nameTypeRequiredDescription
optionsObjectyesThe object should contain values for + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Html5

HTML5 Media Controller - Wrapper for HTML5 Media API

DEFINED IN: html5.js line number: 18

EXTENDS: tech.js

Constructor

Html5( [options],[ready] )

Parameters

nameTypeRequiredDescription
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

Methods

addRemoteTextTrack( options )

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

Parameters

nameTypeRequiredDescription
optionsObjectyesThe object should contain values for kind, language, label and src (location of the WebVTT file)

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/html5.js line number: 736

[back to top]

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

Creates and returns a text track object

Parameters

nameTypeRequiredDescription
kindStringyesText track kind (subtitles, captions, descriptions chapters and metadata)
labelStringnoLabel to identify the text track
languageStringnoTwo letter language abbreviation

Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/html5.js line number: 718

[back to top]

buffered()

Get a TimeRange object that represents the intersection of the time ranges for which the user agent has all diff --git a/docs/legacy-docs/api/index.html b/docs/legacy-docs/api/index.html index d13f91a2e..f2db2b7b7 100644 --- a/docs/legacy-docs/api/index.html +++ b/docs/legacy-docs/api/index.html @@ -8,8 +8,11 @@ - + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. + diff --git a/docs/legacy-docs/api/live-display.html b/docs/legacy-docs/api/live-display.html index b4ec35dc8..4a8f4579e 100644 --- a/docs/legacy-docs/api/live-display.html +++ b/docs/legacy-docs/api/live-display.html @@ -1,6 +1,9 @@ LiveDisplay

API Index

LiveDisplay

Displays the live indicator + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

LiveDisplay

Displays the live indicator TODO - Future make it click to snap to live

DEFINED IN: live-display.js line number: 7

EXTENDS: component.js

Constructor

LiveDisplay()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used diff --git a/docs/legacy-docs/api/load-progress-bar.html b/docs/legacy-docs/api/load-progress-bar.html index 2417d4539..61c69c62b 100644 --- a/docs/legacy-docs/api/load-progress-bar.html +++ b/docs/legacy-docs/api/load-progress-bar.html @@ -1,6 +1,9 @@ LoadProgressBar

API Index

LoadProgressBar

Shows load progress

DEFINED IN: load-progress-bar.js line number: 7

EXTENDS: component.js

Constructor

LoadProgressBar( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

LoadProgressBar

Shows load progress

DEFINED IN: load-progress-bar.js line number: 7

EXTENDS: component.js

Constructor

LoadProgressBar( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/loader.html b/docs/legacy-docs/api/loader.html index cdb5a66a6..f5ac73a17 100644 --- a/docs/legacy-docs/api/loader.html +++ b/docs/legacy-docs/api/loader.html @@ -1,6 +1,9 @@ MediaLoader

API Index

MediaLoader

The Media Loader is the component that decides which playback technology to load + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

MediaLoader

The Media Loader is the component that decides which playback technology to load when the player is initialized.

DEFINED IN: loader.js line number: 9

EXTENDS: component.js

Constructor

MediaLoader( player,[options],[ready] )

Parameters

nameTypeRequiredDescription
playerObjectyesMain Player
optionsObjectnoObject of option names and values
readyfunctionnoReady callback function

API Index

LoadingSpinner

Loading spinner for waiting events

DEFINED IN: loading-spinner.js line number: 8

EXTENDS: component.js

Constructor

LoadingSpinner()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

LoadingSpinner

Loading spinner for waiting events

DEFINED IN: loading-spinner.js line number: 8

EXTENDS: component.js

Constructor

LoadingSpinner()

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/menu-button.html b/docs/legacy-docs/api/menu-button.html index ac6ad8a8e..6e1827dae 100644 --- a/docs/legacy-docs/api/menu-button.html +++ b/docs/legacy-docs/api/menu-button.html @@ -1,6 +1,9 @@ MenuButton

API Index

MenuButton

A button class with a popup menu

DEFINED IN: menu-button.js line number: 11

EXTENDS: button.js

Constructor

MenuButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

buildCSSClass()

Allow sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 111

[back to top]

createItems()

Create the list of menu items. Specific to each subclass.

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 92

[back to top]

handleClick()

When you click the button it adds focus, which + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

MenuButton

A button class with a popup menu

DEFINED IN: menu-button.js line number: 11

EXTENDS: button.js

Constructor

MenuButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

buildCSSClass()

Allow sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 111

[back to top]

createItems()

Create the list of menu items. Specific to each subclass.

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 92

[back to top]

handleClick()

When you click the button it adds focus, which will show the menu indefinitely. So we'll remove focus when the mouse leaves the button. Focus is needed for tab navigation. diff --git a/docs/legacy-docs/api/menu-item.html b/docs/legacy-docs/api/menu-item.html index 949c7ac89..49f55c5c8 100644 --- a/docs/legacy-docs/api/menu-item.html +++ b/docs/legacy-docs/api/menu-item.html @@ -1,6 +1,9 @@ MenuItem

API Index

MenuItem

The component for a menu item.

DEFINED IN: menu-item.js line number: 8

EXTENDS: button.js

Constructor

MenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

handleClick()

Handle a click on the menu item, and set it to selected

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 50

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

MenuItem

The component for a menu item.

DEFINED IN: menu-item.js line number: 8

EXTENDS: button.js

Constructor

MenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

handleClick()

Handle a click on the menu item, and set it to selected

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 50

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/menu.html b/docs/legacy-docs/api/menu.html index c29040d03..2ecee3c15 100644 --- a/docs/legacy-docs/api/menu.html +++ b/docs/legacy-docs/api/menu.html @@ -1,6 +1,9 @@ Menu

API Index

Menu

The Menu component is used to build pop up menus, including subtitle and + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Menu

The Menu component is used to build pop up menus, including subtitle and captions selection menus.

DEFINED IN: menu.js line number: 9

EXTENDS: component.js

Constructor

Menu()

Methods

addItem( component )

Add a menu item to the menu

Parameters

nameTypeRequiredDescription
componentObject|StringyesComponent or component type to add

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu.js line number: 26

[back to top]

focus( item )

Set focus on a menu item in the menu

Parameters

nameTypeRequiredDescription
itemObject|StringyesIndex of child item set focus on

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu.js line number: 113

[back to top]

handleKeyPress( event )

Handle key press for menu

Parameters

nameTypeRequiredDescription
eventObjectyesEvent object

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu.js line number: 69

[back to top]

stepBack()

Move to previous (higher) menu item for keyboard users

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu.js line number: 99

[back to top]

stepForward()

Move to next (lower) menu item for keyboard users

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu.js line number: 85

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used diff --git a/docs/legacy-docs/api/modal-dialog.html b/docs/legacy-docs/api/modal-dialog.html index f9f19576c..f3288852f 100644 --- a/docs/legacy-docs/api/modal-dialog.html +++ b/docs/legacy-docs/api/modal-dialog.html @@ -1,6 +1,9 @@ ModalDialog

API Index

ModalDialog

The ModalDialog displays over the video and its controls, which blocks + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

ModalDialog

The ModalDialog displays over the video and its controls, which blocks interaction with the player until it is closed.

Modal dialogs include a "Close" button and will close when that button is activated - or when ESC is pressed anywhere.

DEFINED IN: modal-dialog.js line number: 16

EXTENDS: component.js

Constructor

ModalDialog()

Methods

closeable( [value] )

Whether or not the modal is closeable via the UI.

Parameters

nameTypeRequiredDescription
valueBooleannoIf given as a Boolean, it will set the closeable option.

Defined in https://github.com/videojs/video.js/blob/master/src/js/modal-dialog.js line number: 239

[back to top]

content( [value] )

Gets or sets the modal content, which gets normalized before being diff --git a/docs/legacy-docs/api/mouse-time-display.html b/docs/legacy-docs/api/mouse-time-display.html index 77cf0b297..31fa2bf49 100644 --- a/docs/legacy-docs/api/mouse-time-display.html +++ b/docs/legacy-docs/api/mouse-time-display.html @@ -1,6 +1,9 @@ MouseTimeDisplay

API Index

MouseTimeDisplay

The Mouse Time Display component shows the time you will seek to + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

MouseTimeDisplay

The Mouse Time Display component shows the time you will seek to when hovering over the progress bar

DEFINED IN: mouse-time-display.js line number: 10

EXTENDS: component.js

Constructor

MouseTimeDisplay( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used diff --git a/docs/legacy-docs/api/mute-toggle.html b/docs/legacy-docs/api/mute-toggle.html index d4e27c7d3..327f2109f 100644 --- a/docs/legacy-docs/api/mute-toggle.html +++ b/docs/legacy-docs/api/mute-toggle.html @@ -1,6 +1,9 @@ MuteToggle

API Index

MuteToggle

A button component for muting the audio

DEFINED IN: mute-toggle.js line number: 8

EXTENDS: button.js

Constructor

MuteToggle( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

MuteToggle

A button component for muting the audio

DEFINED IN: mute-toggle.js line number: 8

EXTENDS: button.js

Constructor

MuteToggle( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/off-text-track-menu-item.html b/docs/legacy-docs/api/off-text-track-menu-item.html index a550a0248..e561c7987 100644 --- a/docs/legacy-docs/api/off-text-track-menu-item.html +++ b/docs/legacy-docs/api/off-text-track-menu-item.html @@ -1,6 +1,9 @@ OffTextTrackMenuItem

API Index

OffTextTrackMenuItem

A special menu item for turning of a specific type of text track

DEFINED IN: off-text-track-menu-item.js line number: 7

EXTENDS: text-track-menu-item.js

Constructor

OffTextTrackMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handleTracksChange( event )

Handle text track change

Parameters

nameTypeRequiredDescription
eventObjectyesEvent object

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/text-track-controls/off-text-track-menu-item.js line number: 35

[back to top]

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

OffTextTrackMenuItem

A special menu item for turning of a specific type of text track

DEFINED IN: off-text-track-menu-item.js line number: 7

EXTENDS: text-track-menu-item.js

Constructor

OffTextTrackMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handleTracksChange( event )

Handle text track change

Parameters

nameTypeRequiredDescription
eventObjectyesEvent object

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/text-track-controls/off-text-track-menu-item.js line number: 35

[back to top]

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/play-progress-bar.html b/docs/legacy-docs/api/play-progress-bar.html index 53ed77149..5cdf157c5 100644 --- a/docs/legacy-docs/api/play-progress-bar.html +++ b/docs/legacy-docs/api/play-progress-bar.html @@ -1,6 +1,9 @@ PlayProgressBar

API Index

PlayProgressBar

Shows play progress

DEFINED IN: play-progress-bar.js line number: 8

EXTENDS: component.js

Constructor

PlayProgressBar( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

PlayProgressBar

Shows play progress

DEFINED IN: play-progress-bar.js line number: 8

EXTENDS: component.js

Constructor

PlayProgressBar( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/play-toggle.html b/docs/legacy-docs/api/play-toggle.html index 40ab415a0..44e05027d 100644 --- a/docs/legacy-docs/api/play-toggle.html +++ b/docs/legacy-docs/api/play-toggle.html @@ -1,6 +1,9 @@ PlayToggle

API Index

PlayToggle

Button to toggle between play and pause

DEFINED IN: play-toggle.js line number: 7

EXTENDS: button.js

Constructor

PlayToggle( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handlePause()

Add the vjs-paused class to the element so it can change appearance

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 58

[back to top]

handlePlay()

Add the vjs-playing class to the element so it can change appearance

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 47

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

PlayToggle

Button to toggle between play and pause

DEFINED IN: play-toggle.js line number: 7

EXTENDS: button.js

Constructor

PlayToggle( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

handlePause()

Add the vjs-paused class to the element so it can change appearance

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 58

[back to top]

handlePlay()

Add the vjs-playing class to the element so it can change appearance

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 47

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

createEl( [type], [props], [attributes] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoElement's node type. e.g. 'div'
propsObjectnoAn object of properties that should be set on the element
attributesObjectnoAn object of attributes that should be set on the element

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/playback-rate-menu-button.html b/docs/legacy-docs/api/playback-rate-menu-button.html index 2fbf83f11..3c6a62756 100644 --- a/docs/legacy-docs/api/playback-rate-menu-button.html +++ b/docs/legacy-docs/api/playback-rate-menu-button.html @@ -1,6 +1,9 @@ PlaybackRateMenuButton

API Index

PlaybackRateMenuButton

The component for controlling the playback rate

DEFINED IN: playback-rate-menu-button.js line number: 10

EXTENDS: menu-button.js

Constructor

PlaybackRateMenuButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

updateVisibility()

Hide playback rate controls when they're no playback rate options to select

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/playback-rate-menu/playback-rate-menu-button.js line number: 135

[back to top]

createItems()

Create the list of menu items. Specific to each subclass.

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 92

[back to top]

handleKeyPress( event )

Handle key press on menu

Parameters

nameTypeRequiredDescription
eventObjectyesKey press event

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 151

[back to top]

handleSubmenuKeyPress( event )

Handle key press on submenu

Parameters

nameTypeRequiredDescription
eventObjectyesKey press event

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 179

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

PlaybackRateMenuButton

The component for controlling the playback rate

DEFINED IN: playback-rate-menu-button.js line number: 10

EXTENDS: menu-button.js

Constructor

PlaybackRateMenuButton( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

updateVisibility()

Hide playback rate controls when they're no playback rate options to select

Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/playback-rate-menu/playback-rate-menu-button.js line number: 135

[back to top]

createItems()

Create the list of menu items. Specific to each subclass.

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 92

[back to top]

handleKeyPress( event )

Handle key press on menu

Parameters

nameTypeRequiredDescription
eventObjectyesKey press event

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 151

[back to top]

handleSubmenuKeyPress( event )

Handle key press on submenu

Parameters

nameTypeRequiredDescription
eventObjectyesKey press event

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 179

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/playback-rate-menu-item.html b/docs/legacy-docs/api/playback-rate-menu-item.html index 432d3b0e3..717586762 100644 --- a/docs/legacy-docs/api/playback-rate-menu-item.html +++ b/docs/legacy-docs/api/playback-rate-menu-item.html @@ -1,6 +1,9 @@ PlaybackRateMenuItem

API Index

PlaybackRateMenuItem

The specific menu item type for selecting a playback rate

DEFINED IN: playback-rate-menu-item.js line number: 7

EXTENDS: menu-item.js

Constructor

PlaybackRateMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's + + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

PlaybackRateMenuItem

The specific menu item type for selecting a playback rate

DEFINED IN: playback-rate-menu-item.js line number: 7

EXTENDS: menu-item.js

Constructor

PlaybackRateMenuItem( player,[options] )

Parameters

nameTypeRequiredDescription
playerPlayer|Object
optionsObject

Methods

createEl( [type], [props] )

Create the component's DOM element

Parameters

nameTypeRequiredDescription
typeStringnoDesc
propsObjectnoDesc

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34

[back to top]

selected( selected )

Set this menu item as selected or not

Parameters

nameTypeRequiredDescription
selectedBoolean

Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59

[back to top]

addChild( child, [options] ) (deprecated)

Adds a child component inside this button

Parameters

nameTypeRequiredDescription
childString|ComponentyesThe class name or instance of a child to add
optionsObjectnoOptions, including options to be passed to children of the child.

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57

[back to top]

handleKeyPress()

Handle KeyPress (document level) - Extend with specific functionality for button

Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 74

[back to top]

buildCSSClass()

Allows sub components to stack CSS class names

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 102

[back to top]

controlText( el )

create control text

Parameters

nameTypeRequiredDescription
elElementyesParent element for the control text

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65

[back to top]

handleFocus()

Handle Focus - Add keyboard functionality to element

Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 139

[back to top]

$( selector, [context] )

Finds a single DOM element matching selector within the component's contentEl or another custom context.

Parameters

nameTypeRequiredDescription
selectorStringyesA valid CSS selector, which will be passed to querySelector.
contextElement|StringnoA DOM element within which to query. Can also be a selector string in which case the first matching element will be used as context. If missing (or no element matches selector), falls diff --git a/docs/legacy-docs/api/player.html b/docs/legacy-docs/api/player.html index 2a732441e..8f1b34421 100644 --- a/docs/legacy-docs/api/player.html +++ b/docs/legacy-docs/api/player.html @@ -1,6 +1,9 @@ Player

API Index

Player

An instance of the Player class is created when any of the Video.js setup methods are used to initialize a video.

+ + +

This documentation is for an outdated version of Video.js. See documentation for the current release. +

API Index

Player

An instance of the Player class is created when any of the Video.js setup methods are used to initialize a video.

var myPlayer = videojs('example_video_1');

In the following example, the data-setup attribute tells the Video.js library to create a player instance when the library is ready.