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 |
1×
1×
1×
1×
60×
60×
60×
59×
59×
60×
1×
60×
60×
59×
60×
1×
60×
60×
14×
14×
60×
1×
49×
49×
49×
13×
49×
49×
49×
24×
24×
24×
24×
24×
25×
25×
4×
1×
24×
2×
24×
9×
1×
49×
29×
20×
1×
26×
26×
6×
1×
71×
63×
8×
8×
4×
4×
4×
4×
4×
4×
1×
1×
7×
1×
6×
1×
5×
1×
4×
1×
92×
92×
92×
92×
92×
92×
92×
92×
92×
92×
92×
92×
92×
92×
1×
92×
92×
15×
15×
12×
3×
15×
1×
12×
9×
9×
12×
1×
3×
1×
2×
92×
92×
49×
3×
46×
49×
92×
92×
131×
8×
123×
1×
183×
1×
10×
7×
7×
1×
9×
9×
9×
1×
25×
1×
9×
1×
70×
4×
4×
4×
1×
4×
4×
4×
1×
158×
48×
1×
16×
1×
76×
1×
51×
51×
51×
1×
1×
329×
329×
759×
421×
990×
1× | 'use strict';
var dom = require('./dom');
var utilities = require('./utilityFunctions');
var playerUtils = {};
/**
* Returns an object that captures the portions of player state relevant to
* video playback. The result of this function can be passed to
* restorePlayerSnapshot with a player to return the player to the state it
* was in when this function was invoked.
* @param {object} player The videojs player object
*/
playerUtils.getPlayerSnapshot = function getPlayerSnapshot(player) {
var tech = player.el().querySelector('.vjs-tech');
var snapshot = {
ended: player.ended(),
src: player.currentSrc(),
currentTime: player.currentTime(),
type: player.currentType(),
playing: !player.paused(),
suppressedTracks: getSuppressedTracks(player)
};
if (tech) {
snapshot.nativePoster = tech.poster;
snapshot.style = tech.getAttribute('style');
}
return snapshot;
/**** Local Functions ****/
function getSuppressedTracks(player) {
var tracks = player.remoteTextTracks ? player.remoteTextTracks() : [];
if (tracks && utilities.isArray(tracks.tracks_)) {
tracks = tracks.tracks_;
}
if (!utilities.isArray(tracks)) {
tracks = [];
}
var suppressedTracks = [];
tracks.forEach(function (track) {
suppressedTracks.push({
track: track,
mode: track.mode
});
track.mode = 'disabled';
});
return suppressedTracks;
}
};
/**
* Attempts to modify the specified player so that its state is equivalent to
* the state of the snapshot.
* @param {object} snapshot - the player state to apply
*/
playerUtils.restorePlayerSnapshot = function restorePlayerSnapshot(player, snapshot) {
var tech = player.el().querySelector('.vjs-tech');
var attempts = 20; // the number of remaining attempts to restore the snapshot
if (snapshot.nativePoster) {
tech.poster = snapshot.nativePoster;
}
Eif ('style' in snapshot) {
// overwrite all css style properties to restore state precisely
tech.setAttribute('style', snapshot.style || '');
}
if (hasSrcChanged(player, snapshot)) {
// on ios7, fiddling with textTracks too early will cause safari to crash
player.one('contentloadedmetadata', restoreTracks);
player.one('canplay', tryToResume);
ensureCanplayEvtGetsFired();
// if the src changed for ad playback, reset it
player.src({src: snapshot.src, type: snapshot.type});
// safari requires a call to `load` to pick up a changed source
player.load();
} else {
restoreTracks();
if (snapshot.playing) {
player.play();
}
}
/*** Local Functions ***/
/**
* Sometimes firefox does not trigger the 'canplay' evt.
* This code ensure that it always gets triggered triggered.
*/
function ensureCanplayEvtGetsFired() {
var timeoutId = setTimeout(function() {
player.trigger('canplay');
}, 1000);
player.one('canplay', function(){
clearTimeout(timeoutId);
});
}
/**
* Determine whether the player needs to be restored to its state
* before ad playback began. With a custom ad display or burned-in
* ads, the content player state hasn't been modified and so no
* restoration is required
*/
function hasSrcChanged(player, snapshot) {
if (player.src()) {
return player.src() !== snapshot.src;
}
// the player was configured through source element children
return player.currentSrc() !== snapshot.src;
}
function restoreTracks() {
var suppressedTracks = snapshot.suppressedTracks;
suppressedTracks.forEach(function (trackSnapshot) {
trackSnapshot.track.mode = trackSnapshot.mode;
});
}
/**
* Determine if the video element has loaded enough of the snapshot source
* to be ready to apply the rest of the state
*/
function tryToResume() {
// if some period of the video is seekable, resume playback
// otherwise delay a bit and then check again unless we're out of attempts
if (!playerUtils.isReadyToResume(player) && attempts--) {
setTimeout(tryToResume, 50);
} else {
try {
if(player.currentTime() !== snapshot.currentTime) {
Eif (snapshot.playing) { // if needed restore playing status after seek completes
player.one('seeked', function() {
player.play();
});
}
player.currentTime(snapshot.currentTime);
} else Eif (snapshot.playing) {
// if needed and no seek has been performed, restore playing status immediately
player.play();
}
} catch (e) {
videojs.log.warn('Failed to resume the content after an advertisement', e);
}
}
}
};
playerUtils.isReadyToResume = function (player) {
if (player.readyState() > 1) {
// some browsers and media aren't "seekable".
// readyState greater than 1 allows for seeking without exceptions
return true;
}
if (player.seekable() === undefined) {
// if the player doesn't expose the seekable time ranges, try to
// resume playback immediately
return true;
}
if (player.seekable().length > 0) {
// if some period of the video is seekable, resume playback
return true;
}
return false;
};
/**
* This function prepares the player to display ads.
* Adding convenience events like the 'vast.firsPlay' that gets fired when the video is first played
* and ads the blackPoster to the player to prevent content from being displayed before the preroll ad.
*
* @param player
*/
playerUtils.prepareForAds = function (player) {
var blackPoster = player.addChild('blackPoster');
var _firstPlay = true;
var volumeSnapshot;
monkeyPatchPlayerApi();
player.on('play', tryToTriggerFirstPlay);
player.on('vast.reset', resetFirstPlay);//Every time we change the sources we reset the first play.
player.on('vast.firstPlay', restoreContentVolume);
player.on('error', hideBlackPoster);//If there is an error in the player we remove the blackposter to show the err msg
player.on('vast.adStart', hideBlackPoster);
player.on('vast.adsCancel', hideBlackPoster);
player.on('vast.adError', hideBlackPoster);
player.on('vast.adStart', addStyles);
player.on('vast.adEnd', removeStyles);
player.on('vast.adsCancel', removeStyles);
/*** Local Functions ***/
/**
What this function does is ugly and horrible and I should think twice before calling myself a good developer. With that said,
it is the best solution I could find to mute the video until the 'play' event happens (on mobile devices) and the plugin can decide whether
to play the ad or not.
We also need this monkeypatch to be able to pause and resume an ad using the player's API
If you have a better solution please do tell me.
*/
function monkeyPatchPlayerApi() {
/**
* Monkey patch needed to handle firstPlay and resume of playing ad.
*
* @param callOrigPlay necessary flag to prevent infinite loop when you are restoring a VAST ad.
* @returns {player}
*/
var origPlay = player.play;
player.play = function (callOrigPlay) {
var that = this;
if (isFirstPlay()) {
firstPlay();
} else {
resume(callOrigPlay);
}
return this;
/*** local functions ***/
function firstPlay() {
if (!utilities.isIPhone()) {
volumeSnapshot = saveVolumeSnapshot();
player.muted(true);
}
origPlay.apply(that, arguments);
}
function resume(callOrigPlay) {
if (isAdPlaying() && !callOrigPlay) {
player.vast.adUnit.resumeAd();
} else {
origPlay.apply(that, arguments);
}
}
};
/**
* Needed monkey patch to handle pause of playing ad.
*
* @param callOrigPlay necessary flag to prevent infinite loop when you are pausing a VAST ad.
* @returns {player}
*/
var origPause = player.pause;
player.pause = function (callOrigPause) {
if (isAdPlaying() && !callOrigPause) {
player.vast.adUnit.pauseAd();
} else {
origPause.apply(this, arguments);
}
return this;
};
/**
* Needed monkey patch to handle paused state of the player when ads are playing.
*
* @param callOrigPlay necessary flag to prevent infinite loop when you are pausing a VAST ad.
* @returns {player}
*/
var origPaused = player.paused;
player.paused = function (callOrigPaused) {
if (isAdPlaying() && !callOrigPaused) {
return player.vast.adUnit.isPaused();
}
return origPaused.apply(this, arguments);
};
}
function isAdPlaying() {
return player.vast && player.vast.adUnit;
}
function tryToTriggerFirstPlay() {
if (isFirstPlay()) {
_firstPlay = false;
player.trigger('vast.firstPlay');
}
}
function resetFirstPlay() {
_firstPlay = true;
blackPoster.show();
restoreContentVolume();
}
function isFirstPlay() {
return _firstPlay;
}
function saveVolumeSnapshot() {
return {
muted: player.muted(),
volume: player.volume()
};
}
function restoreContentVolume() {
if (volumeSnapshot) {
player.currentTime(0);
restoreVolumeSnapshot(volumeSnapshot);
volumeSnapshot = null;
}
}
function restoreVolumeSnapshot(snapshot) {
Eif (utilities.isObject(snapshot)) {
player.volume(snapshot.volume);
player.muted(snapshot.muted);
}
}
function hideBlackPoster() {
if (!dom.hasClass(blackPoster.el(), 'vjs-hidden')) {
blackPoster.hide();
}
}
function addStyles() {
dom.addClass(player.el(), 'vjs-ad-playing');
}
function removeStyles() {
dom.removeClass(player.el(), 'vjs-ad-playing');
}
};
/**
* Remove the poster attribute from the video element tech, if present. When
* reusing a video element for multiple videos, the poster image will briefly
* reappear while the new source loads. Removing the attribute ahead of time
* prevents the poster from showing up between videos.
* @param {object} player The videojs player object
*/
playerUtils.removeNativePoster = function (player) {
var tech = player.el().querySelector('.vjs-tech');
Eif (tech) {
tech.removeAttribute('poster');
}
};
/**
* Helper function to listen to many events until one of them gets fired, then we
* execute the handler and unsubscribe all the event listeners;
*
* @param player specific player from where to listen for the events
* @param events array of events
* @param handler function to execute once one of the events fires
*/
playerUtils.once = function once(player, events, handler) {
function listener() {
handler.apply(null, arguments);
events.forEach(function (event) {
player.off(event, listener);
});
}
events.forEach(function (event) {
player.on(event, listener);
});
};
module.exports = playerUtils; |