Video.js

https://docs.videojs.com/
Admin
Video.js is an open-source HTML5 video player framework that provides a common JavaScript and CSS...
Tokens:66,913
Snippets:947
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### start()

Source: https://docs.videojs.com/spatialnavigation

Starts the spatial navigation by adding a keydown event listener.

```APIDOC
## start()

### Description
Starts the spatial navigation by adding a keydown event listener to the video container. This method ensures that the event listener is added only once.
```

--------------------------------

### preload()

Source: https://docs.videojs.com/html5

Gets the preload setting.

```APIDOC
## preload()

### Description
Get the value of `preload` from the media element. `preload` indicates what should download before the media is interacted with.

### Returns
- **string** - Will be 'none', 'metadata', or 'auto'.
```

--------------------------------

### Set or get the player source

Source: https://docs.videojs.com/player

Executes source setting and getting logic. It is highly recommended to use an object or array of objects for the source parameter to allow for proper source selection.

```javascript
```
| |    If not provided, this method acts as a getter.  
---|---  

```
```

--------------------------------

### readyState()

Source: https://docs.videojs.com/html5

Get the current ready state of the media element.

```APIDOC
## readyState()

### Description
Returns the current ready state of the media element as an enumeration (0-4).

### Returns
- **number** - The ready state value.
```

--------------------------------

### handleLateInit_()

Source: https://docs.videojs.com/html5

Triggers a loadstart event if the media has already started loading before the player was ready.

```APIDOC
## handleLateInit_()

### Description
This will be triggered if the loadstart event has already fired, before videojs was ready. This function will fire another loadstart so that videojs can catchup.

### Returns
- **undefined** - returns nothing.
```

--------------------------------

### Initialize Plugins with Options

Source: https://docs.videojs.com/tutorial-options.html

Automatically initialize plugins with custom options during player setup. Note that the initialization order is not guaranteed when using this method.

```javascript
videojs('my-player', {
  plugins: {
    foo: {bar: true},
    boo: {baz: false}
  }
});
```

```javascript
var player = videojs('my-player');

player.foo({bar: true});
player.boo({baz: false});
```

--------------------------------

### Localize string with tokens

Source: https://docs.videojs.com/button

Example of defining localization keys and using the localize method with token replacement.

```json
{
  "progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}
```

```javascript
this.localize('progress bar timing: currentTime={1} duration{2}',
              [this.player_.currentTime(), this.player_.duration()],
              '{1} of {2}');
```

--------------------------------

### getMedia()

Source: https://docs.videojs.com/player

Get a clone of the current Player~MediaObject for this player.

```APIDOC
## getMedia()

### Description
Get a clone of the current Player~MediaObject for this player. If the `loadMedia` method has not been used, will attempt to return a Player~MediaObject based on the current state of the player.

### Returns
- **Player~MediaObject** - A clone of the current media object.
```

--------------------------------

### name()

Source: https://docs.videojs.com/button

Get the Component's name.

```APIDOC
## name()

### Description
Get the Component's name. The name gets used to reference the Component and is set during registration.

### Returns
- **string** - The name of this Component.
```

--------------------------------

### volume(percentAsDecimal)

Source: https://docs.videojs.com/player

Gets or sets the current volume of the media.

```APIDOC
## volume(percentAsDecimal)

### Description
Get or set the current volume of the media.

### Parameters
- **percentAsDecimal** (number) - Optional - The new volume as a decimal percent (0 to 1.0).

### Returns
- **number | undefined** - The current volume as a percent when getting.
```

--------------------------------

### content(value)

Source: https://docs.videojs.com/modaldialog

Gets or sets the modal content.

```APIDOC
## content(value)

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

### Parameters
- **value** (ContentDescriptor) - Optional - If defined, sets the internal content value to be used on the next call(s) to `fill`.

### Returns
- **ContentDescriptor** - The current content of the modal dialog.
```

--------------------------------

### defaultMuted()

Source: https://docs.videojs.com/html5

Get the value of defaultMuted from the media element, indicating whether the media should start muted.

```APIDOC
## defaultMuted()

### Description
Get the value of `defaultMuted` from the media element. `defaultMuted` indicates whether the media should start muted or not.

### Returns
- **boolean** - True indicates that the media should start muted. False indicates that the media should not start muted.
```

--------------------------------

### new Html5(options, ready)

Source: https://docs.videojs.com/html5

Creates a new instance of the Html5 media controller.

```APIDOC
## new Html5(options, ready)

### Description
Creates an instance of the Html5 Tech.

### Parameters
- **options** (Object) - Optional - The key/value store of player options.
- **ready** (function) - Optional - Callback function to call when the HTML5 Tech is ready.
```

--------------------------------

### formatTime(seconds, guide)

Source: https://docs.videojs.com/module-time

Formats seconds into a time string, delegating to the default or custom implementation.

```APIDOC
## formatTime(seconds, guide)

### Description
Formats seconds as a time string (H:MM:SS or M:SS). Supplying a guide (in seconds) will force a number of leading zeros to cover the length of the guide.

### Parameters
- **seconds** (number) - Required - Number of seconds to be turned into a string.
- **guide** (number) - Required - Number (in seconds) to model the string after.

### Returns
- **string** - Time formatted as H:MM:SS or M:SS.
```

--------------------------------

### responsive(value)

Source: https://docs.videojs.com/player

Get or set a flag indicating whether or not this player should adjust its UI based on its dimensions.

