@newrelic/video-videojs 3.0.2 → 3.2.0-beta-0

package/src/ads/ima.js

@@ -0,0 +1,248 @@
+/* global google */
+import nrvideo from '@newrelic/video-core';
+import VideojsAdsTracker from './videojs-ads';
+
+export default class ImaAdsTracker extends VideojsAdsTracker {
+  static isUsing(player) {
+    return player.ima && typeof google !== 'undefined';
+  }
+
+  getTrackerName() {
+    return 'ima-ads';
+  }
+
+  getPlayerName() {
+    return 'ima';
+  }
+
+  getPlayerVersion() {
+    return (
+      'ima: ' + google.ima.VERSION + '; contrib-ads: ' + this.player.ads.VERSION
+    );
+  }
+
+  getCuePoints() {
+    return this.player.ima.getAdsManager().getCuePoints();
+  }
+
+  getAdPosition() {
+    if (
+      this.lastAdData &&
+      this.lastAdData.podInfo &&
+      this.lastAdData.podInfo.podIndex !== undefined
+    ) {
+      const podIndex = this.lastAdData.podInfo.podIndex;
+
+      if (podIndex === 0) {
+        return 'pre';
+      } else if (podIndex === -1) {
+        return 'post';
+      } else {
+        return 'mid';
+      }
+    }
+    return null;
+  }
+
+  getDuration() {
+    if (this.lastAdData && this.lastAdData.duration !== undefined) {
+      return this.lastAdData.duration * 1000;
+    }
+    return null;
+  }
+
+  getVideoId() {
+    if (this.lastAdData && this.lastAdData.adId) {
+      return this.lastAdData.adId;
+    }
+    return null;
+  }
+
+  getAdCreativeId() {
+    if (this.lastAdData && this.lastAdData.creativeId) {
+      return this.lastAdData.creativeId;
+    }
+    return null;
+  }
+
+  getSrc() {
+    if (this.lastAdData && this.lastAdData.mediaUrl) {
+      return this.lastAdData.mediaUrl;
+    }
+    return null;
+  }
+
+  getTitle() {
+    if (this.lastAdData && this.lastAdData.title) {
+      return this.lastAdData.title;
+    }
+    return null;
+  }
+
+  getPlayhead() {
+    let manager = this.player.ima.getAdsManager();
+    if (manager) {
+      return (this.getDuration() - manager.getRemainingTime()) * 1000;
+    }
+  }
+
+  getPlayrate() {
+    return this.player.playbackRate();
+  }
+
+  getAdPartner() {
+    return 'ima';
+  }
+
+  registerListeners() {
+    // Shortcut events
+    let e = google.ima.AdEvent.Type;
+    let AD_ERROR = google.ima.AdErrorEvent.Type.AD_ERROR;
+
+    //store ad data
+    this.lastAdData = null;
+    // debug
+    nrvideo.Log.debugCommonVideoEvents(this.player.ima.addEventListener, [
+      null,
+      e.ALL_ADS_COMPLETED,
+      e.LINEAR_CHANGED,
+      e.COMPLETE,
+      e.USER_CLOSE,
+      e.IMPRESSION,
+      e.CONTENT_PAUSE_REQUESTED,
+      e.CONTENT_RESUME_REQUESTED,
+      e.SKIPPED,
+      e.SKIPPABLE_STATE_CHANGED,
+      e.LOADED,
+      e.PAUSED,
+      e.RESUMED,
+      e.STARTED,
+      e.AD_CAN_PLAY,
+      e.AD_METADATA,
+      e.EXPANDED_CHANGED,
+      e.AD_BREAK_READY,
+      e.LOG,
+      e.CLICK,
+      e.FIRST_QUARTILE,
+      e.MIDPOINT,
+      e.THIRD_QUARTILE,
+      AD_ERROR,
+    ]);
+
+    // Register listeners
+    this.player.ima.addEventListener(e.LOADED, this.onLoaded.bind(this));
+    this.player.ima.addEventListener(e.STARTED, this.onStart.bind(this));
+    this.player.ima.addEventListener(e.PAUSED, this.onPaused.bind(this));
+    this.player.ima.addEventListener(e.RESUMED, this.onResumed.bind(this));
+    this.player.ima.addEventListener(e.COMPLETE, this.onComplete.bind(this));
+    this.player.ima.addEventListener(e.SKIPPED, this.onSkipped.bind(this));
+    this.player.ima.addEventListener(e.CLICK, this.onClick.bind(this));
+    this.player.ima.addEventListener(
+      e.FIRST_QUARTILE,
+      this.onFirstQuartile.bind(this)
+    );
+    this.player.ima.addEventListener(e.MIDPOINT, this.onMidpoint.bind(this));
+    this.player.ima.addEventListener(
+      e.THIRD_QUARTILE,
+      this.onThirdQuartile.bind(this)
+    );
+    this.player.ima.addEventListener(AD_ERROR, this.onError.bind(this));
+  }
+
+  unregisterListeners() {
+    // Shortcut events
+    let e = google.ima.AdEvent.Type;
+    let AD_ERROR = google.ima.AdErrorEvent.Type.AD_ERROR;
+
+    // unregister listeners
+    this.player.ima.removeEventListener(e.LOADED, this.onLoaded);
+    this.player.ima.removeEventListener(e.STARTED, this.onLoaded.bind(this));
+    this.player.ima.removeEventListener(e.IMPRESSION, this.onImpression);
+    this.player.ima.removeEventListener(e.PAUSED, this.onPaused);
+    this.player.ima.removeEventListener(e.RESUMED, this.onResumed);
+    this.player.ima.removeEventListener(e.COMPLETE, this.onComplete);
+    this.player.ima.removeEventListener(e.SKIPPED, this.onSkipped);
+    this.player.ima.removeEventListener(e.CLICK, this.onClick);
+    this.player.ima.removeEventListener(e.FIRST_QUARTILE, this.onFirstQuartile);
+    this.player.ima.removeEventListener(e.MIDPOINT, this.onMidpoint);
+    this.player.ima.removeEventListener(e.THIRD_QUARTILE, this.onThirdQuartile);
+    this.player.ima.removeEventListener(AD_ERROR, this.onError);
+    //clear ad data
+    this.lastAdData = null;
+  }
+
+  onLoaded(e) {
+    this.lastAdData = this.getAdData();
+    this.sendRequest();
+  }
+
+  onStart(e) {
+    this.lastAdData = this.getAdData();
+    this.sendStart();
+  }
+
+  onComplete(e) {
+    this.sendEnd();
+    this.lastAdData = null; // Clear the data
+  }
+
+  onSkipped(e) {
+    this.sendEnd({ skipped: true });
+    this.lastAdData = null; // Clear the data
+  }
+
+  onError(e) {
+    const adError = e.getError();
+
+    const errorCode = adError.getErrorCode();
+    const errorMessage = adError.getMessage();
+    this.sendError({ adError, errorCode, errorMessage });
+  }
+
+  onClick(e) {
+    this.sendAdClick();
+  }
+
+  onFirstQuartile() {
+    this.sendAdQuartile({ adQuartile: 1 });
+  }
+
+  onMidpoint() {
+    this.sendAdQuartile({ adQuartile: 2 });
+  }
+
+  onThirdQuartile() {
+    this.sendAdQuartile({ adQuartile: 3 });
+  }
+
+  onPaused() {
+    this.sendPause();
+  }
+
+  onResumed() {
+    this.sendResume();
+  }
+
+  getAdData() {
+    try {
+      const adsManager = this.player.ima.getAdsManager();
+      if (adsManager) {
+        const currentAd = adsManager.getCurrentAd();
+        if (currentAd) {
+          return {
+            adId: currentAd.getAdId(),
+            creativeId: currentAd.getCreativeId(),
+            duration: currentAd.getDuration(),
+            mediaUrl: currentAd.getMediaUrl(),
+            title: currentAd.getTitle(),
+            podInfo: currentAd.getAdPodInfo()?.data,
+            // Add other properties as needed
+          };
+        }
+      }
+      return null;
+    } catch (err) {
+      return null;
+    }
+  }
+}

