Installation

npm install --save @types/videojs-mobile-ui

Summary

This package contains type definitions for videojs-mobile-ui (https://github.com/mister-ben/videojs-mobile-ui#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/videojs-mobile-ui.

index.d.ts

1// eslint-disable-next-line @definitelytyped/no-import-default-of-export-equals
2import videojs from "video.js";
3
4/**
5 * A video.js plugin.
6 *
7 * Adds a mobile UI for player control, and fullscreen orientation control
8 */
9declare function mobileUi(options?: mobileUi.Options): void;
10
11declare namespace mobileUi {
12    const VERSION: typeof videojs.VERSION;
13
14    /**
15     * Plugin options.
16     */
17    interface Options {
18        /**
19         * Enables the display regardless of user agent, for testing purposes
20         * @default false
21         */
22        forceForTesting?: boolean | undefined;
23        /**
24         * Fullscreen options
25         */
26        fullscreen?: FullscreenOptions | undefined;
27        /**
28         * Touch UI options.
29         */
30        touchControls?: TouchControlsOptions | undefined;
31    }
32
33    interface FullscreenOptions {
34        /**
35         * Whether to go fullscreen when rotating to landscape
36         * @default true
37         */
38        enterOnRotate?: boolean | undefined;
39        /**
40         * Whether to leave fullscreen when rotating to portrait (if not locked)
41         * @default true
42         */
43        exitOnRotate?: boolean | undefined;
44        /**
45         * Whether to lock orientation when rotating to landscape
46         *           Unlocked when exiting fullscreen or on 'ended'
47         * @default true
48         */
49        lockOnRotate?: boolean | undefined;
50        /**
51         * Whether to disable iOS's native fullscreen so controls can work
52         * @default false
53         */
54        iOS?: boolean | undefined;
55    }
56
57    interface TouchControlsOptions {
58        /**
59         * If true no touch controls are added.
60         * @default false
61         */
62        disabled?: boolean | undefined;
63        /**
64         * Number of seconds to seek on double-tap
65         * @default 10
66         */
67        seekSeconds?: number | undefined;
68        /**
69         * Interval in ms to be considered a doubletap
70         * @default 300
71         */
72        tapTimeout?: number | undefined;
73        /**
74         * Whether to disable when the video ends (e.g., if there is an endscreen)
75         *           Never shows if the endscreen plugin is present
76         * @default false
77         */
78        disableOnEnd?: boolean | undefined;
79    }
80}
81
82export = mobileUi;
83
84declare module "video.js" {
85    interface VideoJsPlayer {
86        mobileUi: typeof mobileUi;
87    }
88}
89

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/video.js

Credits

These definitions were written by Piotr Błażejewicz.