forked from theonion/videojs-vast-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
videojs.vast.js
326 lines (275 loc) · 10.5 KB
/
videojs.vast.js
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
(function(window, vjs, vast) {
'use strict';
var extend = function(obj) {
var arg, i, k;
for (i = 1; i < arguments.length; i++) {
arg = arguments[i];
for (k in arg) {
if (arg.hasOwnProperty(k)) {
obj[k] = arg[k];
}
}
}
return obj;
},
defaults = {
// seconds before skip button shows, negative values to disable skip button altogether
skip: 5
},
Vast = function (player, settings) {
// return vast plugin
return {
createSourceObjects: function (media_files) {
var sourcesByFormat = {}, i, j, tech;
var techOrder = player.options().techOrder;
for (i = 0, j = techOrder.length; i < j; i++) {
var techName = techOrder[i].charAt(0).toUpperCase() + techOrder[i].slice(1);
tech = window.videojs[techName];
// Check if the current tech is defined before continuing
if (!tech) {
continue;
}
// Check if the browser supports this technology
if (tech.isSupported()) {
// Loop through each source object
for (var a = 0, b = media_files.length; a < b; a++) {
var media_file = media_files[a];
var source = {type:media_file.mimeType, src:media_file.fileURL};
// Check if source can be played with this technology
if (tech.canPlaySource(source)) {
if (sourcesByFormat[techOrder[i]] === undefined) {
sourcesByFormat[techOrder[i]] = [];
}
sourcesByFormat[techOrder[i]].push({
type:media_file.mimeType,
src: media_file.fileURL,
width: media_file.width,
height: media_file.height
});
}
}
}
}
// Create sources in preferred format order
var sources = [];
for (j = 0; j < techOrder.length; j++) {
tech = techOrder[j];
if (sourcesByFormat[tech] !== undefined) {
for (i = 0; i < sourcesByFormat[tech].length; i++) {
sources.push(sourcesByFormat[tech][i]);
}
}
}
return sources;
},
getContent: function () {
// query vast url given in settings
vast.client.get(settings.url, function(response) {
if (response) {
// we got a response, deal with it
for (var adIdx = 0; adIdx < response.ads.length; adIdx++) {
var ad = response.ads[adIdx];
player.vast.companion = undefined;
for (var creaIdx = 0; creaIdx < ad.creatives.length; creaIdx++) {
var creative = ad.creatives[creaIdx], foundCreative = false, foundCompanion = false;
if (creative.type === "linear" && !foundCreative) {
if (creative.mediaFiles.length) {
player.vast.sources = player.vast.createSourceObjects(creative.mediaFiles);
if (!player.vast.sources.length) {
player.trigger('adscanceled');
return;
}
player.vastTracker = new vast.tracker(ad, creative);
foundCreative = true;
}
} else if (creative.type === "companion" && !foundCompanion) {
player.vast.companion = creative;
foundCompanion = true;
}
}
if (player.vastTracker) {
// vast tracker and content is ready to go, trigger event
player.trigger('vast-ready');
break;
} else {
// Inform ad server we can't find suitable media file for this ad
vast.util.track(ad.errorURLTemplates, {ERRORCODE: 403});
}
}
}
if (!player.vastTracker) {
// No pre-roll, start video
player.trigger('adscanceled');
}
});
},
setupEvents: function() {
var errorOccurred = false,
canplayFn = function() {
player.vastTracker.load();
},
timeupdateFn = function() {
if (isNaN(player.vastTracker.assetDuration)) {
player.vastTracker.assetDuration = player.duration();
}
player.vastTracker.setProgress(player.currentTime());
},
pauseFn = function() {
player.vastTracker.setPaused(true);
player.one('play', function(){
player.vastTracker.setPaused(false);
});
},
errorFn = function() {
// Inform ad server we couldn't play the media file for this ad
vast.util.track(player.vastTracker.ad.errorURLTemplates, {ERRORCODE: 405});
errorOccurred = true;
player.trigger('ended');
};
player.on('canplay', canplayFn);
player.on('timeupdate', timeupdateFn);
player.on('pause', pauseFn);
player.on('error', errorFn);
player.one('vast-preroll-removed', function() {
player.off('canplay', canplayFn);
player.off('timeupdate', timeupdateFn);
player.off('pause', pauseFn);
player.off('error', errorFn);
if (!errorOccurred) {
player.vastTracker.complete();
}
});
},
preroll: function() {
player.ads.startLinearAdMode();
player.vast.showControls = player.controls();
if (player.vast.showControls) {
player.controls(false);
}
// load linear ad sources and start playing them
player.src(player.vast.sources);
var clickthrough;
if (player.vastTracker.clickThroughURLTemplate) {
clickthrough = vast.util.resolveURLTemplates(
[player.vastTracker.clickThroughURLTemplate],
{
CACHEBUSTER: Math.round(Math.random() * 1.0e+10),
CONTENTPLAYHEAD: player.vastTracker.progressFormated()
}
)[0];
}
var blocker = window.document.createElement("a");
blocker.className = "vast-blocker";
blocker.href = clickthrough || "#";
blocker.target = "_blank";
blocker.onclick = function() {
if (player.paused()) {
player.play();
return false;
}
var clicktrackers = player.vastTracker.clickTrackingURLTemplate;
if (clicktrackers) {
player.vastTracker.trackURLs([clicktrackers]);
}
player.trigger("adclick");
};
player.vast.blocker = blocker;
player.el().insertBefore(blocker, player.controlBar.el());
var skipButton = window.document.createElement("div");
skipButton.className = "vast-skip-button";
if (settings.skip < 0) {
skipButton.style.display = "none";
}
player.vast.skipButton = skipButton;
player.el().appendChild(skipButton);
player.on("timeupdate", player.vast.timeupdate);
skipButton.onclick = function(e) {
if((' ' + player.vast.skipButton.className + ' ').indexOf(' enabled ') >= 0) {
player.vastTracker.skip();
player.vast.tearDown();
}
if(window.Event.prototype.stopPropagation !== undefined) {
e.stopPropagation();
} else {
return false;
}
};
player.vast.setupEvents();
player.one('ended', player.vast.tearDown);
player.trigger('vast-preroll-ready');
},
tearDown: function() {
// remove preroll buttons
player.vast.skipButton.parentNode.removeChild(player.vast.skipButton);
player.vast.blocker.parentNode.removeChild(player.vast.blocker);
// remove vast-specific events
player.off('timeupdate', player.vast.timeupdate);
player.off('ended', player.vast.tearDown);
// end ad mode
player.ads.endLinearAdMode();
// show player controls for video
if (player.vast.showControls) {
player.controls(true);
}
player.trigger('vast-preroll-removed');
},
timeupdate: function(e) {
player.loadingSpinner.el().style.display = "none";
var timeLeft = Math.ceil(settings.skip - player.currentTime());
if(timeLeft > 0) {
player.vast.skipButton.innerHTML = "Skip in " + timeLeft + "...";
} else {
if((' ' + player.vast.skipButton.className + ' ').indexOf(' enabled ') === -1){
player.vast.skipButton.className += " enabled";
player.vast.skipButton.innerHTML = "Skip";
}
}
}
};
},
vastPlugin = function(options) {
var player = this;
var settings = extend({}, defaults, options || {});
// check that we have the ads plugin
if (player.ads === undefined) {
window.console.error('vast video plugin requires videojs-contrib-ads, vast plugin not initialized');
return null;
}
// set up vast plugin, then set up events here
player.vast = new Vast(player, settings);
player.on('vast-ready', function () {
// vast is prepared with content, set up ads and trigger ready function
player.trigger('adsready');
});
player.on('vast-preroll-ready', function () {
// start playing preroll, note: this should happen this way no matter what, even if autoplay
// has been disabled since the preroll function shouldn't run until the user/autoplay has
// caused the main video to trigger this preroll function
player.play();
});
player.on('vast-preroll-removed', function () {
// preroll done or removed, start playing the actual video
player.play();
});
player.on('contentupdate', function(){
// videojs-ads triggers this when src changes
player.vast.getContent(settings.url);
});
player.on('readyforpreroll', function() {
// if we don't have a vast url, just bail out
if (!settings.url) {
player.trigger('adscanceled');
return null;
}
// set up and start playing preroll
player.vast.preroll();
});
// make an ads request immediately so we're ready when the viewer hits "play"
if (player.currentSrc()) {
player.vast.getContent(settings.url);
}
// return player to allow this plugin to be chained
return player;
};
vjs.plugin('vast', vastPlugin);
}(window, videojs, DMVAST));