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 | 3×
3×
3×
3×
7×
7×
7×
7×
10×
10×
10×
10×
10×
10×
8×
8×
7×
6×
4×
4×
3×
2×
5×
5×
5×
5×
5×
5×
8×
5×
7×
7×
8×
8×
5×
5×
4×
6×
5×
5×
4×
5×
2×
4×
2×
2×
2×
2×
2×
2×
2×
2×
2×
3×
2×
2×
2×
2×
2×
3×
3×
2×
2×
2×
2×
2×
2×
2×
2×
2×
2×
10×
2×
1×
4×
3×
3×
1×
11×
3×
1×
3×
2×
4×
4×
3×
2×
1×
1×
7×
105×
31×
30×
2×
1×
1×
5×
105×
105×
29×
29×
1×
| const TinyEmitter = require('tiny-emitter')
const vpaidMethods = require('./vpaid-methods')
const VideoTracker = require('./video-tracker')
const isSupported = require('./util/is-supported')
function $removeAll () {
this._destroyed = true
this._videoSlot.src = ''
this._slot.innerHTML = ''
this._ui = null
}
class Linear extends TinyEmitter {
constructor (opts = {}) {
super()
this.baseUrl = ''
this.emitVpaidMethodInvocations()
this._ui = {}
this.quartileIndexEmitted = -1
this.hasEngaged = false
this._attributes = {
companions: '',
desiredBitrate: 256,
duration: 30,
remainingTime: -1,
expanded: false,
icons: false,
linear: true,
adSkippableState: false,
viewMode: 'normal',
width: 0,
height: 0,
volume: 1.0
}
this.previousAttributes = Object.assign({}, this._attributes)
// open interactive panel -> AdExpandedChange, AdInteraction
// when close panel -> AdExpandedChange, AdInteraction
this.opts = opts
this.opts.videos = this.opts.videos || []
}
set (attribute, newValue) {
this.previousAttributes[attribute] = this._attributes[attribute]
this._attributes[attribute] = newValue
}
/**
* The video player calls handshakeVersion immediately after loading the ad unit to indicate to the ad unit that VPAID will be used.
* The video player passes in its latest VPAID version string.
* The ad unit returns a version string minimally set to “1.0”, and of the form “major.minor.patch” (i.e. “2.1.05”).
* The video player must verify that it supports the particular version of VPAID or cancel the ad.
*
* @param {string} playerVPAIDVersion
* @return {string} adUnit VPAID version format 'major.minor.patch' minimum '1.0'
*/
handshakeVersion (playerVPAIDVersion) {
return '2.0'
}
appendStylesheet (path) {
const head = document.getElementsByTagName('head')[0]
const link = document.createElement('link')
link.rel = 'stylesheet'
link.type = 'text/css'
link.href = this.baseUrl + path
link.media = 'all'
head.appendChild(link)
}
/**
* After the ad unit is loaded and the video player calls handshakeVersion, the video player calls initAd() to initialize the ad experience.
*
* The video player may preload the ad unit and delay calling initAd() until nearing the ad playback time; however, the ad unit does not load its assets until initAd() is called. Once the ad unit’s assets are loaded, the ad unit sends the AdLoaded event to notify the video player that it is ready for display. Receiving the AdLoaded response indicates that the ad unit has verified that all files are ready to execute.
*
* @param {number} width indicates the available ad display area width in pixels
* @param {number} height indicates the available ad display area height in pixels
* @param {string} viewMode indicates either “normal”, “thumbnail”, or “fullscreen” as the view mode
for the video player as defined by the publisher. Default is “normal”.
* @param {number} desiredBitrate indicates the desired bitrate as number for kilobits per second
(kbps). The ad unit may use this information to select appropriate bitrate for any
streaming content.
* @param {object} creativeData (optional) used for additional initialization data. In a VAST context,
the ad unit should pass the value for either the Linear or Nonlinear AdParameter
element specified in the VAST document.
* @param {object} environmentVars (optional) used for passing implementation-specific runtime
variables. Refer to the language specific API description for more details.
*/
initAd (width, height, viewMode, desiredBitrate, creativeData, environmentVars) {
this._attributes.width = width
this._attributes.height = height
this._attributes.viewMode = viewMode
this._attributes.desiredBitrate = desiredBitrate
this._slot = environmentVars.slot || this.emit('AdError', 'Video slot is invalid')
this._videoSlot = environmentVars.videoSlot || this.emit('AdError', 'Slot is invalid')
this.useBestVideo().then(() => {
this.emit('AdLoaded')
}).catch((reason) => {
this.emit('AdLog', reason)
this.emit('AdLoaded')
})
this.videoTracker = new VideoTracker(this._videoSlot, this)
}
useBestVideo () {
return new Promise((resolve, reject) => {
const bestVideo = this.opts.videos.filter(video => isSupported(video.type))
if (bestVideo[0]) {
this.setVideoSource(bestVideo[0].url, bestVideo[0].type)
.then(resolve).catch(reject)
} else {
reject(new Error('no supported video found'))
}
})
}
setVideoSource (src, type) {
return new Promise((resolve, reject) => {
// As Google is not using an actual DOM video, it doesn't implement
// `onloadeddata`. In normal cases, `onloadeddata` is `null` when no
// handler function is assigned to it. However in Google's case, it
// returns as undefined.
Iif (typeof this._videoSlot.onloadeddata === 'undefined') {
resolve()
} else {
this._videoSlot.onloadeddata = resolve
}
this._videoSlot.onerror = function (ev) {
let msg
/* istanbul ignore next */
switch (ev.target.error.code) {
case ev.target.error.MEDIA_ERR_ABORTED:
msg = 'You aborted the video playback.'
break
case ev.target.error.MEDIA_ERR_NETWORK:
msg = 'A network error caused the video download to fail part-way.'
break
case ev.target.error.MEDIA_ERR_DECODE:
msg = 'The video playback was aborted due to a corruption problem or because the video used features your browser did not support.'
break
case ev.target.error.MEDIA_ERR_SRC_NOT_SUPPORTED:
msg = 'The video could not be loaded, either because the server or network failed or because the format is not supported.'
break
default:
msg = 'An unknown error occurred.'
break
}
reject(new Error(`${msg} Type: ${type}, source: ${src}`))
}
this._videoSlot.src = src
this._videoSlot.type = type
})
}
/**
* startAd() is called by the video player when the video player is ready for the ad to
* display. The ad unit responds by sending an AdStarted event that notifies the video player
* when the ad unit has started playing. Once started, the video player cannot restart the ad unit
* by calling startAd() and stopAd() multiple times.
*/
startAd () {
// As Google is not using an actual DOM video, it doesn't implement
// `onloadeddata`. In normal cases, `onloadeddata` is `null` when no
// handler function is assigned to it. However in Google's case, it
// returns as undefined.
Iif (typeof this._videoSlot.onloadeddata === 'undefined') {
this.emit('AdStarted')
} else {
// Ideally we want to wait till the first frame is present
this._videoSlot.onloadeddata = () => {
this.emit('AdStarted')
}
}
this._videoSlot.load()
}
/**
* The video player calls stopAd() when it will no longer display the ad or needs to cancel
* the ad unit. The ad unit responds by closing the ad, cleaning up its resources and then sending
* the AdStopped event. The process for stopping an ad may take time.
*/
stopAd () {
/* istanbul ignore if */
if (this._destroyed) return
$removeAll.call(this)
this.emit('AdStopped')
}
/**
* skipAd
*
*/
skipAd () {
/* istanbul ignore if */
if (this._destroyed) return
if (!this._attributes.adSkippableState) {
return false
}
$removeAll.call(this)
this.emit('AdSkipped')
this.emit('AdStopped')
}
/**
* The resizeAd() method is only called when the video player changes the width and
* height of the video content container, which prompts the ad unit to scale or reposition. The ad
* unit then resizes itself to a width and height that is equal to or less than the width and height
* supplied by the video player. Once resized, the ad unit writes updated dimensions to the
* adWidth and adHeight properties and sends the AdSizeChange event to confirm that
* it has resized itself.
*
* @param {number} width The maximum display area allotted for the ad. The ad unit must resize itself to a width and height that is within the values provided. The video player must always provide width and height unless it is in fullscreen mode. In fullscreen mode, the ad unit can ignore width/height parameters and resize to any dimension.
* @param {number} height The maximum display area allotted for the ad. The ad unit must resize itself to a width and height that is within the values provided. The video player must always provide width and height unless it is in fullscreen mode. In fullscreen mode, the ad unit can ignore width/height parameters and resize to any dimension.
* @param {string} viewMode Can be one of “normal” “thumbnail” or “fullscreen” to indicate the mode to which the video player is resizing. Width and height are not required when viewmode is fullscreen.
* @return {[type]} [description]
*/
resizeAd (width, height, viewMode) {
this._attributes.width = width
this._attributes.height = height
this._attributes.viewMode = viewMode
this.emit('AdSizeChange')
}
/**
* pauseAd
*
*/
pauseAd () {
this._videoSlot.pause()
this.emit('AdPaused')
}
/**
* resumeAd
*
*/
resumeAd () {
this._videoSlot.play()
this.emit('AdPlaying')
}
/**
* expandAd
*
*/
expandAd () {
this.hasEngaged = true
this.set('expanded', true)
this.emit('AdExpandedChange')
}
/**
* collapseAd
*
*/
collapseAd () {
this.set('expanded', false)
this.emit('AdExpandedChange')
}
/**
* The video player calls this method to register a listener to a particular event
*
* @param {Function} fn fn is a reference to the function that needs to be called when the specified event occurs
* @param {string} event event is the name of the event that the video player is subscribing to
* @param {[type]} listenerScope [optional] listenerScope is a reference to the object in which the function is
defined
*/
subscribe (fn, event, listenerScope) {
this.on(event, fn, listenerScope)
}
/**
* The video player calls this method to remove a listener for a particular event
*
* @param {Function} fn the event listener that is being removed
* @param {string} event event is the name of the event that the video player is unsubscribing from
*/
unsubscribe (fn, event) {
this.off(event, fn)
}
/**
* getAdLinear
*
* @return {boolean}
*/
getAdLinear () {
return this._attributes.linear
}
/**
* added to provide current width of ad unit after ad has resized
*
* @return {number} pixel's size of the ad, is equal to or less than the values passed in resizeAd/initAd
*/
getAdWidth () {
return this._attributes.width
}
/**
* added to provide current height of ad unit after ad has resized
*
* @return {number} pixel's size of the ad, is equal to or less than the values passed in resizeAd/initAd
*/
getAdHeight () {
return this._attributes.height
}
/**
* getAdExpanded
*
* @return {boolean}
*/
getAdExpanded () {
return this._attributes.expanded
}
/**
* in support of skippable ads, this feature enables the video
* player to identify when the ad is in a state where it can be skipped
*
* @return {boolean}
*/
getAdSkippableState () {
return this._attributes.adSkippableState
}
/**
* getAdRemainingTime
*
* @return {number} seconds, if not implemented will return -1, or -2 if the time is unknown (user is engaged with the ad)
*/
getAdRemainingTime () {
return this.hasEngaged ? -2 : this._videoSlot.duration - this._videoSlot.currentTime
}
/**
* reports total duration to more clearly report on the changing
* duration, which is confusing when both remaining time and duration can
* change
*
* @return {number} seconds, if not implemented will return -1, or -2 if the time is unknown (user is engaged with the ad)
*/
getAdDuration () {
return this.hasEngaged ? -2 : this._videoSlot.duration
}
/**
* getAdVolume
*
* @return {number} between 0 and 1, if is not implemented will return -1
*/
getAdVolume () {
return this._attributes.volume
}
/**
* getAdCompanions - companions are banners outside the video player to reinforce the ad
*
* @return {string} VAST 3.0 formart string for <CompanionAds>
*/
getAdCompanions () {
return this._attributes.companions
}
/**
* included to support various industry programs which require the
* overlay of icons on the ad.
*
* @return {boolean} if true videoplayer may hide is own icons to not duplicate
*/
getAdIcons () {
return this._attributes.icons
}
/**
* setAdVolume
*
* @param {number} volume between 0 and 1
*/
setAdVolume (volume) {
Iif (this.previousAttributes.volume === volume) {
// no change, no fire
return
}
if (volume < 0 || volume > 1) {
return this.emit('AdError', 'volume is not valid')
}
this.set('volume', volume)
this._videoSlot.volume = volume
this.emit('AdVolumeChange')
}
emitVpaidMethodInvocations () {
vpaidMethods.forEach((name) => {
const originalReference = this[name]
this[name] = (...rest) => {
this.emit(`${name}()`, ...rest)
return originalReference.apply(this, rest)
}
}, this)
}
}
module.exports = Linear
|