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
| name | Type | Required | Description |
|---|---|---|---|
| player | Player|Object | ||
| options | Object |
Methods
buildCSSClass()
Allow sub components to stack CSS class names
createItems()
Create a menu item for each audio track
createEl()
Create the component's DOM element
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 103
createMenu()
Create menu
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 64
disable()
Enable the menu button
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 248
handleClick()
When you click the button it adds focus, which diff --git a/docs/legacy-docs/api/big-play-button.html b/docs/legacy-docs/api/big-play-button.html index 28619b632c..d1698a2251 100644 --- a/docs/legacy-docs/api/big-play-button.html +++ b/docs/legacy-docs/api/big-play-button.html @@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
BigPlayButton Methods
Class Methods
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
BigPlayButton
Initial play button. Shows before the video has played. The hiding of the diff --git a/docs/legacy-docs/api/button.html b/docs/legacy-docs/api/button.html index 5d22a28bb5..f1cf6a9d2d 100644 --- a/docs/legacy-docs/api/button.html +++ b/docs/legacy-docs/api/button.html @@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Button Methods
Class Methods
Inherited Methods from ClickableComponent
Inherited Methods from Component
Button
Base class for all buttons
DEFINED IN: button.js line number: 12
EXTENDS: clickable-component.js
Constructor
Button( player,[options] )Parameters
| name | Type | Required | Description |
|---|---|---|---|
| player | Object | yes | Main Player |
| options | Object | no | Object of option names and values |
Methods
addChild( child, [options] ) (deprecated)
Adds a child component inside this button
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| child | String|Component | yes | The class name or instance of a child to add |
| options | Object | no | Options, 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
createEl( [type], [props], [attributes] )
Create the component's DOM element
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| type | String | no | Element's node type. e.g. 'div' |
| props | Object | no | An object of properties that should be set on the element |
| attributes | Object | no | An 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
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
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
controlText( el )
create control text
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| el | Element | yes | Parent element for the control text |
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65
handleBlur()
Handle Blur - Remove keyboard triggers
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163
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
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
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/caption-settings-menu-item.html b/docs/legacy-docs/api/caption-settings-menu-item.html
index 5d46e68e06..72fe447e74 100644
--- a/docs/legacy-docs/api/caption-settings-menu-item.html
+++ b/docs/legacy-docs/api/caption-settings-menu-item.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
CaptionSettingsMenuItem Methods
Class Methods
Inherited Methods from TextTrackMenuItem
Inherited Methods from MenuItem
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
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
| name | Type | Required | Description |
|---|---|---|---|
| player | Player|Object | ||
| options | Object |
Methods
handleClick()
Handle click on menu item
handleTracksChange()
Handle text track change
createEl( [type], [props] )
Create the component's DOM element
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| type | String | no | Desc |
| props | Object | no | Desc |
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34
selected( selected )
Set this menu item as selected or not
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| selected | Boolean |
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59
addChild( child, [options] ) (deprecated)
Adds a child component inside this button
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| child | String|Component | yes | The class name or instance of a child to add |
| options | Object | no | Options, 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
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
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
controlText( el )
create control text
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| el | Element | yes | Parent element for the control text |
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65
handleBlur()
Handle Blur - Remove keyboard triggers
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163
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
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/captions-button.html b/docs/legacy-docs/api/captions-button.html
index 538ca53a49..be35fa9d47 100644
--- a/docs/legacy-docs/api/captions-button.html
+++ b/docs/legacy-docs/api/captions-button.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
CaptionsButton Methods
Class Methods
Inherited Methods from MenuButton
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
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
| name | Type | Required | Description |
|---|---|---|---|
| player | Object | yes | Player object |
| options | Object | no | Object of option names and values |
| ready | function | no | Ready callback function |
Methods
buildCSSClass()
Allow sub components to stack CSS class names
createItems()
Create caption menu items
update()
Update caption menu items
createEl()
Create the component's DOM element
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 99
createMenu()
Create menu
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 62
handleClick()
When you click the button it adds focus, which diff --git a/docs/legacy-docs/api/captions-track.html b/docs/legacy-docs/api/captions-track.html index 67725e8da0..142aec3b44 100644 --- a/docs/legacy-docs/api/captions-track.html +++ b/docs/legacy-docs/api/captions-track.html @@ -4,7 +4,7 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
ChaptersButton Methods
Class Methods
Inherited Methods from MenuButton
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
ChaptersButton
The button component for toggling and selecting chapters diff --git a/docs/legacy-docs/api/chapters-track-menu-item.html b/docs/legacy-docs/api/chapters-track-menu-item.html index bf9b2c6a14..3c7562c9ea 100644 --- a/docs/legacy-docs/api/chapters-track-menu-item.html +++ b/docs/legacy-docs/api/chapters-track-menu-item.html @@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
ChaptersTrackMenuItem Methods
Class Methods
Inherited Methods from MenuItem
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
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
| name | Type | Required | Description |
|---|---|---|---|
| player | Player|Object | ||
| options | Object |
Methods
handleClick()
Handle click on menu item
update()
Update chapter menu item
createEl( [type], [props] )
Create the component's DOM element
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| type | String | no | Desc |
| props | Object | no | Desc |
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34
selected( selected )
Set this menu item as selected or not
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| selected | Boolean |
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59
addChild( child, [options] ) (deprecated)
Adds a child component inside this button
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| child | String|Component | yes | The class name or instance of a child to add |
| options | Object | no | Options, 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
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
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
controlText( el )
create control text
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| el | Element | yes | Parent element for the control text |
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65
handleBlur()
Handle Blur - Remove keyboard triggers
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163
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
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/chapters-track.html b/docs/legacy-docs/api/chapters-track.html
index 67725e8da0..142aec3b44 100644
--- a/docs/legacy-docs/api/chapters-track.html
+++ b/docs/legacy-docs/api/chapters-track.html
@@ -4,7 +4,7 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
ClickableComponent Methods
Class Methods
Inherited Methods from Component
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
| name | Type | Required | Description |
|---|---|---|---|
| player | Object | yes | Main Player |
| options | Object | no | Object of option names and values |
Methods
addChild( child, [options] )
Adds a child component inside this clickable-component
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| child | String|Component | yes | The class name or instance of a child to add |
| options | Object | no | Options, 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
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
controlText( el )
create control text
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| el | Element | yes | Parent element for the control text |
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65
createEl( [type], [props], [attributes] )
Create the component's DOM element
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| type | String | no | Element's node type. e.g. 'div' |
| props | Object | no | An object of properties that should be set on the element |
| attributes | Object | no | An 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
handleBlur()
Handle Blur - Remove keyboard triggers
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163
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
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
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
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/close-button.html b/docs/legacy-docs/api/close-button.html
index d3ce7bcd5a..132aee657a 100644
--- a/docs/legacy-docs/api/close-button.html
+++ b/docs/legacy-docs/api/close-button.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
CloseButton
The CloseButton component is a button which fires a "close" event
diff --git a/docs/legacy-docs/api/component.html b/docs/legacy-docs/api/component.html
index 0287409896..28a6c784fe 100644
--- a/docs/legacy-docs/api/component.html
+++ b/docs/legacy-docs/api/component.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Component Methods
Class Methods
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
Component
Base UI Component class diff --git a/docs/legacy-docs/api/control-bar.html b/docs/legacy-docs/api/control-bar.html index 7eb1192b65..8339c3ea8e 100644 --- a/docs/legacy-docs/api/control-bar.html +++ b/docs/legacy-docs/api/control-bar.html @@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
ControlBar Methods
Class Methods
Inherited Methods from Component
ControlBar
Container of main controls
DEFINED IN: control-bar.js line number: 24
EXTENDS: component.js
Constructor
ControlBar()Methods
createEl()
Create the component's DOM element
Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/control-bar.js line number: 32
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/current-time-display.html b/docs/legacy-docs/api/current-time-display.html
index ef77f9017a..00c772f165 100644
--- a/docs/legacy-docs/api/current-time-display.html
+++ b/docs/legacy-docs/api/current-time-display.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
CurrentTimeDisplay Methods
Class Methods
Inherited Methods from Component
CurrentTimeDisplay
Displays the current time
DEFINED IN: current-time-display.js line number: 8
EXTENDS: component.js
Constructor
CurrentTimeDisplay( player,[options] )Parameters
| name | Type | Required | Description |
|---|---|---|---|
| player | Player|Object | ||
| options | Object |
Methods
createEl()
Create the component's DOM element
updateContent()
Update current time display
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/custom-control-spacer.html b/docs/legacy-docs/api/custom-control-spacer.html
index 123b3a605d..e0521aad25 100644
--- a/docs/legacy-docs/api/custom-control-spacer.html
+++ b/docs/legacy-docs/api/custom-control-spacer.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
CustomControlSpacer Methods
Class Methods
Inherited Methods from Spacer
Inherited Methods from Component
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
buildCSSClass()
Allow sub components to stack CSS class names
createEl()
Create the component's DOM element
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/duration-display.html b/docs/legacy-docs/api/duration-display.html
index 42dfdf14d4..784e426b4e 100644
--- a/docs/legacy-docs/api/duration-display.html
+++ b/docs/legacy-docs/api/duration-display.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
DurationDisplay Methods
Class Methods
Inherited Methods from Component
DurationDisplay
Displays the duration
DEFINED IN: duration-display.js line number: 8
EXTENDS: component.js
Constructor
DurationDisplay( player,[options] )Parameters
| name | Type | Required | Description |
|---|---|---|---|
| player | Player|Object | ||
| options | Object |
Methods
createEl()
Create the component's DOM element
updateContent()
Update duration time display
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/error-display.html b/docs/legacy-docs/api/error-display.html
index 1a0c86cf59..c4daafe844 100644
--- a/docs/legacy-docs/api/error-display.html
+++ b/docs/legacy-docs/api/error-display.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
ErrorDisplay Methods
Class Methods
Inherited Methods from ModalDialog
Inherited Methods from Component
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.
diff --git a/docs/legacy-docs/api/flash.html b/docs/legacy-docs/api/flash.html index 5b4914f325..56e843202a 100644 --- a/docs/legacy-docs/api/flash.html +++ b/docs/legacy-docs/api/flash.html @@ -1,6 +1,6 @@This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Flash Methods
Class Methods
Inherited Methods from Tech
Inherited Methods from Component
Flash
Flash Media Controller - Wrapper for fallback SWF API
DEFINED IN: flash.js line number: 18
EXTENDS: tech.js
Constructor
Flash( [options],[ready] )Parameters
| name | Type | Required | Description |
|---|---|---|---|
| options | Object | no | Object of option names and values |
| ready | function | no | Ready callback function |
Methods
buffered()
Get buffered time range
Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 271
createEl()
Create the component's DOM element
Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 63
currentSrc()
Get current source
Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 219
currentTime( [time] )
Get current time
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| time | Number | no | Current time of video |
Defined in https://github.com/videojs/video.js/blob/master/src/js/tech/flash.js line number: 203
enterFullScreen()
Request to enter fullscreen diff --git a/docs/legacy-docs/api/fullscreen-toggle.html b/docs/legacy-docs/api/fullscreen-toggle.html index b7f6c4a243..b838a06c64 100644 --- a/docs/legacy-docs/api/fullscreen-toggle.html +++ b/docs/legacy-docs/api/fullscreen-toggle.html @@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
FullscreenToggle Methods
Class Methods
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
FullscreenToggle
Toggle fullscreen video
DEFINED IN: fullscreen-toggle.js line number: 7
EXTENDS: button.js
Constructor
FullscreenToggle()Methods
buildCSSClass()
Allow sub components to stack CSS class names
handleClick()
Handles click for full screen
addChild( child, [options] ) (deprecated)
Adds a child component inside this button
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| child | String|Component | yes | The class name or instance of a child to add |
| options | Object | no | Options, 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
createEl( [type], [props], [attributes] )
Create the component's DOM element
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| type | String | no | Element's node type. e.g. 'div' |
| props | Object | no | An object of properties that should be set on the element |
| attributes | Object | no | An 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
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
controlText( el )
create control text
Parameters
| name | Type | Required | Description |
|---|---|---|---|
| el | Element | yes | Parent element for the control text |
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65
handleBlur()
Handle Blur - Remove keyboard triggers
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163
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
$( selector, [context] )
Finds a single DOM element matching selector within the component's
diff --git a/docs/legacy-docs/api/html-track-element.html b/docs/legacy-docs/api/html-track-element.html
index 2f1e94cdf3..954cb2ebdb 100644
--- a/docs/legacy-docs/api/html-track-element.html
+++ b/docs/legacy-docs/api/html-track-element.html
@@ -1,6 +1,6 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Inherited Methods from Button
Inherited Methods from ClickableComponent
Inherited Methods from Component
HTMLTrackElement
https://html.spec.whatwg.org/multipage/embedded-content.html#htmltrackelement
diff --git a/docs/legacy-docs/api/html5.html b/docs/legacy-docs/api/html5.html index 21271773d4..c95a093123 100644 --- a/docs/legacy-docs/api/html5.html +++ b/docs/legacy-docs/api/html5.html @@ -1,6 +1,6 @@This documentation is for an outdated version of Video.js. See documentation for the current release.
API Index
Html5 Methods
Class Methods
Inherited Methods from Tech
Inherited Methods from Component
Html5
HTML5 Media Controller - Wrapper for HTML5 Media API
DEFINED IN: html5.js line number: 18
EXTENDS: tech.js
Constructor
Html5( [options],[ready] )Parameters
| name | Type | Required | Description |
|---|---|---|---|
| options | Object | no | Object of option names and values |
| ready | function | no | Ready callback function |
Methods
addRemoteTextTrack( options )
Creates a remote text track object and returns a html track element
Parameters
| name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| options | Object | yes | The object should contain values for
diff --git a/docs/legacy-docs/api/index.html b/docs/legacy-docs/api/index.html
index f2db2b7b72..7df81084fc 100644
--- a/docs/legacy-docs/api/index.html
+++ b/docs/legacy-docs/api/index.html
@@ -4,7 +4,7 @@
This documentation is for an outdated version of Video.js. See documentation for the current release.
LiveDisplayDisplays the live indicator diff --git a/docs/legacy-docs/api/load-progress-bar.html b/docs/legacy-docs/api/load-progress-bar.html index 61c69c62b6..5e80b2fff3 100644 --- a/docs/legacy-docs/api/load-progress-bar.html +++ b/docs/legacy-docs/api/load-progress-bar.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
LoadProgressBarShows load progress DEFINED IN: load-progress-bar.js line number: 7 EXTENDS: component.js ConstructorParameters
MethodscreateEl()Create the component's DOM element update()Update progress bar $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
MediaLoaderThe Media Loader is the component that decides which playback technology to load diff --git a/docs/legacy-docs/api/loading-spinner.html b/docs/legacy-docs/api/loading-spinner.html index 37c165521a..7f169d53aa 100644 --- a/docs/legacy-docs/api/loading-spinner.html +++ b/docs/legacy-docs/api/loading-spinner.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
LoadingSpinnerLoading spinner for waiting events DEFINED IN: loading-spinner.js line number: 8 EXTENDS: component.js ConstructorMethodscreateEl()Create the component's DOM element Defined in https://github.com/videojs/video.js/blob/master/src/js/loading-spinner.js line number: 16 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
MenuButtonA button class with a popup menu DEFINED IN: menu-button.js line number: 11 EXTENDS: button.js ConstructorParameters
MethodsbuildCSSClass()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 createEl()Create the component's DOM element Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 99 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 createMenu()Create menu Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 62 handleClick()When you click the button it adds focus, which diff --git a/docs/legacy-docs/api/menu-item.html b/docs/legacy-docs/api/menu-item.html index 49f55c5c80..e2f16557d0 100644 --- a/docs/legacy-docs/api/menu-item.html +++ b/docs/legacy-docs/api/menu-item.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
MenuItemThe component for a menu item. DEFINED IN: menu-item.js line number: 8 EXTENDS: button.js ConstructorParameters
MethodscreateEl( [type], [props] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34 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 selected( selected )Set this menu item as selected or not Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 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 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
MenuThe Menu component is used to build pop up menus, including subtitle and diff --git a/docs/legacy-docs/api/modal-dialog.html b/docs/legacy-docs/api/modal-dialog.html index f3288852f9..201b9644f5 100644 --- a/docs/legacy-docs/api/modal-dialog.html +++ b/docs/legacy-docs/api/modal-dialog.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
ModalDialogThe This documentation is for an outdated version of Video.js. See documentation for the current release.
MouseTimeDisplayThe Mouse Time Display component shows the time you will seek to diff --git a/docs/legacy-docs/api/mute-toggle.html b/docs/legacy-docs/api/mute-toggle.html index 327f2109fb..0aa2e27a00 100644 --- a/docs/legacy-docs/api/mute-toggle.html +++ b/docs/legacy-docs/api/mute-toggle.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
MuteToggleA button component for muting the audio DEFINED IN: mute-toggle.js line number: 8 EXTENDS: button.js ConstructorParameters
MethodsbuildCSSClass()Allow sub components to stack CSS class names Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/mute-toggle.js line number: 39 handleClick()Handle click on mute Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/mute-toggle.js line number: 49 update()Update volume Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/mute-toggle.js line number: 58 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 createEl( [type], [props], [attributes] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
OffTextTrackMenuItemA 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 ConstructorParameters
MethodshandleTracksChange( event )Handle text track change Parameters
handleClick()Handle click on text track createEl( [type], [props] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34 selected( selected )Set this menu item as selected or not Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 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 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PlayProgressBarShows play progress DEFINED IN: play-progress-bar.js line number: 8 EXTENDS: component.js ConstructorParameters
MethodscreateEl()Create the component's DOM element $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PlayToggleButton to toggle between play and pause DEFINED IN: play-toggle.js line number: 7 EXTENDS: button.js ConstructorParameters
MethodsbuildCSSClass()Allow sub components to stack CSS class names Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 24 handleClick()Handle click to toggle between play and pause Defined in https://github.com/videojs/video.js/blob/master/src/js/control-bar/play-toggle.js line number: 34 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 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 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 createEl( [type], [props], [attributes] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 26 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PlaybackRateMenuButtonThe component for controlling the playback rate DEFINED IN: playback-rate-menu-button.js line number: 10 EXTENDS: menu-button.js ConstructorParameters
MethodsbuildCSSClass()Allow sub components to stack CSS class names createEl()Create the component's DOM element createMenu()Create the playback rate menu handleClick()Handle menu item click playbackRates()Get possible playback rates playbackRateSupported()Get supported playback rates updateARIAAttributes()Updates ARIA accessibility attributes updateLabel()Update button label when rate changed updateVisibility()Hide playback rate controls when they're no playback rate options to select 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 handleKeyPress( event )Handle key press on menu Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 151 pressButton()Makes changes based on button pressed Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 199 unpressButton()Makes changes based on button unpressed Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 211 update()Update menu Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 31 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PlaybackRateMenuItemThe specific menu item type for selecting a playback rate DEFINED IN: playback-rate-menu-item.js line number: 7 EXTENDS: menu-item.js ConstructorParameters
MethodshandleClick()Handle click on menu item update()Update playback rate with selected rate createEl( [type], [props] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 34 selected( selected )Set this menu item as selected or not Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-item.js line number: 59 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 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 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PlayerAn instance of the This documentation is for an outdated version of Video.js. See documentation for the current release.
PopupButtonA button class with a popup control DEFINED IN: popup-button.js line number: 11 EXTENDS: clickable-component.js ConstructorParameters
MethodsbuildCSSClass()Allow sub components to stack CSS class names Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup-button.js line number: 69 createEl()Create the component's DOM element Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup-button.js line number: 57 createPopup()Create popup - Override with specific functionality for component Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup-button.js line number: 49 update()Update popup Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup-button.js line number: 27 addChild( child, [options] )Adds a child component inside this clickable-component Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 112 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 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 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PopupThe Popup component is used to build pop up controls. DEFINED IN: popup.js line number: 9 EXTENDS: component.js ConstructorMethodsaddItem( component )Add a popup item to the popup Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup.js line number: 17 createEl()Create the component's DOM element Defined in https://github.com/videojs/video.js/blob/master/src/js/popup/popup.js line number: 30 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
PosterImageThe component that handles showing the poster image. DEFINED IN: poster-image.js line number: 10 EXTENDS: button.js ConstructorParameters
MethodscreateEl()Create the poster's image element Defined in https://github.com/videojs/video.js/blob/master/src/js/poster-image.js line number: 37 dispose()Clean up the poster image Defined in https://github.com/videojs/video.js/blob/master/src/js/poster-image.js line number: 27 handleClick()Event handler for clicks on the poster image Defined in https://github.com/videojs/video.js/blob/master/src/js/poster-image.js line number: 103 setSrc( url )Set the poster source depending on the display method Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/poster-image.js line number: 82 update()Event handler for updates to the player's poster source Defined in https://github.com/videojs/video.js/blob/master/src/js/poster-image.js line number: 63 addChild( child, [options] ) (deprecated)Adds a child component inside this button Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/button.js line number: 57 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 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 controlText( el )create control text Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 65 handleBlur()Handle Blur - Remove keyboard triggers Defined in https://github.com/videojs/video.js/blob/master/src/js/clickable-component.js line number: 163 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 $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
ProgressControlThe Progress Control component contains the seek bar, load progress, diff --git a/docs/legacy-docs/api/remaining-time-display.html b/docs/legacy-docs/api/remaining-time-display.html index ee3dae997d..b131ffd141 100644 --- a/docs/legacy-docs/api/remaining-time-display.html +++ b/docs/legacy-docs/api/remaining-time-display.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
RemainingTimeDisplayDisplays the time left in the video DEFINED IN: remaining-time-display.js line number: 8 EXTENDS: component.js ConstructorParameters
MethodscreateEl()Create the component's DOM element updateContent()Update remaining time display $( selector, [context] )Finds a single DOM element matching This documentation is for an outdated version of Video.js. See documentation for the current release.
SeekBarSeek Bar and holder for the progress bars DEFINED IN: seek-bar.js line number: 12 EXTENDS: slider.js ConstructorParameters
MethodscreateEl()Create the component's DOM element getPercent()Get percentage of video played handleMouseDown()Handle mouse down on seek bar handleMouseMove()Handle mouse move on seek bar handleMouseUp()Handle mouse up on seek bar stepBack()Move more quickly rewind for keyboard-only users stepForward()Move more quickly fast forward for keyboard-only users updateARIAAttributes()Update ARIA accessibility attributes calculateDistance( event )Calculate distance for slider Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/slider/slider.js line number: 149 handleBlur()Handle on blur for slider Defined in https://github.com/videojs/video.js/blob/master/src/js/slider/slider.js line number: 188 handleClick( event )Listener for click events on slider, used to prevent clicks diff --git a/docs/legacy-docs/api/seekhandle.html b/docs/legacy-docs/api/seekhandle.html index 67725e8da0..142aec3b44 100644 --- a/docs/legacy-docs/api/seekhandle.html +++ b/docs/legacy-docs/api/seekhandle.html @@ -4,7 +4,7 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
SliderThe base functionality for sliders like the volume bar and seek bar DEFINED IN: slider.js line number: 9 EXTENDS: component.js ConstructorParameters
MethodscalculateDistance( event )Calculate distance for slider Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/slider/slider.js line number: 149 createEl( type, [props] )Create the component's DOM element Parameters
Defined in https://github.com/videojs/video.js/blob/master/src/js/slider/slider.js line number: 38 handleBlur()Handle on blur for slider Defined in https://github.com/videojs/video.js/blob/master/src/js/slider/slider.js line number: 188 handleClick( event )Listener for click events on slider, used to prevent clicks diff --git a/docs/legacy-docs/api/spacer.html b/docs/legacy-docs/api/spacer.html index ba29ab6012..8712eb6c0e 100644 --- a/docs/legacy-docs/api/spacer.html +++ b/docs/legacy-docs/api/spacer.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
SpacerJust an empty spacer element that can be used as an append point for plugins, etc. diff --git a/docs/legacy-docs/api/subtitles-button.html b/docs/legacy-docs/api/subtitles-button.html index 71494292db..d4139061dc 100644 --- a/docs/legacy-docs/api/subtitles-button.html +++ b/docs/legacy-docs/api/subtitles-button.html @@ -1,6 +1,6 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
SubtitlesButtonThe button component for toggling and selecting subtitles DEFINED IN: subtitles-button.js line number: 7 EXTENDS: text-track-button.js ConstructorParameters
MethodsbuildCSSClass()Allow sub components to stack CSS class names createEl()Create the component's DOM element Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 99 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 createMenu()Create menu Defined in https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 62 handleClick()When you click the button it adds focus, which diff --git a/docs/legacy-docs/api/subtitlestrack.html b/docs/legacy-docs/api/subtitlestrack.html index 67725e8da0..142aec3b44 100644 --- a/docs/legacy-docs/api/subtitlestrack.html +++ b/docs/legacy-docs/api/subtitlestrack.html @@ -4,7 +4,7 @@ This documentation is for an outdated version of Video.js. See documentation for the current release.
TechBase class for media (HTML5 Video, Flash) controllers DEFINED IN: tech.js line number: 21 EXTENDS: component.js ConstructorParameters
MethodsaddRemoteTextTrack( options )Creates a remote text track object and returns a emulated html track element Parameters
|