0.2.4 • Published 6 months ago
@types/videojs-hotkeys v0.2.4
Installation
npm install --save @types/videojs-hotkeys
Summary
This package contains type definitions for videojs-hotkeys (https://github.com/ctd1500/videojs-hotkeys).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/videojs-hotkeys.
index.d.ts
// Type definitions for videojs-hotkeys 0.2
// Project: https://github.com/ctd1500/videojs-hotkeys
// Definitions by: James Cote <https://github.com/Coteh>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import { VideoJsPlayer } from 'video.js';
declare module 'video.js' {
interface VideoJsPlayer {
hotkeys(options?: VideoJsHotkeysOptions): void;
}
}
export interface VideoJsHotkeysOptions {
volumeStep?: number | undefined;
seekStep?: number | undefined;
enableMute?: boolean | undefined;
enableVolumeScroll?: boolean | undefined;
enableHoverScroll?: boolean | undefined;
enableFullscreen?: boolean | undefined;
enableNumbers?: boolean | undefined;
enableModifiersForNumbers?: boolean | undefined;
alwaysCaptureHotkeys?: boolean | undefined;
enableInactiveFocus?: boolean | undefined;
skipInitialFocus?: boolean | undefined;
captureDocumentHotkeys?: boolean | undefined;
documentHotkeysFocusElementFilter?: ((element: HTMLElement) => boolean) | undefined;
enableJogStyle?: boolean | undefined;
playPauseKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
rewindKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
forwardKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
volumeUpKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
volumeDownKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
muteKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
fullscreenKey?: ((event: KeyboardEvent, player: VideoJsPlayer) => boolean) | undefined;
customKeys?: VideoJsCustomHotkeyOptions | undefined;
}
export interface VideoJsCustomHotkeyOptions {
[key: string]: VideoJsCustomHotkey;
}
export interface VideoJsCustomHotkey {
key: (event: KeyboardEvent, player: VideoJsPlayer) => boolean;
handler: (player: VideoJsPlayer, options: VideoJsHotkeysOptions, event: KeyboardEvent) => void;
}
Additional Details
- Last updated: Fri, 02 Jul 2021 18:05:04 GMT
- Dependencies: @types/video.js
- Global values: none
Credits
These definitions were written by James Cote.