```APIDOC
## responsive(value)

### Description
Get or set a flag indicating whether or not this player should adjust its UI based on its dimensions.

### Parameters
- **value** (boolean) - Optional - Should be true if the player should adjust its UI based on its dimensions; otherwise, should be false.

### Returns
- **boolean|undefined** - Will be true if this player should adjust its UI based on its dimensions; otherwise, will be false. Nothing if setting.
```

--------------------------------

### new VolumeLevelTooltip(player, options)

Source: https://docs.videojs.com/volumeleveltooltip

Creates an instance of the VolumeLevelTooltip class, attaching it to the specified player.

```APIDOC
## new VolumeLevelTooltip(player, options)

### Description
Creates an instance of this class.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### playsinline()

Source: https://docs.videojs.com/html5

Gets the playsinline status.

```APIDOC
## playsinline()

### Description
Get the value of `playsinline` from the media element. `playsinline` indicates to the browser that non-fullscreen playback is preferred when fullscreen playback is the native default.

### Returns
- **boolean** - True indicates that the media should play inline, false indicates that the media should not play inline.
```

--------------------------------

### play()

Source: https://docs.videojs.com/player

Attempt to begin playback at the first opportunity.

```APIDOC
## play()

### Description
Attempt to begin playback at the first opportunity.

### Returns
- Promise|undefined: Returns a promise if the browser supports Promises.
```

--------------------------------

### getProgress()

Source: https://docs.videojs.com/volumebar

Get the percentage of the bar that should be filled.

```APIDOC
## getProgress()

### Description
Get the percentage of the bar that should be filled but clamped and rounded.

### Returns
- **number** - Percentage filled that the slider is.
```

--------------------------------

### getPercent()

Source: https://docs.videojs.com/volumebar

Get percent of volume level.

```APIDOC
## getPercent()

### Description
Get percent of volume level.

### Returns
- **number** - Volume level percent as a decimal number.
```

--------------------------------

### buffered()

Source: https://docs.videojs.com/tech

Gets the buffered time range.

```APIDOC
## buffered()

### Description
Get and create a `TimeRange` object for buffering.

### Returns
- **TimeRange** - The created time range object.
```

--------------------------------

### new Player(tag, options, ready)

Source: https://docs.videojs.com/player

Creates a new instance of the Player class using a video DOM element.

```APIDOC
## new Player(tag, options, ready)

### Description
Create an instance of the Player class.

### Parameters
- **tag** (Element) - Required - The original video DOM element used for configuring options.
- **options** (Object) - Optional - Object of option names and values.
- **ready** (PlayerReadyCallback) - Optional - Ready callback function.
```

--------------------------------

### Define Localization Mapping

Source: https://docs.videojs.com/errordisplay

Example JSON structure for defining localization keys and their corresponding localized strings with token placeholders.

```json
| {  
---|---  
|   "progress bar timing: currentTime={1} duration={2}": "{1} of {2}"  
| }
```

--------------------------------

### getCache()

Source: https://docs.videojs.com/player

Get object for cached values.

```APIDOC
## getCache()

### Description
Get object for cached values.

### Returns
- **Object** - The current object cache.
```

--------------------------------

### ready(fn)

Source: https://docs.videojs.com/chaptersbutton

Bind a listener to the component's ready state.

```APIDOC
### ready(fn)

**Parameters:**
- **fn** (ReadyCallback) - Required - Function to call when the component is ready.
```

--------------------------------

### getTagSettings(tag)

Source: https://docs.videojs.com/player

Static method to get settings from a player tag.

```APIDOC
## getTagSettings(tag)

### Description
Gets tag settings for a player.

### Parameters
- **tag** (Element) - Required - The player tag.

### Returns
- **Object** - An object containing all of the settings for a player tag.
```

--------------------------------

### updateFocusableComponents()

Source: https://docs.videojs.com/spatialnavigation

Gets a set of focusable components.

```APIDOC
## updateFocusableComponents()

### Description
Gets a set of focusable components.

### Returns
- **Array** - Returns an array of focusable components.
```

--------------------------------

### new Plugin(player)

Source: https://docs.videojs.com/plugin

Creates an instance of the Plugin class. Sub-classes should call super to ensure proper initialization.

```APIDOC
## new Plugin(player)

### Description
Creates an instance of this class. Sub-classes should call `super` to ensure plugins are properly initialized.

### Parameters
- **player** (Player) - Required - A Video.js player instance.
```

--------------------------------

### initChildren()

Source: https://docs.videojs.com/seekbar

Initializes child components.

```APIDOC
## initChildren()

### Description
Add and initialize default child components based upon options.
```

--------------------------------

### setDefaultPlaybackRate()

Source: https://docs.videojs.com/html5

Gets the default playback rate.

```APIDOC
### setDefaultPlaybackRate()

### Description
Retrieves the 'defaultPlaybackRate' from the media element.

### Returns
- **rate** (number) - The current default playback speed, where 1 is normal speed.
```

--------------------------------

### Define a SourceObject

Source: https://docs.videojs.com/global

Examples of valid source definitions, which can be either an object with src and type properties or a simple string URL.

```javascript
var SourceObject = {src: 'http://ex.com/video.mp4', type: 'video/mp4'}; var SourceString = 'http://example.com/some-video.mp4';
```

--------------------------------

### poster()

Source: https://docs.videojs.com/html5

Gets the poster image URL.

```APIDOC
## poster()

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

### Returns
- **string** - A url to an image.
```

--------------------------------

### createMenu()

Source: https://docs.videojs.com/captionsbutton

Creates the menu and adds all items to it.

```APIDOC
## createMenu()

### Description
Create the menu and add all items to it.

### Returns
- **Menu** - The constructed menu.
```

--------------------------------

### loop(valueopt)

Source: https://docs.videojs.com/player

Get or set the loop attribute on the video element.

```APIDOC
## loop(valueopt)