package/src/ads/videojs-ads.js

@@ -0,0 +1,145 @@
+import nrvideo from '@newrelic/video-core';
+import pkg from '../../package.json';
+
+export default class VideojsAdsTracker extends nrvideo.VideoTracker {
+  getTrackerName() {
+    return 'videojs-ads';
+  }
+
+  getTrackerVersion() {
+    return pkg.version;
+  }
+
+  isMuted() {
+    return this.player.muted();
+  }
+
+  getRenditionHeight() {
+    return null;
+  }
+
+  getRenditionWidth() {
+    return null;
+  }
+
+  getPlayerName() {
+    return 'videojs-ads';
+  }
+
+  getPlayerVersion() {
+    return this.player.ads.VERSION;
+  }
+
+  registerListeners() {
+    nrvideo.Log.debugCommonVideoEvents(this.player, [
+      null,
+      'ads-request',
+      'ads-load',
+      'adstart',
+      'adend',
+      'adskip',
+      'adserror',
+      'ads-click',
+      'ads-pod-started',
+      'ads-pod-ended',
+      'ads-first-quartile',
+      'ads-midpoint',
+      'ads-third-quartile',
+      'ads-pause',
+      'ads-play',
+      'adtimeout',
+    ]);
+
+    // Register listeners
+    this.player.on('ads-request', this.onAdrequest.bind(this));
+    this.player.on('ads-load', this.onAdload.bind(this));
+    this.player.on('adstart', this.onAdstart.bind(this));
+    this.player.on('adend', this.onAdend.bind(this));
+    this.player.on('adskip', this.onAdskip.bind(this));
+    this.player.on('adserror', this.onAdserror.bind(this));
+    this.player.on('ads-click', this.onAdsClick.bind(this));
+    this.player.on('ads-pod-started', this.onPodStart.bind(this));
+    this.player.on('ads-pod-ended', this.onPodEnd.bind(this));
+    this.player.on('ads-first-quartile', this.onFirstQuartile.bind(this));
+    this.player.on('ads-midpoint', this.onMidpoint.bind(this));
+    this.player.on('ads-third-quartile', this.onThirdQuartile.bind(this));
+    this.player.on('ads-pause', this.onAdspause.bind(this));
+    this.player.on('ads-play', this.onAdsplay.bind(this));
+  }
+
+  unregisterListeners() {
+    // unregister listeners
+    this.player.off('ads-request', this.onAdrequest);
+    this.player.off('ads-load', this.onAdload);
+    this.player.off('adstart', this.onAdstart);
+    this.player.off('adend', this.onAdend);
+    this.player.off('adskip', this.onAdskip);
+    this.player.off('adserror', this.onAdserror);
+    this.player.off('ads-click', this.onAdsClick);
+    this.player.off('ads-pod-started', this.onPodStart);
+    this.player.off('ads-pod-ended', this.onPodEnd);
+    this.player.off('ads-first-quartile', this.onFirstQuartile);
+    this.player.off('ads-midpoint', this.onMidpoint);
+    this.player.off('ads-third-quartile', this.onThirdQuartile);
+    this.player.off('ads-pause', this.onAdspause);
+    this.player.off('ads-play', this.onAdsplay);
+  }
+
+  onAdrequest(e) {
+    this.sendRequest();
+    this.sendDownload({ state: 'ads-request' });
+  }
+
+  onAdload(e) {
+    this.sendDownload({ state: 'ads-load' });
+  }
+
+  onAdstart(e) {
+    this.sendRequest();
+    this.sendStart();
+  }
+
+  onAdend(e) {
+    this.sendEnd();
+  }
+
+  onAdskip(e) {
+    this.sendEnd({ skipped: true });
+  }
+
+  onAdserror(e) {
+    this.sendError();
+  }
+
+  onAdsClick(e) {
+    this.sendAdClick({ url: 'unknown' });
+  }
+
+  onPodStart(e) {
+    this.sendAdBreakStart();
+  }
+
+  onPodEnd(e) {
+    this.sendAdBreakEnd();
+  }
+
+  onFirstQuartile() {
+    this.sendAdQuartile({ quartile: 1 });
+  }
+
+  onMidpoint() {
+    this.sendAdQuartile({ quartile: 2 });
+  }
+
+  onThirdQuartile() {
+    this.sendAdQuartile({ quartile: 3 });
+  }
+
+  onAdspause() {
+    this.sendPause();
+  }
+
+  onAdsplay() {
+    this.sendResume();
+  }
+}

