1
0
mirror of https://github.com/videojs/video.js.git synced 2025-01-02 06:32:07 +02:00

fix: adds type defs for guides to work

This commit is contained in:
Jason Olson 2023-11-01 15:34:45 -07:00
parent d535e163da
commit 95e71f4ad0
7 changed files with 23 additions and 10 deletions

View File

@ -5163,51 +5163,56 @@ class Player extends Component {
* *
* @link https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist * @link https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist
* *
* @return {VideoTrackList} * @returns {import("./tracks/video-track-list").VideoTrackList}
* the current video track list * the current video track list
* *
* @method Player.prototype.videoTracks * @method Player.prototype.videoTracks
*/ */
Player.prototype.videoTracks = () => {};
/** /**
* Get the {@link AudioTrackList} * Get the {@link AudioTrackList}
* *
* @link https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist * @link https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist
* *
* @return {AudioTrackList} * @return {import("./tracks/audio-track-list").AudioTrackList}
* the current audio track list * the current audio track list
* *
* @method Player.prototype.audioTracks * @method Player.prototype.audioTracks
*/ */
Player.prototype.audioTracks = () => {};
/** /**
* Get the {@link TextTrackList} * Get the {@link TextTrackList}
* *
* @link http://www.w3.org/html/wg/drafts/html/master/embedded-content-0.html#dom-media-texttracks * @link http://www.w3.org/html/wg/drafts/html/master/embedded-content-0.html#dom-media-texttracks
* *
* @return {TextTrackList} * @return {import("./tracks/text-track-list").TextTrackList}
* the current text track list * the current text track list
* *
* @method Player.prototype.textTracks * @method Player.prototype.textTracks
*/ */
Player.prototype.textTracks = () => {};
/** /**
* Get the remote {@link TextTrackList} * Get the remote {@link TextTrackList}
* *
* @return {TextTrackList} * @return {import("./tracks/text-track-list").TextTrackList}
* The current remote text track list * The current remote text track list
* *
* @method Player.prototype.remoteTextTracks * @method Player.prototype.remoteTextTracks
*/ */
Player.prototype.remoteTextTracks = () => {};
/** /**
* Get the remote {@link HtmlTrackElementList} tracks. * Get the remote {@link HtmlTrackElementList} tracks.
* *
* @return {HtmlTrackElementList} * @return {import("./tracks/html-track-element-list").HtmlTrackElementList}
* The current remote text track element list * The current remote text track element list
* *
* @method Player.prototype.remoteTextTrackEls * @method Player.prototype.remoteTextTrackEls
*/ */
Player.prototype.remoteTextTrackEls = () => {};
TRACK_TYPES.names.forEach(function(name) { TRACK_TYPES.names.forEach(function(name) {
const props = TRACK_TYPES[name]; const props = TRACK_TYPES[name];

View File

@ -31,7 +31,7 @@ const disableOthers = function(list, track) {
* @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist} * @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#audiotracklist}
* @extends TrackList * @extends TrackList
*/ */
class AudioTrackList extends TrackList { export class AudioTrackList extends TrackList {
/** /**
* Create an instance of this class. * Create an instance of this class.

View File

@ -5,7 +5,7 @@
/** /**
* The current list of {@link HtmlTrackElement}s. * The current list of {@link HtmlTrackElement}s.
*/ */
class HtmlTrackElementList { export class HtmlTrackElementList {
/** /**
* Create an instance of this class. * Create an instance of this class.

View File

@ -9,7 +9,7 @@ import TrackList from './track-list';
* @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#texttracklist} * @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#texttracklist}
* @extends TrackList * @extends TrackList
*/ */
class TextTrackList extends TrackList { export class TextTrackList extends TrackList {
/** /**
* Add a {@link TextTrack} to the `TextTrackList` * Add a {@link TextTrack} to the `TextTrackList`

View File

@ -10,7 +10,7 @@ import {isEvented} from '../mixins/evented';
* *
* @extends EventTarget * @extends EventTarget
*/ */
class TrackList extends EventTarget { export class TrackList extends EventTarget {
/** /**
* Create an instance of this class * Create an instance of this class
* *

View File

@ -30,7 +30,7 @@ const disableOthers = function(list, track) {
* @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist} * @see [Spec]{@link https://html.spec.whatwg.org/multipage/embedded-content.html#videotracklist}
* @extends TrackList * @extends TrackList
*/ */
class VideoTrackList extends TrackList { export class VideoTrackList extends TrackList {
/** /**
* Create an instance of this class. * Create an instance of this class.

View File

@ -24,9 +24,13 @@ import Plugin from './plugin';
import * as Fn from './utils/fn.js'; import * as Fn from './utils/fn.js';
import * as Num from './utils/num.js'; import * as Num from './utils/num.js';
import * as Str from './utils/str.js'; import * as Str from './utils/str.js';
import TrackList from './tracks/track-list.js';
import TextTrack from './tracks/text-track.js'; import TextTrack from './tracks/text-track.js';
import TextTrackList from './tracks/text-track-list.js';
import AudioTrack from './tracks/audio-track.js'; import AudioTrack from './tracks/audio-track.js';
import AudioTrackList from './tracks/audio-track-list.js';
import VideoTrack from './tracks/video-track.js'; import VideoTrack from './tracks/video-track.js';
import VideoTrackList from './tracks/video-track-list.js';
import { deprecateForMajor } from './utils/deprecate'; import { deprecateForMajor } from './utils/deprecate';
import * as Time from './utils/time.js'; import * as Time from './utils/time.js';
import log, { createLogger } from './utils/log.js'; import log, { createLogger } from './utils/log.js';
@ -551,9 +555,13 @@ videojs.trigger = Events.trigger;
*/ */
videojs.xhr = xhr; videojs.xhr = xhr;
videojs.TrackList = TrackList;
videojs.TextTrack = TextTrack; videojs.TextTrack = TextTrack;
videojs.TextTrackList = TextTrackList;
videojs.AudioTrack = AudioTrack; videojs.AudioTrack = AudioTrack;
videojs.AudioTrackList = AudioTrackList;
videojs.VideoTrack = VideoTrack; videojs.VideoTrack = VideoTrack;
videojs.VideoTrackList = VideoTrackList;
[ [
'isEl', 'isEl',