### Description
Get or set the loop attribute on the video element.

### Parameters
- **value** (boolean) - Optional - true means that we should loop the video, false means that we should not loop the video

### Returns
- **boolean|undefined** - The current value of loop when getting, nothing when setting
```

--------------------------------

### language(codeopt)

Source: https://docs.videojs.com/player

Set or get the player's language code.

```APIDOC
## language(codeopt)

### Description
Set or get the player's language code. Changing the language will trigger languagechange which Components can use to update control text.

### Parameters
- **code** (string) - Optional - The language code to set the player to

### Returns
- **string|undefined** - The current language code when getting, nothing when setting
```

--------------------------------

### new TextTrackDisplay(player, options, ready)

Source: https://docs.videojs.com/texttrackdisplay

Creates an instance of the TextTrackDisplay component and attaches it to the specified player.

```APIDOC
## new TextTrackDisplay(player, options, ready)

### Description
Creates an instance of the TextTrackDisplay class.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
- **ready** (function) - Optional - The function to call when TextTrackDisplay is ready.
```

--------------------------------

### played()

Source: https://docs.videojs.com/html5

Gets the time ranges that have been played.

```APIDOC
## played()

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

### Returns
- **TimeRange** - A `TimeRange` object indicating the ranges of time that have been played.
```

--------------------------------

### getVideoPlaybackQuality()

Source: https://docs.videojs.com/html5

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

```APIDOC
## getVideoPlaybackQuality()

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

### Returns
- **Object** - An object with supported media playback quality metrics
```

--------------------------------

### playbackRate()

Source: https://docs.videojs.com/html5

Gets the current playback speed.

```APIDOC
## playbackRate()

### Description
Get the value of `playbackRate` from the media element. `playbackRate` indicates the rate at which the media is currently playing back.

### Returns
- **number** - A number indicating the current playback speed of the media, where 1 is normal speed.
```

--------------------------------

### new TextTrackSettings(player, options)

Source: https://docs.videojs.com/texttracksettings

Creates an instance of the TextTrackSettings class attached to a specific player.

```APIDOC
## new TextTrackSettings(player, options)

### Description
Creates an instance of this class.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### content()

Source: https://docs.videojs.com/errordisplay

Gets the localized error message.

```APIDOC
## content()

### Description
Gets the localized error message based on the `Player`s error.

### Returns
- **string** - The `Player`s error message localized or an empty string.
```

--------------------------------

### duration(secondsopt)

Source: https://docs.videojs.com/player

Normally gets the length in time of the video in seconds.

```APIDOC
## duration(secondsopt)

### Description
Normally gets the length in time of the video in seconds. The video must have started loading before the duration can be known.

### Parameters
- **seconds** (number) - Optional - The duration of the video to set in seconds

### Returns
- (number|undefined) - The duration of the video in seconds when getting - Nothing when setting
```

--------------------------------

### load()

Source: https://docs.videojs.com/player

Begin loading the src data.

```APIDOC
## load()

### Description
Begin loading the src data.
```

--------------------------------

### new AudioTrack(options)

Source: https://docs.videojs.com/audiotrack

Creates a new instance of an AudioTrack.

```APIDOC
## new AudioTrack(options)

### Description
Creates an instance of the AudioTrack class.

### Parameters
- **options** (Object) - Optional - Object of option names and values.
  - **kind** (AudioTrack~Kind) - Optional - A valid audio track kind.
  - **id** (string) - Optional - A unique id for this AudioTrack.
  - **label** (string) - Optional - The menu label for this track.
  - **language** (string) - Optional - A valid two character language code.
  - **enabled** (boolean) - Optional - If this track is the one that is currently playing.
```

--------------------------------

### id()

Source: https://docs.videojs.com/button

Get this Component's ID.

```APIDOC
## id()

### Description
Get this Component's ID.

### Returns
- **string** - The id of this Component.
```

--------------------------------

### initChildren()

Source: https://docs.videojs.com/descriptionsbutton

Add and initialize default child Components based upon options.

```APIDOC
## initChildren()

### Description
Add and initialize default child Components based upon options.
```

--------------------------------

### error(err)

Source: https://docs.videojs.com/tech

Get or set an error on the Tech.

```APIDOC
## error(err)

### Description
Get or set an error on the Tech.

### Parameters
- **err** (MediaError) - Optional - Error to set on the Tech

### Returns
- **MediaError|null** - The current error object on the tech, or null if there isn't one.
```

--------------------------------

### Configure Video Preload Behavior

Source: https://docs.videojs.com/tutorial-options.html

Control how the video player preloads video content. Options include immediate loading, metadata loading only, or no preloading until playback starts.

```javascript
videojs.options.preload = 'auto';
```

```javascript
videojs.options.preload = 'metadata';
```

```javascript
videojs.options.preload = 'none';
```

--------------------------------

### videojs(id, options, ready)

Source: https://docs.videojs.com/module-videojs-videojs

Initializes a new video player instance or retrieves an existing one using a video element or ID.

```APIDOC
## videojs(id, options, ready)

### Description
The `videojs()` function is the main entry point for creating a Player instance. It can also be used to retrieve a pre-existing player instance, though `videojs.getPlayer()` is recommended for that purpose.

### Parameters
- **id** (string|Element) - Required - Video element or video element ID.
- **options** (Object) - Optional - Options object for providing settings.
- **ready** (Component~ReadyCallback) - Optional - A function to be called when the Player and Tech are ready.

### Returns
- **Player** - Returns a Player instance.
```

--------------------------------

### languages()

Source: https://docs.videojs.com/player

