video.js
Version:
An HTML5 video player that supports HLS and DASH with a common API and skin.
106 lines • 3.42 kB
TypeScript
export default ChaptersButton;
/** @import Player from '../../player' */
/** @import Menu from '../../menu/menu' */
/** @import TextTrack from '../../tracks/text-track' */
/** @import TextTrackMenuItem from '../text-track-controls/text-track-menu-item' */
/**
* The button component for toggling and selecting chapters
* Chapters act much differently than other text tracks
* Cues are navigation vs. other tracks of alternative languages
*
* @extends TextTrackButton
*/
declare class ChaptersButton 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 function is ready.
*/
constructor(player: Player, options?: any, ready?: Function);
selectCurrentItem_: () => void;
/**
* Builds the default DOM `className`.
*
* @return {string}
* The DOM `className` for this object.
*/
buildCSSClass(): string;
buildWrapperCSSClass(): string;
/**
* Update the menu based on the current state of its items.
*
* @param {Event} [event]
* An event that triggered this function to run.
*
* @listens TextTrackList#addtrack
* @listens TextTrackList#removetrack
* @listens TextTrackList#change
*/
update(event?: Event): void;
/**
* Set the currently selected track for the chapters button.
*
* @param {TextTrack} track
* The new track to select. Nothing will change if this is the currently selected
* track.
*/
setTrack(track: TextTrack): void;
updateHandler_: any;
track_: any;
/**
* Find the track object that is currently in use by this ChaptersButton
*
* @return {TextTrack|undefined}
* The current track or undefined if none was found.
*/
findChaptersTrack(): TextTrack | undefined;
/**
* Get the caption for the ChaptersButton based on the track label. This will also
* use the current tracks localized kind as a fallback if a label does not exist.
*
* @return {string}
* The tracks current label or the localized track kind.
*/
getMenuCaption(): string;
/**
* Create menu from chapter track
*
* @return {Menu}
* New menu for the chapter buttons
*/
createMenu(): Menu;
/**
* Create a menu item for each text track
*
* @return {TextTrackMenuItem[]}
* Array of menu items
*/
createItems(): TextTrackMenuItem[];
/**
* `kind` of TextTrack to look for to associate it with this menu.
*
* @type {string}
* @private
*/
private kind_;
/**
* The text that should display over the `ChaptersButton`s controls. Added for localization.
*
* @type {string}
* @protected
*/
protected controlText_: string;
}
import TextTrackButton from './text-track-button.js';
import type TextTrack from '../../tracks/text-track';
import type Menu from '../../menu/menu';
import type TextTrackMenuItem from '../text-track-controls/text-track-menu-item';
import type Player from '../../player';
//# sourceMappingURL=chapters-button.d.ts.map