]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - client/src/assets/player/peertube-videojs-typings.ts
Revert "Fix context menu when watching a playlist"
[github/Chocobozzz/PeerTube.git] / client / src / assets / player / peertube-videojs-typings.ts
CommitLineData
5abc96fc
C
1import { Config, Level } from 'hls.js'
2import videojs from 'video.js'
4572c3d0 3import { VideoFile, VideoPlaylist, VideoPlaylistElement } from '@shared/models'
09209296 4import { P2pMediaLoaderPlugin } from './p2p-media-loader/p2p-media-loader-plugin'
da332417 5import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager'
5abc96fc
C
6import { PlayerMode } from './peertube-player-manager'
7import { PeerTubePlugin } from './peertube-plugin'
4572c3d0 8import { PlaylistPlugin } from './playlist/playlist-plugin'
5abc96fc
C
9import { EndCardOptions } from './upnext/end-card'
10import { WebTorrentPlugin } from './webtorrent/webtorrent-plugin'
c6352f2c 11
f5fcd9f7 12declare module 'video.js' {
83fcadac 13
f5fcd9f7 14 export interface VideoJsPlayer {
83fcadac
C
15 srOptions_: HlsjsConfigHandlerOptions
16
f5fcd9f7
C
17 theaterEnabled: boolean
18
19 // FIXME: add it to upstream typings
20 posterImage: {
21 show (): void
22 hide (): void
23 }
24
25 handleTechSeeked_ (): void
26
27 // Plugins
28
c6352f2c 29 peertube (): PeerTubePlugin
83fcadac 30
2adfc7ea 31 webtorrent (): WebTorrentPlugin
83fcadac 32
09209296 33 p2pMediaLoader (): P2pMediaLoaderPlugin
c6352f2c 34
f5fcd9f7
C
35 contextmenuUI (options: any): any
36
37 bezels (): void
38
83fcadac 39 qualityLevels (): QualityLevels
c6352f2c 40
f5fcd9f7
C
41 textTracks (): TextTrackList & {
42 on: Function
1151f521 43 tracks_: (TextTrack & { id: string, label: string, src: string })[]
f5fcd9f7 44 }
83fcadac 45
abb3097e 46 dock (options: { title: string, description: string }): void
5abc96fc
C
47
48 upnext (options: Partial<EndCardOptions>): void
4572c3d0
C
49
50 playlist (): PlaylistPlugin
f5fcd9f7 51 }
c6352f2c
C
52}
53
83fcadac
C
54export interface VideoJSTechHLS extends videojs.Tech {
55 hlsProvider: any // FIXME: typings
56}
57
58export interface HlsjsConfigHandlerOptions {
59 hlsjsConfig?: Config & { cueHandler: any }// FIXME: typings
60 captionConfig?: any // FIXME: typings
61
62 levelLabelHandler?: (level: Level) => string
63}
64
65type QualityLevelRepresentation = {
66 id: number
67 height: number
68
69 label?: string
70 width?: number
71 bandwidth?: number
72 bitrate?: number
73
74 enabled?: Function
75 _enabled: boolean
76}
77
78type QualityLevels = QualityLevelRepresentation[] & {
79 selectedIndex: number
80 selectedIndex_: number
81
82 addQualityLevel (representation: QualityLevelRepresentation): void
83}
84
16f7022b
C
85type VideoJSCaption = {
86 label: string
87 language: string
88 src: string
89}
90
6e46de09
C
91type UserWatching = {
92 url: string,
93 authorizationHeader: string
94}
95
2adfc7ea 96type PeerTubePluginOptions = {
09209296
C
97 mode: PlayerMode
98
2adfc7ea 99 autoplay: boolean
c6352f2c
C
100 videoViewUrl: string
101 videoDuration: number
6e46de09
C
102
103 userWatching?: UserWatching
2adfc7ea
C
104 subtitle?: string
105
106 videoCaptions: VideoJSCaption[]
f0a39880
C
107
108 stopTime: number | string
10f26f42
C
109
110 isLive: boolean
58b9ce30 111
112 videoUUID: string
2adfc7ea
C
113}
114
4572c3d0 115type PlaylistPluginOptions = {
3e0e8d4a 116 elements: VideoPlaylistElement[]
4572c3d0
C
117
118 playlist: VideoPlaylist
119
120 getCurrentPosition: () => number
121
3e0e8d4a 122 onItemClicked: (element: VideoPlaylistElement) => void
4572c3d0
C
123}
124
a950e4c8
C
125type NextPreviousVideoButtonOptions = {
126 type: 'next' | 'previous'
127 handler: Function
128 isDisabled: () => boolean
129}
130
2adfc7ea
C
131type WebtorrentPluginOptions = {
132 playerElement: HTMLVideoElement
133
134 autoplay: boolean
135 videoDuration: number
136
137 videoFiles: VideoFile[]
f0a39880
C
138
139 startTime: number | string
2adfc7ea
C
140}
141
142type P2PMediaLoaderPluginOptions = {
da332417 143 redundancyUrlManager: RedundancyUrlManager
2adfc7ea
C
144 type: string
145 src: string
f0a39880
C
146
147 startTime: number | string
2adfc7ea
C
148}
149
150type VideoJSPluginOptions = {
4572c3d0
C
151 playlist?: PlaylistPluginOptions
152
2adfc7ea
C
153 peertube: PeerTubePluginOptions
154
155 webtorrent?: WebtorrentPluginOptions
156
157 p2pMediaLoader?: P2PMediaLoaderPluginOptions
c6352f2c
C
158}
159
2adfc7ea
C
160type LoadedQualityData = {
161 qualitySwitchCallback: Function,
162 qualityData: {
163 video: {
164 id: number
165 label: string
166 selected: boolean
167 }[]
168 }
169}
170
171type ResolutionUpdateData = {
172 auto: boolean,
173 resolutionId: number
3b6f205c 174 id?: number
2adfc7ea
C
175}
176
177type AutoResolutionUpdateData = {
178 possible: boolean
179}
180
3b6f205c 181type PlayerNetworkInfo = {
17152837
FC
182 source: 'webtorrent' | 'p2p-media-loader'
183
09209296
C
184 http: {
185 downloadSpeed: number
186 uploadSpeed: number
187 downloaded: number
188 uploaded: number
189 }
190
3b6f205c
C
191 p2p: {
192 downloadSpeed: number
193 uploadSpeed: number
194 downloaded: number
195 uploaded: number
196 numPeers: number
197 }
198}
199
4572c3d0
C
200type PlaylistItemOptions = {
201 element: VideoPlaylistElement
202
203 onClicked: Function
204}
205
c6352f2c 206export {
3b6f205c 207 PlayerNetworkInfo,
4572c3d0 208 PlaylistItemOptions,
a950e4c8 209 NextPreviousVideoButtonOptions,
2adfc7ea
C
210 ResolutionUpdateData,
211 AutoResolutionUpdateData,
4572c3d0 212 PlaylistPluginOptions,
6e46de09 213 VideoJSCaption,
2adfc7ea
C
214 UserWatching,
215 PeerTubePluginOptions,
216 WebtorrentPluginOptions,
217 P2PMediaLoaderPluginOptions,
218 VideoJSPluginOptions,
83fcadac
C
219 LoadedQualityData,
220 QualityLevelRepresentation,
221 QualityLevels
c6352f2c 222}