Get the player's language dictionary.

```APIDOC
## languages()

### Description
Get the player's language dictionary. Languages specified directly in the player options have precedence.

### Returns
- **Array** - An array of supported languages
```

--------------------------------

### ready

Source: https://docs.videojs.com/button

Triggered when a Component is ready.

```APIDOC
## ready

### Description
Triggered when a Component is ready.

### Type
Event
```

--------------------------------

### Custom Player Hotkey Handler

Source: https://docs.videojs.com/tutorial-options.html

Provide a custom function to `userActions.hotkeys` to define specific key behaviors. This example pauses with 'x' and plays with 'y'.

```javascript
var player = videojs('my-player', {
  userActions: {
    hotkeys: function(event) {
      // `this` is the player in this context

      // `x` key = pause
      if (event.which === 88) {
        this.pause();
      }
      // `y` key = play
      if (event.which === 89) {
        this.play();
      }
    }
  }
});
```

--------------------------------

### breakpoints(breakpoints)

Source: https://docs.videojs.com/player

Get or set breakpoints on the player.

```APIDOC
## breakpoints(breakpoints)

### Description
Get or set breakpoints on the player. Calling this method with an object or true will remove any previous custom breakpoints and start from the defaults again.

### Parameters
- **breakpoints** (Object|boolean) - Optional - If an object is given, it can be used to provide custom breakpoints. If true is given, will set default breakpoints.

### Returns
- (Object) - An object mapping breakpoint names to maximum width values.
```

--------------------------------

### enable()

Source: https://docs.videojs.com/audiotrackbutton

Enable the MenuButton.

```APIDOC
## enable()

### Description
Enable the MenuButton. Allow it to be clicked.
```

--------------------------------

### autoplay(value)

Source: https://docs.videojs.com/player

Get or set the autoplay option.

```APIDOC
## autoplay(value)

### Description
Get or set the autoplay option. When this is a boolean it will modify the attribute on the tech. When this is a string the attribute on the tech will be removed and Player will handle autoplay on loadstarts.

### Parameters
- **value** (boolean|string) - Optional - true: autoplay using the browser behavior; false: do not autoplay; 'play': call play() on every loadstart; 'muted': call muted() then play() on every loadstart; 'any': call play() on every loadstart. if that fails call muted() then play().

### Returns
- (boolean|string|undefined) - The current value of autoplay when getting, or nothing when setting.
```

--------------------------------

### initChildren()

Source: https://docs.videojs.com/menubutton

Add and initialize default child components.

```APIDOC
## initChildren()

### Description
Add and initialize default child `Component`s based upon options.
```

--------------------------------

### Define MediaObject text tracks

Source: https://docs.videojs.com/player

Example of properties used for creating remote text tracks within a MediaObject.

```javascript
These objects may have properties like `src`, `kind`, `label`,
and `language`, see Tech#createRemoteTextTrack.
```

--------------------------------

### handleClick(event)

Source: https://docs.videojs.com/mutetoggle

This gets called when an MuteToggle is clicked.

```APIDOC
## handleClick(event)

### Description
This gets called when an MuteToggle is clicked.

### Parameters
- **event** (Event) - Optional - The keydown, tap, or click event that caused this function to be called.
```

--------------------------------

### new Menu(player, options)

Source: https://docs.videojs.com/menu

Creates a new instance of the Menu component.

```APIDOC
## new Menu(player, options)

### Description
Create an instance of the Menu class.

### Parameters
- **player** (Player) - Required - The player that this component should attach to.
- **options** (Object) - Optional - Object of option names and values.
```

--------------------------------

### Configure Child Component Options

Source: https://docs.videojs.com/tutorial-options.html

Pass options to child components, including disabling them, when defining the 'children' as an object. This example configures the controlBar.

```javascript
// This player's ONLY child will be the controlBar. Clearly, this is not the
// ideal method for disabling a grandchild!
videojs('my-player', {
  children: {
    controlBar: {
      fullscreenToggle: false
    }
  }
});
```

--------------------------------

### enable()

Source: https://docs.videojs.com/playbackratemenuitem

Enable the component.

```APIDOC
## enable()

### Description
Enable this component.
```

--------------------------------

### getPluginVersion(name)

Source: https://docs.videojs.com/plugin

Gets the version of a specific plugin.

```APIDOC
## getPluginVersion(name)

### Description
Gets a plugin's version, if available.

### Parameters
- **name** (string) - Required - The name of a plugin.

### Returns
- **(string)** - The plugin's version or an empty string.
```

--------------------------------

### loadMedia(media, ready)

Source: https://docs.videojs.com/player

Populate the player using a MediaObject.

```APIDOC
## loadMedia(media, ready)

### Description
Populate the player using a MediaObject.

### Parameters
- **media** (Player~MediaObject) - Required - A media object.
- **ready** (function) - Required - A callback to be called when the player is ready.
```

--------------------------------

### disablePictureInPicture()

Source: https://docs.videojs.com/html5

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

```APIDOC
## disablePictureInPicture()

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

### Returns
- **boolean** - True indicates that the video can't be played in Picture-In-Picture mode. False indicates that the video can be played in Picture-In-Picture mode.
```

--------------------------------

### show()

Source: https://docs.videojs.com/transientbutton

Shows the button. The button will remain visible for the initialDisplay time (default 4s) and when there is user activity.

```APIDOC
## show()

### Description
Show the button. The button will remain visible for the `initialDisplay` time, default 4s, and when there is user activity.
```

--------------------------------

### defaultPlaybackRate()

Source: https://docs.videojs.com/html5

Get the value of defaultPlaybackRate from the media element.

