1 import { VideoFile } from '../../../../shared/models/videos'
3 import 'videojs-hotkeys'
5 import 'videojs-contextmenu-ui'
6 import './peertube-link-button'
7 import './resolution-menu-button'
8 import './settings-menu-button'
9 import './webtorrent-info-button'
10 import './peertube-videojs-plugin'
11 import './peertube-load-progress-bar'
12 import './theater-button'
13 import { VideoJSCaption, videojsUntyped } from './peertube-videojs-typings'
14 import { buildVideoEmbed, buildVideoLink, copyToClipboard } from './utils'
15 import { getCompleteLocale, getShortLocale, is18nLocale, isDefaultLocale } from '../../../../shared/models/i18n/i18n'
17 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
18 videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
19 // Change Captions to Subtitles/CC
20 videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
21 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
22 videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
24 function getVideojsOptions (options: {
26 playerElement: HTMLVideoElement,
28 videoDuration: number,
29 videoFiles: VideoFile[],
30 enableHotkeys: boolean,
31 inactivityTimeout: number,
32 peertubeLink: boolean,
34 startTime: number | string
36 videoCaptions: VideoJSCaption[],
42 const videojsOptions = {
43 // We don't use text track settings for now
44 textTrackSettings: false,
45 controls: options.controls !== undefined ? options.controls : true,
46 muted: options.controls !== undefined ? options.muted : false,
47 loop: options.loop !== undefined ? options.loop : false,
48 poster: options.poster,
50 inactivityTimeout: options.inactivityTimeout,
51 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
54 autoplay: options.autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
55 videoCaptions: options.videoCaptions,
56 videoFiles: options.videoFiles,
57 playerElement: options.playerElement,
58 videoViewUrl: options.videoViewUrl,
59 videoDuration: options.videoDuration,
60 startTime: options.startTime
64 children: getControlBarChildren(options)
68 if (options.enableHotkeys === true) {
69 Object.assign(videojsOptions.plugins, {
71 enableVolumeScroll: false,
72 enableModifiersForNumbers: false,
74 fullscreenKey: function (event) {
75 // fullscreen with the f key or Ctrl+Enter
76 return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
79 seekStep: function (event) {
80 // mimic VLC seek behavior, and default to 5 (original value is 5).
81 if (event.ctrlKey && event.altKey) {
83 } else if (event.ctrlKey) {
85 } else if (event.altKey) {
93 increasePlaybackRateKey: {
94 key: function (event) {
95 return event.key === '>'
97 handler: function (player) {
98 player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
101 decreasePlaybackRateKey: {
102 key: function (event) {
103 return event.key === '<'
105 handler: function (player) {
106 player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
110 key: function (event) {
111 return event.key === '.'
113 handler: function (player, options, event) {
115 // Calculate movement distance (assuming 30 fps)
117 player.currentTime(player.currentTime() + dist)
125 if (options.language && !isDefaultLocale(options.language)) {
126 Object.assign(videojsOptions, { language: options.language })
129 return videojsOptions
132 function getControlBarChildren (options: {
133 peertubeLink: boolean
134 theaterMode: boolean,
135 videoCaptions: VideoJSCaption[]
137 const settingEntries = []
140 settingEntries.push('playbackRateMenuButton')
141 if (options.videoCaptions.length !== 0) settingEntries.push('captionsButton')
142 settingEntries.push('resolutionMenuButton')
146 'currentTimeDisplay': {},
148 'durationDisplay': {},
151 'flexibleWidthSpacer': {},
156 'peerTubeLoadProgressBar': {},
157 'mouseTimeDisplay': {},
158 'playProgressBar': {}
164 'webTorrentButton': {},
173 entries: settingEntries
177 if (options.peertubeLink === true) {
178 Object.assign(children, {
179 'peerTubeLinkButton': {}
183 if (options.theaterMode === true) {
184 Object.assign(children, {
189 Object.assign(children, {
190 'fullscreenToggle': {}
196 function addContextMenu (player: any, videoEmbedUrl: string) {
197 player.contextmenuUI({
200 label: player.localize('Copy the video URL'),
201 listener: function () {
202 copyToClipboard(buildVideoLink())
206 label: player.localize('Copy the video URL at the current time'),
207 listener: function () {
209 copyToClipboard(buildVideoLink(player.currentTime()))
213 label: player.localize('Copy embed code'),
215 copyToClipboard(buildVideoEmbed(videoEmbedUrl))
219 label: player.localize('Copy magnet URI'),
220 listener: function () {
222 copyToClipboard(player.peertube().getCurrentVideoFile().magnetUri)
229 function loadLocaleInVideoJS (serverUrl: string, videojs: any, locale: string) {
230 const path = getLocalePath(serverUrl, locale)
231 // It is the default locale, nothing to translate
232 if (!path) return Promise.resolve(undefined)
236 if (loadLocaleInVideoJS.cache[path]) {
237 p = Promise.resolve(loadLocaleInVideoJS.cache[path])
239 p = fetch(path + '/player.json')
240 .then(res => res.json())
242 loadLocaleInVideoJS.cache[path] = json
247 const completeLocale = getCompleteLocale(locale)
248 return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
250 namespace loadLocaleInVideoJS {
251 export const cache: { [ path: string ]: any } = {}
254 function getServerTranslations (serverUrl: string, locale: string) {
255 const path = getLocalePath(serverUrl, locale)
256 // It is the default locale, nothing to translate
257 if (!path) return Promise.resolve(undefined)
259 return fetch(path + '/server.json')
260 .then(res => res.json())
263 // ############################################################################
266 getServerTranslations,
272 // ############################################################################
274 function getLocalePath (serverUrl: string, locale: string) {
275 const completeLocale = getCompleteLocale(locale)
277 if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
279 return serverUrl + '/client/locales/' + completeLocale