forked from boronia/ableplayer
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvimeo.js
More file actions
454 lines (387 loc) · 14.2 KB
/
vimeo.js
File metadata and controls
454 lines (387 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
(function ($) {
AblePlayer.prototype.initVimeoPlayer = function () {
var thisObj, deferred, promise, containerId, vimeoId, autoplay, videoDimensions, options;
thisObj = this;
deferred = new $.Deferred();
promise = deferred.promise();
containerId = this.mediaId + '_vimeo';
// add container to which Vimeo player iframe will be appended
this.$mediaContainer.prepend($('<div>').attr('id', containerId));
// if a described version is available && user prefers desription
// init player using the described version
if (this.vimeoDescId && this.prefDesc) {
vimeoId = this.vimeoDescId;
}
else {
vimeoId = this.vimeoId;
}
this.activeVimeoId = vimeoId;
// Notes re. Vimeo Embed Options:
// If a video is owned by a user with a paid Plus, PRO, or Business account,
// setting the "controls" option to "false" will hide the default controls, without hiding captions.
// This is a new option from Vimeo; previously used "background:true" to hide the controller,
// but that had unwanted side effects:
// - In addition to hiding the controls, it also hides captions
// - It automatically autoplays (initializing the player with autoplay:false does not override this)
// - It automatically loops (but this can be overridden by initializing the player with loop:false)
// - It automatically sets volume to 0 (not sure if this can be overridden, since no longer using the background option)
if (this.autoplay && this.okToPlay) {
autoplay = 'true';
}
else {
autoplay = 'false';
}
videoDimensions = this.getVimeoDimensions(this.activeVimeoId, containerId);
if (videoDimensions) {
this.vimeoWidth = videoDimensions[0];
this.vimeoHeight = videoDimensions[1];
this.aspectRatio = thisObj.ytWidth / thisObj.ytHeight;
}
else {
// dimensions are initially unknown
// sending null values to Vimeo results in a video that uses the default Vimeo dimensions
// these can then be scraped from the iframe and applied to this.$ableWrapper
this.vimeoWidth = null;
this.vimeoHeight = null;
}
options = {
id: vimeoId,
width: this.vimeoWidth,
controls: false
};
this.vimeoPlayer = new Vimeo.Player(containerId, options);
this.vimeoPlayer.ready().then(function() {
if (!thisObj.hasPlaylist) {
// remove the media element, since Vimeo replaces that with its own element in an iframe
// this is handled differently for playlists. See buildplayer.js > cuePlaylistItem()
thisObj.$media.remove();
// define variables that will impact player setup
// vimeoSupportsPlaybackRateChange
// changing playbackRate is only supported if the video is hosted on a Pro or Business account
// unfortunately there is no direct way to query for that information.
// this.vimeoPlayer.getPlaybackRate() returns a value, regardless of account type
// This is a hack:
// Attempt to change the playbackRate. If it results in an error, assume changing playbackRate is not supported.
// Supported playbackRate values are 0.5 to 2.
thisObj.vimeoPlaybackRate = 1;
thisObj.vimeoPlayer.setPlaybackRate(thisObj.vimeoPlaybackRate).then(function(playbackRate) {
// playback rate was set
thisObj.vimeoSupportsPlaybackRateChange = true;
}).catch(function(error) {
thisObj.vimeoSupportsPlaybackRateChange = false;
});
deferred.resolve();
}
});
return promise;
};
AblePlayer.prototype.getVimeoPaused = function () {
var deferred, promise;
deferred = new $.Deferred();
promise = deferred.promise();
this.vimeoPlayer.getPaused().then(function (paused) {
// paused is Boolean
deferred.resolve(paused);
});
return promise;
}
AblePlayer.prototype.getVimeoEnded = function () {
var deferred, promise;
deferred = new $.Deferred();
promise = deferred.promise();
this.vimeoPlayer.getEnded().then(function (ended) {
// ended is Boolean
deferred.resolve(ended);
});
return promise;
}
AblePlayer.prototype.getVimeoState = function () {
var thisObj, deferred, promise, promises, gettingPausedPromise, gettingEndedPromise;
thisObj = this;
deferred = new $.Deferred();
promise = deferred.promise();
promises = [];
gettingPausedPromise = this.vimeoPlayer.getPaused();
gettingEndedPromise = this.vimeoPlayer.getEnded();
promises.push(gettingPausedPromise);
promises.push(gettingEndedPromise);
gettingPausedPromise.then(function (paused) {
deferred.resolve(paused);
});
gettingEndedPromise.then(function (ended) {
deferred.resolve(ended);
});
$.when.apply($, promises).then(function () {
deferred.resolve();
});
return promise;
}
AblePlayer.prototype.getVimeoDimensions = function (vimeoContainerId) {
// get dimensions of Vimeo video, return array with width & height
// Sources, in order of priority:
// 1. The width and height attributes on <video>
// 2. YouTube (not yet supported; can't seem to get this data via YouTube Data API without OAuth!)
var d, url, $iframe, width, height;
d = [];
if (typeof this.playerMaxWidth !== 'undefined') {
d[0] = this.playerMaxWidth;
// optional: set height as well; not required though since YouTube will adjust height to match width
if (typeof this.playerMaxHeight !== 'undefined') {
d[1] = this.playerMaxHeight;
}
return d;
}
else {
if (typeof $('#' + vimeoContainerId) !== 'undefined') {
$iframe = $('#' + vimeoContainerId);
width = $iframe.width();
height = $iframe.height();
if (width > 0 && height > 0) {
d[0] = width;
d[1] = height;
return d;
}
}
}
return false;
};
AblePlayer.prototype.resizeVimeoPlayer = function(youTubeId, youTubeContainerId) {
// NOTE: This function is modeled after same function in youtube.js
// in case useful for Vimeo, but is not currently used
// called after player is ready, if youTube dimensions were previously unknown
// Now need to get them from the iframe element that YouTube injected
// and resize Able Player to match
var d, width, height;
if (typeof this.aspectRatio !== 'undefined') {
// video dimensions have already been collected
if (this.restoringAfterFullScreen) {
// restore using saved values
if (this.youTubePlayer) {
this.youTubePlayer.setSize(this.ytWidth, this.ytHeight);
}
this.restoringAfterFullScreen = false;
}
else {
// recalculate with new wrapper size
width = this.$ableWrapper.parent().width();
height = Math.round(width / this.aspectRatio);
this.$ableWrapper.css({
'max-width': width + 'px',
'width': ''
});
this.youTubePlayer.setSize(width, height);
if (this.fullscreen) {
this.youTubePlayer.setSize(width, height);
}
else {
// resizing due to a change in window size, not full screen
this.youTubePlayer.setSize(this.ytWidth, this.ytHeight);
}
}
}
else {
d = this.getYouTubeDimensions(youTubeId, youTubeContainerId);
if (d) {
width = d[0];
height = d[1];
if (width > 0 && height > 0) {
this.aspectRatio = width / height;
this.ytWidth = width;
this.ytHeight = height;
if (width !== this.$ableWrapper.width()) {
// now that we've retrieved YouTube's default width,
// need to adjust to fit the current player wrapper
width = this.$ableWrapper.width();
height = Math.round(width / this.aspectRatio);
if (this.youTubePlayer) {
this.youTubePlayer.setSize(width, height);
}
}
}
}
}
};
AblePlayer.prototype.setupVimeoCaptions = function () {
// called from setupAltCaptions if player is YouTube and there are no <track> captions
// use YouTube Data API to get caption data from YouTube
// function is called only if these conditions are met:
// 1. this.player === 'youtube'
// 2. there are no <track> elements with kind="captions"
// 3. youTubeDataApiKey is defined
var deferred = new $.Deferred();
var promise = deferred.promise();
var thisObj, googleApiPromise, youTubeId, i;
thisObj = this;
// if a described version is available && user prefers desription
// Use the described version, and get its captions
if (this.youTubeDescId && this.prefDesc) {
youTubeId = this.youTubeDescId;
}
else {
youTubeId = this.youTubeId;
}
if (typeof youTubeDataAPIKey !== 'undefined') {
// Wait until Google Client API is loaded
// When loaded, it sets global var googleApiReady to true
// Thanks to Paul Tavares for $.doWhen()
// https://gist.github.com/purtuga/8257269
$.doWhen({
when: function(){
return googleApiReady;
},
interval: 100, // ms
attempts: 1000
})
.done(function(){
deferred.resolve();
})
.fail(function(){
console.log('Unable to initialize Google API. YouTube captions are currently unavailable.');
});
}
else {
deferred.resolve();
}
return promise;
};
AblePlayer.prototype.getVimeoCaptionTracks = function () {
// get data via Vimeo Player API, and push data to this.captions
// Note: Vimeo doesn't expose the caption cues themselves
// so this.captions will only include metadata about caption tracks; not cues
var deferred = new $.Deferred();
var promise = deferred.promise();
var thisObj, i, trackId, isDefaultTrack;
thisObj = this;
this.vimeoPlayer.getTextTracks().then(function(tracks) {
// each Vimeo track includes the following:
// label (local name of the language)
// language (2-character code)
// kind (captions or subtitles, as declared by video owner)
// mode ('disabled' or 'showing')
if (tracks.length) {
// create a new button for each caption track
for (i=0; i<tracks.length; i++) {
thisObj.hasCaptions = true;
thisObj.usingVimeoCaptions = true;
if (thisObj.prefCaptions === 1) {
thisObj.captionsOn = true;
}
else {
thisObj.captionsOn = false;
}
// assign the default track based on language of the player
if (tracks[i]['language'] === thisObj.lang) {
isDefaultTrack = true;
}
else {
isDefaultTrack = false;
}
thisObj.tracks.push({
'kind': tracks[i]['kind'],
'language': tracks[i]['language'],
'label': tracks[i]['label'],
'def': isDefaultTrack
});
}
// setupPopups again with new captions array, replacing original
thisObj.setupPopups('captions');
deferred.resolve();
}
else {
thisObj.hasCaptions = false;
thisObj.usingVimeoCaptions = false;
deferred.resolve();
}
});
return promise;
};
AblePlayer.prototype.initVimeoCaptionModule = function () {
// NOTE: This function is modeled after same function in youtube.js
// in case useful for Vimeo, but is not currently used
// This function is called when YouTube onApiChange event fires
// to indicate that the player has loaded (or unloaded) a module with exposed API methods
// it isn't fired until the video starts playing
// and only fires if captions are available for this video (automated captions don't count)
// If no captions are available, onApichange event never fires & this function is never called
// YouTube iFrame API documentation is incomplete related to captions
// Found undocumented features on user forums and by playing around
// Details are here: http://terrillthompson.com/blog/648
// Summary:
// User might get either the AS3 (Flash) or HTML5 YouTube player
// The API uses a different caption module for each player (AS3 = 'cc'; HTML5 = 'captions')
// There are differences in the data and methods available through these modules
// This function therefore is used to determine which captions module is being used
// If it's a known module, this.ytCaptionModule will be used elsewhere to control captions
var options, fontSize, displaySettings;
options = this.youTubePlayer.getOptions();
if (options.length) {
for (var i=0; i<options.length; i++) {
if (options[i] == 'cc') { // this is the AS3 (Flash) player
this.ytCaptionModule = 'cc';
if (!this.hasCaptions) {
// there are captions available via other sources (e.g., <track>)
// so use these
this.hasCaptions = true;
this.usingYouTubeCaptions = true;
}
break;
}
else if (options[i] == 'captions') { // this is the HTML5 player
this.ytCaptionModule = 'captions';
if (!this.hasCaptions) {
// there are captions available via other sources (e.g., <track>)
// so use these
this.hasCaptions = true;
this.usingYouTubeCaptions = true;
}
break;
}
}
if (typeof this.ytCaptionModule !== 'undefined') {
if (this.usingYouTubeCaptions) {
// set default languaage
this.youTubePlayer.setOption(this.ytCaptionModule, 'track', {'languageCode': this.captionLang});
// set font size using Able Player prefs (values are -1, 0, 1, 2, and 3, where 0 is default)
this.youTubePlayer.setOption(this.ytCaptionModule,'fontSize',this.translatePrefs('size',this.prefCaptionsSize,'youtube'));
// ideally could set other display options too, but no others seem to be supported by setOption()
}
else {
// now that we know which cc module was loaded, unload it!
// we don't want it if we're using local <track> elements for captions
this.youTubePlayer.unloadModule(this.ytCaptionModule)
}
}
}
else {
// no modules were loaded onApiChange
// unfortunately, gonna have to disable captions if we can't control them
this.hasCaptions = false;
this.usingYouTubeCaptions = false;
}
this.refreshControls('captions');
};
AblePlayer.prototype.getVimeoPosterUrl = function (youTubeId, width) {
// NOTE: This function is modeled after same function in youtube.js
// in case useful for Vimeo, but is not currently used
// return a URL for retrieving a YouTube poster image
// supported values of width: 120, 320, 480, 640
var url = 'https://img.youtube.com/vi/' + youTubeId;
if (width == '120') {
// default (small) thumbnail, 120 x 90
return url + '/default.jpg';
}
else if (width == '320') {
// medium quality thumbnail, 320 x 180
return url + '/hqdefault.jpg';
}
else if (width == '480') {
// high quality thumbnail, 480 x 360
return url + '/hqdefault.jpg';
}
else if (width == '640') {
// standard definition poster image, 640 x 480
return url + '/sddefault.jpg';
}
return false;
};
})(jQuery);