```APIDOC
## defaultPlaybackRate()

### Description
Get the value of `defaultPlaybackRate` from the media element. `defaultPlaybackRate` indicates the rate at which the media is currently playing back.

### Returns
- **number** - A number indicating the current playback speed of the media, where 1 is normal speed.
```

--------------------------------

### currentTime()

Source: https://docs.videojs.com/html5

Gets the current playback time in seconds.

```APIDOC
## currentTime()

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

### Returns
- **number** - The value of `currentTime` from the media element.
```

--------------------------------

### new Component(player, options)

Source: https://docs.videojs.com/component

Creates a new instance of a UI Component attached to a player.

```APIDOC
## new Component(player, options)

### Description
Creates an instance of the Component class.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of component options.
```

--------------------------------

### Disable Global Auto Setup

Source: https://docs.videojs.com/tutorial-options.html

Prevent the player from automatically setting up media elements with the 'data-setup' attribute. This must be set globally when Video.js is loaded.

```javascript
videojs.options.autoSetup = false;
```

--------------------------------

### new MenuButton(player, options)

Source: https://docs.videojs.com/menubutton

Creates a new instance of the MenuButton class.

```APIDOC
## new MenuButton(player, options)

### Description
Creates an instance of the MenuButton class to be attached to a player.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### el()

Source: https://docs.videojs.com/chapterstrackmenuitem

Get the MenuItem's DOM element.

```APIDOC
## el()

### Description
Get the MenuItem's DOM element.

### Returns
- (Element) - The DOM element for this component.
```

--------------------------------

### el()

Source: https://docs.videojs.com/audiotrackbutton

Get the Component's DOM element.

```APIDOC
## el()

### Description
Get the Component's DOM element.

### Returns
- **Element** - The DOM element for this Component.
```

--------------------------------

### new PlaybackRateMenuItem(player, options)

Source: https://docs.videojs.com/playbackratemenuitem

Creates a new instance of the PlaybackRateMenuItem class.

```APIDOC
## new PlaybackRateMenuItem(player, options)

### Description
Creates an instance of the PlaybackRateMenuItem class to be used within the player.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### new TextTrack(options)

Source: https://docs.videojs.com/module-videojs-videojs.texttrack

Creates a new instance of a TextTrack. This constructor initializes the track with the provided options, including tech reference, kind, mode, and metadata.

```APIDOC
## new TextTrack(options)

### Description
Creates a new instance of the TextTrack class to manage subtitles, captions, or other text-based media tracks.

### Parameters
- **options** (Object) - Required - Configuration object for the track.
  - **tech** (Tech) - Required - A reference to the tech that owns this TextTrack.
  - **kind** (TextTrack~Kind) - Optional - A valid text track kind (default: 'subtitles').
  - **mode** (TextTrack~Mode) - Optional - A valid text track mode (default: 'disabled').
  - **id** (string) - Optional - A unique id for this TextTrack (default: 'vjs_track_' + Guid.newGUID()).
  - **label** (string) - Optional - The menu label for this track.
  - **language** (string) - Optional - A valid two character language code.
  - **srclang** (string) - Optional - A valid two character language code (deprioritized version of language).
  - **src** (string) - Optional - A url to TextTrack cues.
  - **default** (boolean) - Optional - If this track should default to on or off.
```

--------------------------------

### new VideoTrack(options)

Source: https://docs.videojs.com/module-videojs-videojs.videotrack

Creates a new instance of the VideoTrack class.

```APIDOC
## new VideoTrack(options)

### Description
Creates an instance of the VideoTrack class to represent a single video track.

### Parameters
- **options** (Object) - Optional - Object of option names and values.

### Properties
- **kind** (string) - Optional - A valid VideoTrack~Kind.
- **id** (string) - Optional - A unique id for this VideoTrack.
- **label** (string) - Optional - The menu label for this track.
- **language** (string) - Optional - A valid two character language code.
- **selected** (boolean) - Optional - If this track is the one that is currently playing.
```

--------------------------------

### userActive(bool)

Source: https://docs.videojs.com/player

Get or set the user active state.

```APIDOC
## userActive(bool)

### Description
Get or set if the user is active.

### Parameters
- **bool** (boolean) - Optional - True if the user is active, false if inactive.

### Returns
- **(boolean | undefined)** - The current value when getting, nothing when setting.
```

--------------------------------

### (static) canPlaySource(srcObj, options)

Source: https://docs.videojs.com/tech

Check if the tech can support the given source.

```APIDOC
## (static) canPlaySource(srcObj, options)

### Description
Check if the tech can support the given source.

### Parameters
- **srcObj** (Object) - Required - The source object.
- **options** (Object) - Required - The options passed to the tech.

### Returns
- **string** - 'probably', 'maybe', or '' (empty string).
```

--------------------------------

### src(source)

Source: https://docs.videojs.com/player

Get or set the video source for the player.

```APIDOC
## src(source)

### Description
Get or set the video source. It is highly recommended to use an object or array of objects to allow source selection algorithms to use the type property.

### Parameters
- **source** (Tech~SourceObject | Array.<Tech~SourceObject> | string) - Optional - A SourceObject, an array of SourceObjects, or a string URL.

### Returns
- **(string | undefined)** - Returns the current source URL if no argument is provided, otherwise returns undefined.
```

--------------------------------

### seekable()

Source: https://docs.videojs.com/player

Get the TimeRanges of the media that are currently available for seeking to.

```APIDOC
## seekable()

### Description
Get the TimeRanges of the media that are currently available for seeking to.

### Returns
- (TimeRange) - A mock TimeRanges object (following HTML spec).
```

