specter/CyTube
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Support enabling custom media subtitle by default

Browse source 
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/track#Attributes
This commit is contained in:
animeavi 2020-11-01 22:37:52 -05:00 committed by Calvin Montgomery
parent 8fc951350e
commit 750509eaf1
3 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/custom-media.md
View file

@ -119,6 +119,8 @@ Each text track entry is a JSON object with the following keys:
[`text/vtt`](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API). [`text/vtt`](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
* `name`: A name for the text track. This is displayed in the menu for the * `name`: A name for the text track. This is displayed in the menu for the
viewer to select a text track. viewer to select a text track.
* `default`: Enable track by default. Optional boolean attribute to enable
a subtitle track to the user by default.
**Important note regarding text tracks and CORS:** **Important note regarding text tracks and CORS:**
@ -148,7 +150,8 @@ for more information about setting this header.
{ {
"url": "https://example.com/subtitles.vtt", "url": "https://example.com/subtitles.vtt",
"contentType": "text/vtt", "contentType": "text/vtt",
"name": "English Subtitles" "name": "English Subtitles",
"default": true
} }
] ]
} }

8
player/videojs.coffee
View file

@ -96,12 +96,16 @@ window.VideoJSPlayer = class VideoJSPlayer extends Player
if data.meta.textTracks if data.meta.textTracks
data.meta.textTracks.forEach((track) -> data.meta.textTracks.forEach((track) ->
label = track.name label = track.name
$('<track/>').attr( attrs =
src: track.url src: track.url
kind: 'subtitles' kind: 'subtitles'
type: track.type type: track.type
label: label label: label
).appendTo(video)
if track.default? and track.default
attrs.default = ''
$('<track/>').attr(attrs).appendTo(video)
) )
@player = videojs(video[0], @player = videojs(video[0],

10
src/custom-media.js
View file

@ -209,6 +209,7 @@ function validateTextTracks(textTracks) {
if (!Array.isArray(textTracks)) if (!Array.isArray(textTracks))
throw new ValidationError('textTracks must be a list'); throw new ValidationError('textTracks must be a list');
let default_count = 0;
for (let track of textTracks) { for (let track of textTracks) {
if (typeof track.url !== 'string') if (typeof track.url !== 'string')
throw new ValidationError('text track URL must be a string'); throw new ValidationError('text track URL must be a string');
@ -223,6 +224,15 @@ function validateTextTracks(textTracks) {
throw new ValidationError('text track name must be a string'); throw new ValidationError('text track name must be a string');
if (!track.name) if (!track.name)
throw new ValidationError('text track name must be nonempty'); throw new ValidationError('text track name must be nonempty');
if (typeof track.default !== 'undefined') {
if (default_count > 0)
throw new ValidationError('only one default text track is allowed');
else if (typeof track.default !== 'boolean' || track.default !== true)
throw new ValidationError('text default attribute must be set to boolean true');
else
default_count++;
}
} }
} }