video.js
Version:
An HTML5 video player that supports HLS and DASH with a common API and skin.
134 lines • 4.31 kB
TypeScript
export default SeekBar;
/**
* Seek bar and container for the progress bars. Uses {@link PlayProgressBar}
* as its `bar`.
*
* @extends Slider
*/
declare class SeekBar extends Slider {
/**
* 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 {number} [options.stepSeconds=5]
* The number of seconds to increment on keyboard control
* @param {number} [options.pageMultiplier=12]
* The multiplier of stepSeconds that PgUp/PgDown move the timeline.
*/
constructor(player: Player, options?: {
stepSeconds?: number;
pageMultiplier?: number;
});
shouldDisableSeekWhileScrubbing_: boolean;
pendingSeekTime_: number;
/**
* Sets the event handlers
*
* @private
*/
private setEventHandlers_;
/**
* This function updates the play progress bar and accessibility
* attributes to whatever is passed in.
*
* @param {Event} [event]
* The `timeupdate` or `ended` event that caused this to run.
*
* @listens Player#timeupdate
*
* @return {number}
* The current percent at a number from 0-1
*/
update(event?: Event): number;
updateInterval: number;
enableIntervalHandler_: (e: any) => void;
disableIntervalHandler_: (e: any) => void;
toggleVisibility_(e: any): void;
enableInterval_(): void;
disableInterval_(e: any): void;
/**
* Create the `Component`'s DOM element
*
* @return {Element}
* The element that was created.
*/
createEl(): Element;
percent_: any;
currentTime_: any;
duration_: any;
/**
* Prevent liveThreshold from causing seeks to seem like they
* are not happening from a user perspective.
*
* @param {number} ct
* current time to seek to
*/
userSeek_(ct: number): void;
/**
* Get the value of current time but allows for smooth scrubbing,
* when player can't keep up.
*
* @return {number}
* The current time value to display
*
* @private
*/
private getCurrentTime_;
/**
* Getter and setter for pendingSeekTime.
* Ensures the value is clamped between 0 and duration.
*
* @param {number|null} [time] - Optional. The new pending seek time, can be a number or null.
* @return {number|null} - The current pending seek time.
*/
pendingSeekTime(time?: number | null): number | null;
/**
* Get the percentage of media played so far.
*
* @return {number}
* The percentage of media played so far (0 to 1).
*/
getPercent(): number;
videoWasPlaying: boolean;
/**
* Handle mouse move on seek bar
*
* @param {MouseEvent} event
* The `mousemove` event that caused this to run.
* @param {boolean} mouseDown this is a flag that should be set to true if `handleMouseMove` is called directly. It allows us to skip things that should not happen if coming from mouse down but should happen on regular mouse move handler. Defaults to false
*
* @listens mousemove
*/
handleMouseMove(event: MouseEvent, mouseDown?: boolean): void;
/**
* Handles pending seek time when `disableSeekWhileScrubbingOnSTV` is enabled.
*
* @param {number} stepAmount - The number of seconds to step (positive for forward, negative for backward).
*/
handlePendingSeek_(stepAmount: number): void;
/**
* Move more quickly fast forward for keyboard-only users
*/
stepForward(): void;
/**
* Move more quickly rewind for keyboard-only users
*/
stepBack(): void;
/**
* Toggles the playback state of the player
* This gets called when enter or space is used on the seekbar
*
* @param {KeyboardEvent} event
* The `keydown` event that caused this function to be called
*
*/
handleAction(event: KeyboardEvent): void;
dispose(): void;
}
import Slider from '../../slider/slider.js';
import type Player from '../../player';
//# sourceMappingURL=seek-bar.d.ts.map