--------------------------------

### new TransientButton(player, options)

Source: https://docs.videojs.com/transientbutton

Constructs a new TransientButton instance.

```APIDOC
## new TransientButton(player, options)

### Description
Creates a new instance of a floating transient button. It is recommended to insert these buttons before the control bar for logical tab order.

### Parameters
- **player** (Player) - Required - The button's player.
- **options** (TransientButtonOptions) - Required - Options for the transient button.
```

--------------------------------

### new ModalDialog(player, options)

Source: https://docs.videojs.com/modaldialog

Creates a new instance of the ModalDialog class and attaches it to the specified player.

```APIDOC
## new ModalDialog(player, options)

### Description
Creates an instance of the ModalDialog class to display content over the video player.

### Parameters
- **player** (Player) - Required - The Player instance that this modal should be attached to.
- **options** (Object) - Optional - Configuration options for the modal.

### Options Properties
- **content** (ContentDescriptor) - Optional - Customized content for the modal.
- **description** (string) - Optional - Text description for accessibility.
- **fillAlways** (boolean) - Optional - Default: false. If true, refreshes content every time the modal opens.
- **label** (string) - Optional - Text label for accessibility.
- **pauseOnOpen** (boolean) - Optional - Default: true. If true, pauses playback when the modal opens and resumes when closed.
- **temporary** (boolean) - Optional - Default: true. If true, the modal is disposed after being closed once.
- **uncloseable** (boolean) - Optional - Default: false. If true, prevents the user from closing the modal via the UI.
```

--------------------------------

### vertical(bool)

Source: https://docs.videojs.com/slider

Gets or sets whether the slider is vertical.

```APIDOC
## vertical(bool)

### Description
Get/set if slider is horizontal or vertical.

### Parameters
- **bool** (boolean) - Optional - true if slider is vertical, false if horizontal.

### Returns
- **boolean** - true if slider is vertical, false if horizontal.
```

--------------------------------

### preload(value)

Source: https://docs.videojs.com/player

Get or set the preload attribute of the player.

```APIDOC
## preload(value)

### Description
Get or set the preload attribute for the player.

### Parameters
- **value** ('none' | 'auto' | 'metadata') - Optional - Preload mode to pass to techSource.

### Returns
- **string | undefined** - The preload attribute value when getting; nothing when setting.
```

--------------------------------

### open()

Source: https://docs.videojs.com/errordisplay

Opens the modal dialog.

```APIDOC
## open()

### Description
Opens the modal.
```

--------------------------------

### playbackRate(rate)

Source: https://docs.videojs.com/player

Gets or sets the current playback rate.

```APIDOC
## playbackRate(rate)

### Description
Gets or sets the current playback rate. A playback rate of 1.0 represents normal speed.

### Parameters
- **rate** (number) - Optional - New playback rate to set.

### Returns
- number|undefined: The current playback rate when getting, or nothing when setting.
```

--------------------------------

### stepForward()

Source: https://docs.videojs.com/volumebar

Increases the volume level for keyboard users.

```APIDOC
## stepForward()

### Description
Increase volume level for keyboard users.
```

--------------------------------

### error(err)

Source: https://docs.videojs.com/player

Set, clear, or get the current MediaError.

```APIDOC
## error(err)

### Description
Set, clear, or get the current MediaError.

### Parameters
- **err** (MediaError|string|number|null) - Optional - A MediaError or a string/number to be turned into a MediaError. Pass null to clear the current error state.

### Returns
- **MediaError|null|undefined** - The current MediaError when getting (or null), or nothing when setting.
```

--------------------------------

### stepForward()

Source: https://docs.videojs.com/menu

Moves to the next (lower) menu item for keyboard users.

```APIDOC
## stepForward()

### Description
Move to next (lower) menu item for keyboard users.
```

--------------------------------

### disablePictureInPicture(valueopt)

Source: https://docs.videojs.com/player

Get or set disable Picture-in-Picture mode.

```APIDOC
## disablePictureInPicture(valueopt)

### Description
Get or set disable Picture-in-Picture mode.

### Parameters
- **value** (boolean) - Optional - true will disable Picture-in-Picture mode - false will enable Picture-in-Picture mode
```

--------------------------------

### Create a sub-logger

Source: https://docs.videojs.com/module-create-logger-createlogger-log

Demonstrates how to create a new sub-logger that chains a new name to the existing logger.

```javascript
mylogger = videojs.log.createLogger('player');
mylogger('foo');
// > VIDEOJS: player: foo
```

--------------------------------

### currentTime(seconds)

Source: https://docs.videojs.com/player

Get or set the current time (in seconds).

```APIDOC
## currentTime(seconds)

### Description
Get or set the current time (in seconds).

### Parameters
- **seconds** (number|string) - Optional - The time to seek to in seconds.

### Returns
- (number|undefined) - The current time in seconds when getting, or nothing when setting.
```

--------------------------------

### enterFullScreen()

Source: https://docs.videojs.com/html5

Requests the HTML5 tech to enter fullscreen mode.

```APIDOC
## enterFullScreen()

### Description
Request that the HTML5 Tech enter fullscreen.
```

--------------------------------

### new PlaybackRateMenuButton(player, options)

Source: https://docs.videojs.com/playbackratemenubutton

Creates a new instance of the PlaybackRateMenuButton component.

```APIDOC
## new PlaybackRateMenuButton(player, options)

### Description
Creates an instance of the PlaybackRateMenuButton class and attaches it to the specified player.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### controls(bool)

Source: https://docs.videojs.com/player

Get or set whether or not the controls are showing.

```APIDOC
## controls(bool)