package/src/index.js

@@ -0,0 +1,2 @@
+import VideojsTracker from './tracker';
+export default VideojsTracker;

package/src/register-plugin.js

@@ -0,0 +1,19 @@
+if (typeof videojs !== 'undefined') {
+  // Cross-compatibility for Video.js 5 and 6.
+  const registerPlugin = videojs.registerPlugin || videojs.plugin;
+
+  /**
+   * Register newrelic's video.js plugin.
+   *
+   * In the plugin function, the value of `this` is a video.js `Player`
+   * instance. You cannot rely on the player being in a "ready" state here,
+   * depending on how the plugin is invoked. This may or may not be important
+   * to you; if not, remove the wait for "ready"!
+   */
+  registerPlugin('newrelic', function (options) {
+    if (!this.newrelictracker) {
+      this.newrelictracker = new VideojsTracker(this);
+    }
+    return this.newrelictracker;
+  });
+}

package/src/techs/contrib-hls.js

@@ -0,0 +1,45 @@
+export default class ContribHlsTech {
+  constructor (tech) {
+    this.tech = tech.vhs
+  }
+
+  getRenditionName () {
+    try {
+      var media = this.tech.playlists.media()
+      if (media && media.attributes) return media.attributes.NAME
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionBitrate () {
+    try {
+      var media = this.tech.playlists.media()
+      if (media && media.attributes) return media.attributes.BANDWIDTH
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionWidth () {
+    try {
+      var media = this.tech.playlists.media()
+      if (media && media.attributes && media.attributes.RESOLUTION) {
+        return media.attributes.RESOLUTION.width
+      }
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionHeight () {
+    try {
+      var media = this.tech.playlists.media()
+      if (media && media.attributes && media.attributes.RESOLUTION) {
+        return media.attributes.RESOLUTION.height
+      }
+    } catch (err) { }
+    return null
+  }
+}
+
+ContribHlsTech.isUsing = function (tech) {
+  return !!tech.vhs
+}

package/src/techs/hls-js.js

@@ -0,0 +1,45 @@
+export default class HlsJs {
+  constructor (tech) {
+    this.tech = tech.vhs_
+  }
+
+  getResource (tech) {
+    return this.tech.url
+  }
+
+  getRenditionName (tech) {
+    try {
+      var level = this.tech.levels[this.tech.currentLevel]
+      if (level && level.name) return level.name
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionBitrate (tech) {
+    try {
+      var level = this.tech.levels[this.tech.currentLevel]
+      if (level && level.bitrate) return level.bitrate
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionWidth (tech) {
+    try {
+      var level = this.tech.levels[this.tech.currentLevel]
+      if (level && level.width) return level.width
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionHeight (tech) {
+    try {
+      var level = this.tech.levels[this.tech.currentLevel]
+      if (level && level.height) return level.height
+    } catch (err) { }
+    return null
+  }
+}
+
+HlsJs.isUsing = function (tech) {
+  return !!tech.vhs_
+}

package/src/techs/shaka.js

@@ -0,0 +1,49 @@
+export default class ShakaTech {
+  constructor (tech) {
+    this.tech = tech.shakaPlayer
+  }
+
+  getSrc (tech) {
+    try {
+      return this.tech.getManifestUri()
+    } catch (err) {}
+    return null
+  }
+
+  getRenditionBitrate (tech) {
+    try {
+      return this.tech.getStats().streamBandwidth
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionWidth (tech) {
+    try {
+      var tracks = this.tech.getVariantTracks()
+      for (var i in tracks) {
+        var track = tracks[i]
+        if (track.active && track.type === 'video') {
+          return track.width
+        }
+      }
+    } catch (err) { }
+    return null
+  }
+
+  getRenditionHeight (tech) {
+    try {
+      var tracks = this.tech.getVariantTracks()
+      for (var i in tracks) {
+        var track = tracks[i]
+        if (track.active && track.type === 'video') {
+          return track.height
+        }
+      }
+    } catch (err) { }
+    return null
+  }
+}
+
+ShakaTech.isUsing = function (tech) {
+  return !!tech.shakaPlayer
+}