video.js
Version:
An HTML5 video player that supports HLS and DASH with a common API and skin.
55 lines • 1.61 kB
TypeScript
export default CaptionsButton;
/** @import Player from '../../player' */
/**
* The button component for toggling and selecting captions
*
* @extends TextTrackButton
*/
declare class CaptionsButton extends TextTrackButton {
/**
* Creates an instance of this class.
*
* @param {Player} player
* The `Player` that this class should be attached to.
*
* @param {Object} [options]
* The key/value store of player options.
*
* @param {Function} [ready]
* The function to call when this component is ready.
*/
constructor(player: Player, options?: any, ready?: Function);
/**
* Builds the default DOM `className`.
*
* @return {string}
* The DOM `className` for this object.
*/
buildCSSClass(): string;
buildWrapperCSSClass(): string;
/**
* Create caption menu items
*
* @return {CaptionSettingsMenuItem[]}
* The array of current menu items.
*/
createItems(): CaptionSettingsMenuItem[];
/**
* `kind` of TextTrack to look for to associate it with this menu.
*
* @type {string}
* @private
*/
private kind_;
/**
* The text that should display over the `CaptionsButton`s controls. Added for localization.
*
* @type {string}
* @protected
*/
protected controlText_: string;
}
import TextTrackButton from './text-track-button.js';
import CaptionSettingsMenuItem from './caption-settings-menu-item.js';
import type Player from '../../player';
//# sourceMappingURL=captions-button.d.ts.map