### Description
Get or set whether or not the controls are showing.

### Parameters
- **bool** (boolean) - Optional - true to turn controls on, false to turn controls off.

### Returns
- (boolean|undefined) - The current value of controls when getting, nothing when setting.
```

--------------------------------

### new AudioTrackList(tracks)

Source: https://docs.videojs.com/audiotracklist

Creates an instance of the AudioTrackList class.

```APIDOC
## new AudioTrackList(tracks)

### Description
Create an instance of this class.

### Parameters
- **tracks** (Array.<AudioTrack>) - Optional - A list of AudioTrack to instantiate the list with.
```

--------------------------------

### height()

Source: https://docs.videojs.com/html5

Get the current height of the HTML5 media element.

```APIDOC
## height()

### Description
Get the current height of the HTML5 media element.

### Returns
- **number** - The height of the HTML5 media element.
```

--------------------------------

### duration()

Source: https://docs.videojs.com/html5

Get the current duration of the HTML5 media element.

```APIDOC
## duration()

### Description
Get the current duration of the HTML5 media element.

### Returns
- **number** - The duration of the media or 0 if there is no duration.
```

--------------------------------

### fullscreen

Source: https://docs.videojs.com/tutorial-options.html

Configures fullscreen options for the player. The `options` property can be used to pass specific fullscreen settings.

```APIDOC
## fullscreen

### Description
Configures fullscreen options for the player.

### Type
`Object`

### Default
`{options: {navigationUI: 'hide'}}`

### Sub-options
#### options
> Type: `Object`
> Default: `{navigationUI: 'hide'}`
> See The Fullscreen API Spec for more details.
```

--------------------------------

### controls()

Source: https://docs.videojs.com/html5

Gets the value of the controls property from the media element.

```APIDOC
## controls()

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

### Returns
- **boolean** - True indicates that native controls should be showing, false indicates they should be hidden.
```

--------------------------------

### new SeekToLive(player, options)

Source: https://docs.videojs.com/seektolive

Creates a new instance of the SeekToLive component and attaches it to the specified player.

```APIDOC
## new SeekToLive(player, options)

### Description
Creates an instance of the SeekToLive class to be attached to a player.

### Parameters
- **player** (Player) - Required - The Player that this class should be attached to.
- **options** (Object) - Optional - The key/value store of player options.
```

--------------------------------

### supportsFullScreen()

Source: https://docs.videojs.com/html5

Checks if the current environment supports fullscreen mode.

```APIDOC
## supportsFullScreen()

### Description
Check if fullscreen is supported on the video element.

### Returns
- **boolean** - True if fullscreen is supported, false otherwise.
```

--------------------------------

### level(lvl)

Source: https://docs.videojs.com/module-create-logger-createlogger-log

Get or set the current logging level.

```APIDOC
## level(lvl)

### Description
Get or set the current logging level. If a string matching a key from log.levels is provided, acts as a setter.

### Parameters
- **lvl** ('all' | 'debug' | 'info' | 'warn' | 'error' | 'off') - Optional - Pass a valid level to set a new logging level.

### Returns
- **string** - The current logging level.
```

--------------------------------

### currentWidth()

Source: https://docs.videojs.com/button

Gets the computed width of the component's element.

```APIDOC
## currentWidth()

### Description
Get the computed width of the component's element.

### Returns
- **number** - The computed width of the component's element.
```

--------------------------------

### ready(fn)

Source: https://docs.videojs.com/button

Bind a listener to the component's ready state. If the ready event has already occurred, the function triggers immediately.

```APIDOC
## ready(fn)

### Description
Bind a listener to the component's ready state. Different from event listeners in that if the ready event has already happened it will trigger the function immediately.

### Parameters
- **fn** (ReadyCallback) - Required - Function that gets called when the Component is ready.
```

--------------------------------

### enable()

Source: https://docs.videojs.com/chapterstrackmenuitem

Enable this MenuItem.

```APIDOC
## enable()

### Description
Enable this MenuItem.
```

--------------------------------

### currentHeight()

Source: https://docs.videojs.com/button

Gets the computed height of the component's element.

```APIDOC
## currentHeight()

### Description
Get the computed height of the component's element.

### Returns
- **number** - The computed height of the component's element.
```

--------------------------------

### (static) getTech(name)

Source: https://docs.videojs.com/tech

Get a Tech from the shared list by name.

```APIDOC
## (static) getTech(name)

### Description
Get a `Tech` from the shared list by name.

### Parameters
- **name** (string) - Required - `camelCase` or `TitleCase` name of the Tech to get.

### Returns
- **Tech|undefined** - The `Tech` or undefined if there was no tech with the name requested.
```

--------------------------------

### createEl()

Source: https://docs.videojs.com/volumeleveltooltip

Creates the volume tooltip DOM element.

```APIDOC
## createEl()

### Description
Create the volume tooltip DOM element.

### Returns
- **Element** - The element that was created.
```

--------------------------------

### use(type, middleware)

Source: https://docs.videojs.com/module-videojs-videojs

Defines a middleware that the player should use.

```APIDOC
## use(type, middleware)

### Description
Define a middleware that the player should use by way of a factory function that returns a middleware object.

### Parameters
- **type** (string) - Required - The MIME type to match or "*" for all MIME types.
- **middleware** (MiddlewareFactory) - Required - A middleware factory function.
```

--------------------------------

### poster(src)

Source: https://docs.videojs.com/player

Get or set the poster image source url.

```APIDOC
## poster(src)

### Description
Get or set the poster image source url.

### Parameters
- **src** (string) - Optional - Poster image source URL.

