X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fassets%2Fplayer%2Fpeertube-videojs-typings.ts;h=8afb424a780c7b3602729f6d9b0fb3f0711bb1ef;hb=a45050e09edf6e2d74b6db48196f44ef9ce8fa58;hp=a58fa65050b9336c7b2685bf78cf35707ae672c2;hpb=c6352f2c64f3c1ad54f8500f493587cdce3d33c9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/client/src/assets/player/peertube-videojs-typings.ts b/client/src/assets/player/peertube-videojs-typings.ts index a58fa6505..8afb424a7 100644 --- a/client/src/assets/player/peertube-videojs-typings.ts +++ b/client/src/assets/player/peertube-videojs-typings.ts @@ -1,33 +1,229 @@ -import * as videojs from 'video.js' -import { VideoFile } from '../../../../shared/models/videos/video.model' -import { PeerTubePlugin } from './peertube-videojs-plugin' +import { Config, Level } from 'hls.js' +import videojs from 'video.js' +import { VideoFile, VideoPlaylist, VideoPlaylistElement } from '@shared/models' +import { P2pMediaLoaderPlugin } from './p2p-media-loader/p2p-media-loader-plugin' +import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager' +import { PlayerMode } from './peertube-player-manager' +import { PeerTubePlugin } from './peertube-plugin' +import { PlaylistPlugin } from './playlist/playlist-plugin' +import { EndCardOptions } from './upnext/end-card' +import { StatsCardOptions } from './stats/stats-card' +import { WebTorrentPlugin } from './webtorrent/webtorrent-plugin' +import { StatsForNerdsPlugin } from './stats/stats-plugin' declare module 'video.js' { - interface Player { + + export interface VideoJsPlayer { + srOptions_: HlsjsConfigHandlerOptions + + theaterEnabled: boolean + + // FIXME: add it to upstream typings + posterImage: { + show (): void + hide (): void + } + + handleTechSeeked_ (): void + + // Plugins + peertube (): PeerTubePlugin + + webtorrent (): WebTorrentPlugin + + p2pMediaLoader (): P2pMediaLoaderPlugin + + contextmenuUI (options: any): any + + bezels (): void + + stats (options?: StatsCardOptions): StatsForNerdsPlugin + + qualityLevels (): QualityLevels + + textTracks (): TextTrackList & { + on: Function + tracks_: (TextTrack & { id: string, label: string, src: string })[] + } + + dock (options: { title: string, description: string }): void + + upnext (options: Partial): void + + playlist (): PlaylistPlugin } } -interface VideoJSComponentInterface { - _player: videojs.Player +export interface VideoJSTechHLS extends videojs.Tech { + hlsProvider: any // FIXME: typings +} - new (player: videojs.Player, options?: any) +export interface HlsjsConfigHandlerOptions { + hlsjsConfig?: Config & { cueHandler: any }// FIXME: typings + captionConfig?: any // FIXME: typings - registerComponent (name: string, obj: any) + levelLabelHandler?: (level: Level) => string } -type PeertubePluginOptions = { - videoFiles: VideoFile[] - playerElement: HTMLVideoElement +type QualityLevelRepresentation = { + id: number + height: number + + label?: string + width?: number + bandwidth?: number + bitrate?: number + + enabled?: Function + _enabled: boolean +} + +type QualityLevels = QualityLevelRepresentation[] & { + selectedIndex: number + selectedIndex_: number + + addQualityLevel (representation: QualityLevelRepresentation): void +} + +type VideoJSCaption = { + label: string + language: string + src: string +} + +type UserWatching = { + url: string, + authorizationHeader: string +} + +type PeerTubePluginOptions = { + mode: PlayerMode + + autoplay: boolean videoViewUrl: string videoDuration: number + + userWatching?: UserWatching + subtitle?: string + + videoCaptions: VideoJSCaption[] + + stopTime: number | string + + isLive: boolean + + videoUUID: string } -// videojs typings don't have some method we need -const videojsUntyped = videojs as any +type PlaylistPluginOptions = { + elements: VideoPlaylistElement[] + + playlist: VideoPlaylist + + getCurrentPosition: () => number + + onItemClicked: (element: VideoPlaylistElement) => void +} + +type NextPreviousVideoButtonOptions = { + type: 'next' | 'previous' + handler: Function + isDisabled: () => boolean +} + +type WebtorrentPluginOptions = { + playerElement: HTMLVideoElement + + autoplay: boolean + videoDuration: number + + videoFiles: VideoFile[] + + startTime: number | string +} + +type P2PMediaLoaderPluginOptions = { + redundancyUrlManager: RedundancyUrlManager + type: string + src: string + + startTime: number | string +} + +type VideoJSPluginOptions = { + playlist?: PlaylistPluginOptions + + peertube: PeerTubePluginOptions + + webtorrent?: WebtorrentPluginOptions + + p2pMediaLoader?: P2PMediaLoaderPluginOptions +} + +type LoadedQualityData = { + qualitySwitchCallback: Function, + qualityData: { + video: { + id: number + label: string + selected: boolean + }[] + } +} + +type ResolutionUpdateData = { + auto: boolean, + resolutionId: number + id?: number +} + +type AutoResolutionUpdateData = { + possible: boolean +} + +type PlayerNetworkInfo = { + source: 'webtorrent' | 'p2p-media-loader' + + http: { + downloadSpeed: number + uploadSpeed: number + downloaded: number + uploaded: number + } + + p2p: { + downloadSpeed: number + uploadSpeed: number + downloaded: number + uploaded: number + numPeers: number + } + + // In bytes + bandwidthEstimate: number +} + +type PlaylistItemOptions = { + element: VideoPlaylistElement + + onClicked: Function +} export { - VideoJSComponentInterface, - PeertubePluginOptions, - videojsUntyped + PlayerNetworkInfo, + PlaylistItemOptions, + NextPreviousVideoButtonOptions, + ResolutionUpdateData, + AutoResolutionUpdateData, + PlaylistPluginOptions, + VideoJSCaption, + UserWatching, + PeerTubePluginOptions, + WebtorrentPluginOptions, + P2PMediaLoaderPluginOptions, + VideoJSPluginOptions, + LoadedQualityData, + QualityLevelRepresentation, + QualityLevels }