### Returns
- string|undefined: The current value of poster when getting, or nothing when setting.
```

--------------------------------

### createItems(items)

Source: https://docs.videojs.com/audiotrackbutton

Creates a menu item for each audio track available in the player.

```APIDOC
## createItems(items)

### Description
Create a menu item for each audio track.

### Parameters
- **items** (Array.<AudioTrackMenuItem>) - Optional - An array of existing menu items to use.

### Returns
- **Array.<AudioTrackMenuItem>** - An array of menu items
```

--------------------------------

### liveui

Source: https://docs.videojs.com/tutorial-options.html

Enables a new live UI that includes a seeking progress bar and a button to jump to the live edge.

```APIDOC
## liveui

### Description
Allows the player to use the new live UI that includes a progress bar for seeking within the live window and a button to seek to the live edge.

### Type
`boolean`

### Default
`false` (will default to `true` in a future version)
```

--------------------------------

### muted(mutedopt)

Source: https://docs.videojs.com/player

Get the current muted state, or turn mute on or off.

```APIDOC
## muted(mutedopt)

### Description
Get the current muted state, or turn mute on or off.

### Parameters
- **muted** (boolean) - Optional - true to mute, false to unmute

### Returns
- **boolean|undefined** - true if mute is on and getting, false if mute is off and getting, nothing if setting
```

--------------------------------

### emulateTextTracks()

Source: https://docs.videojs.com/html5

Emulate texttracks.

```APIDOC
## emulateTextTracks()

### Description
Emulate texttracks.
```

--------------------------------

### createMenu()

Source: https://docs.videojs.com/chaptersbutton

Creates a new menu from the chapter track.

```APIDOC
## createMenu()

### Description
Create menu from chapter track.

### Returns
- **Menu** - New menu for the chapter buttons
```

--------------------------------

### language

Source: https://docs.videojs.com/tutorial-options.html

Sets the initial language for the player. This can be overridden later.

```APIDOC
## language

### Description
Sets the initial language for a player. This can always be changed after player creation.

### Type
`string`

### Default
Browser default or `'en'`
```

--------------------------------

### handleKeyDown(event)

Source: https://docs.videojs.com/player

Called when this Player has focus and a key gets pressed down.

```APIDOC
## handleKeyDown(event)

### Description
Called when this Player has focus and a key gets pressed down, or when any Component of this player receives a key press that it doesn't handle.

### Parameters
- **event** (KeyboardEvent) - Required - The `keydown` event that caused this function to be called.
```

--------------------------------

### createItems()

Source: https://docs.videojs.com/captionsbutton

Creates caption menu items.

```APIDOC
## createItems()

### Description
Create caption menu items.

### Returns
- **Array.<CaptionSettingsMenuItem>** - The array of current menu items.
```

--------------------------------

### reset()

Source: https://docs.videojs.com/player

Reset the player to its initial state.

```APIDOC
## reset()

### Description
Reset the player. Loads the first tech in the techOrder, removes all the text tracks in the existing tech, and calls reset on the tech.
```

--------------------------------

### defaultPlaybackRate(rateopt)

Source: https://docs.videojs.com/player

Gets or sets the current default playback rate.

```APIDOC
## defaultPlaybackRate(rateopt)

### Description
Gets or sets the current default playback rate. A default playback rate of 1.0 represents normal speed and 0.5 would indicate half-speed playback.

### Parameters
- **rate** (number) - Optional - New default playback rate to set.

### Returns
- (number|undefined) - The default playback rate when getting or 1.0 - Nothing when setting
```

--------------------------------

### bufferedEnd()

Source: https://docs.videojs.com/player

Get the ending time of the last buffered time range.

```APIDOC
## bufferedEnd()

### Description
Get the ending time of the last buffered time range. This is used in the progress bar to encapsulate all time ranges.

### Returns
- (number) - The end of the last buffered time range.
```

--------------------------------

### Configure Responsive Breakpoints

Source: https://docs.videojs.com/tutorial-options.html

Customize breakpoints for responsive UI adjustments. Define max widths for different layout classes.

```javascript
breakpoints: {
  tiny: 300,
  xsmall: 400,
  small: 500,
  medium: 600,
  large: 700,
  xlarge: 800,
  huge: 900
}
```

--------------------------------

### buffered()

Source: https://docs.videojs.com/player

Get a TimeRange object with an array of the times of the video that have been downloaded.

```APIDOC
## buffered()

### Description
Get a TimeRange object with an array of the times of the video that have been downloaded.

### Returns
- (TimeRange) - A mock TimeRanges object (following HTML spec).
```

--------------------------------

### createModal(content, options)

Source: https://docs.videojs.com/player

Creates a simple modal dialog that immediately overlays the player with arbitrary content and removes itself when closed.

```APIDOC
## createModal(content, options)

### Description
Creates a simple modal dialog (an instance of the ModalDialog component) that immediately overlays the player with arbitrary content and removes itself when closed.

### Parameters
- **content** (string|function|Element|Array|null) - The content to display in the modal.
- **options** (Object) - Optional - Extra options passed to the ModalDialog.

### Returns
- (ModalDialog) - The ModalDialog that was created.
```

--------------------------------

### crossOrigin(value)

Source: https://docs.videojs.com/posterimage

Get or set the PosterImage's crossOrigin option.

```APIDOC
## crossOrigin(value)

### Description
Get or set the `PosterImage`'s crossOrigin option.

### Parameters
- **value** (string | null) - Optional - The value to set the crossOrigin to. Must be one of 'anonymous', 'use-credentials', or 'null'.

### Returns
- **string | null** - The current crossOrigin value when getting, or undefined when setting.
```
Tokens:
Raw