@gumlet/insights-js-core 1.1.4 → 1.1.5

package/js/adapters/HlsjsAdapter.js

@@ -1,152 +0,0 @@
-/* global Hls */
-
-import {HTML5Adapter} from './HTML5Adapter';
-import {MIMETypes} from '../enums/MIMETypes';
-import {Players} from '../enums/Players';
-
-/**
- * @class
- * @constructor
- */
-export class HlsjsAdapter extends HTML5Adapter {
-
-  /**
-   * @constructs
-   * @param {Hls} hls
-   * @param {AnalyticsEventCallback} eventCallback
-   * @param {AnalyticsStateMachine} stateMachine
-   */
-  constructor(hls, eventCallback, stateMachine) {
-
-    // we don't have a mediaEl yet per se
-    super(null, eventCallback, stateMachine, Players.HLSJS);
-
-    /**
-     * @public
-     * @member {Hls} hls Hls.js client instance
-     */
-    this.hls = hls;
-
-    this.playerSoftwareName = Players.HLSJS;
-
-    this.resetMedia();
-    this.registerHlsEvents();
-  }
-
-  /**
-   * Implemented by sub-class to deliver current quality-level info
-   * specific to media-engine.
-   * @override
-   * @returns {QualityLevelInfo}
-   */
-  getCurrentQualityLevelInfo() {
-    const hls = this.hls;
-    const currentLevelObj = hls.levels[hls.currentLevel];
-    if (!currentLevelObj) {
-      return;
-    }
-
-    const attributes = currentLevelObj.attrs;
-    const bitrate = parseInt(attributes.BANDWIDTH, 10);
-    const width = parseInt(attributes.RESOLUTION.width, 10);
-    const height = parseInt(attributes.RESOLUTION.height, 10);
-    let audioCodec = null;
-    let videoCodec = null;
-
-    if (attributes.CODECS) {
-      audioCodec = attributes.CODECS.split(",").length > 1 ? attributes.CODECS.split(",")[1] : "";
-      videoCodec = attributes.CODECS.split(",").length > 1 ? attributes.CODECS.split(",")[0] : "";
-    }
-
-    return {
-      bitrate,
-      width,
-      height,
-      audioCodec,
-      videoCodec
-    };
-  }
-
-  /**
-   * @override
-   */
-  isLive() {
-    const hls = this.hls;
-    if (hls.currentLevel < 0) {
-      return false;
-    }
-    const currentLevelObj = hls.levels[hls.currentLevel];
-    if (!currentLevelObj) {
-      return false;
-    }
-
-    return currentLevelObj.details.live;
-  }
-
-  /**
-   * @override
-   */
-  getPlayerVersion() {
-    return Hls.version;
-  }
-
-  /**
-   * @override
-   */
-  getMIMEType() {
-    return MIMETypes.HLS;
-  }
-
-  /**
-   * @override
-   */
-  getStreamURL() {
-    return this.hls.url;
-  }
-
-  registerHlsEvents() {
-    const hls = this.hls;
-
-    if (!Hls) {
-      throw new Error('Hls.js is not defined installed (must be loaded before analytics module)');
-    }
-
-    hls.on(Hls.Events.MEDIA_ATTACHING, this.onMediaAttaching.bind(this));
-    hls.on(Hls.Events.MEDIA_DETACHING, this.onMediaDetaching.bind(this));
-    hls.on(Hls.Events.MANIFEST_LOADING, this.onManifestLoading.bind(this));
-
-    // media is already attached, event has been triggered before
-    // or we are in the event handler of this event itself.
-    // we can not know how the stacktrace to this constructor will look like.
-    // therefore we will guard from this case in
-    // the onMediaAttaching method (avoid running it twice)
-    if (hls.media) {
-      this.onMediaAttaching();
-    }
-
-    if (hls.url) {
-      this.onManifestLoading();
-    }
-  }
-
-  onMediaAttaching() {
-    // in case we are called again (when we are triggering this ourselves
-    // but from the event handler of MEDIA_ATTACHING) we should not run again.
-    if (this.mediaEl) {
-      return;
-    }
-
-    this.mediaEl = this.hls.media;
-
-    this.registerMediaElement();
-    this.onMaybeReady();
-  }
-
-  onMediaDetaching() {
-    this.unregisterMediaElement();
-  }
-
-  onManifestLoading() {
-    this.onMaybeReady();
-  }
-}

package/js/adapters/ShakaAdapter.js

@@ -1,81 +0,0 @@
-/* global shaka */
-
-import {HTML5Adapter} from './HTML5Adapter';
-import {MIMETypes} from '../enums/MIMETypes';
-import {Players} from '../enums/Players';
-
-export class ShakaAdapter extends HTML5Adapter {
-
-  constructor(shakaPlayer, eventCallback, stateMachine, mediaElement) {
-    // super(shakaPlayer.getMediaElement(), eventCallback, stateMachine);
-    super(mediaElement, eventCallback, stateMachine, Players.SHAKA);
-
-    if (!shaka) {
-      throw new Error('`shaka` lib is not installed (must be loaded before analytics module)');
-    }
-
-    /**
-     * @public
-     * @member {shaka.Player}
-     */
-    this.shakaPlayer = shakaPlayer;
-    this.playerSoftwareName = Players.SHAKA;
-  }
-
-  getPlayerVersion() {
-    return shaka.Player.version;
-  }
-
-  isLive() {
-    return this.shakaPlayer ? this.shakaPlayer.isLive() : false;
-  }
-
-  /**
-   * @override
-   */
-  getMIMEType() {
-    // FIXME: Could be HLS too, Shaka probably has a method to find out
-    return MIMETypes.DASH;
-  }
-
-  /**
-   * @override
-   */
-  getStreamURL() {
-    // return this.shakaPlayer ? this.shakaPlayer.getManifestUri() : null;
-    return this.shakaPlayer ? this.shakaPlayer.getAssetUri() : null;
-  }
-
-  /**
-   * Implemented by sub-class to deliver current quality-level info
-   * specific to media-engine.
-   * @override
-   * @returns {QualityLevelInfo}
-   */
-  getCurrentQualityLevelInfo() {
-    const variantTracks = this.shakaPlayer.getVariantTracks();
-
-    const activeVideoTrack = variantTracks
-      .filter((track) => track.active)
-      .filter((track) => track.videoCodec || track.videoId !== undefined)[0];
-
-    if (!activeVideoTrack) {
-      // can only happen for audio-only streams
-      return null;
-    }
-    
-    const bitrate = activeVideoTrack.videoBandwidth || activeVideoTrack.bandwidth;
-    const width = activeVideoTrack.width;
-    const height = activeVideoTrack.height;
-    const videoCodec = activeVideoTrack.videoCodec;
-    const audioCodec = activeVideoTrack.audioCodec;
-
-    return {
-      bitrate,
-      width,
-      height,
-      videoCodec,
-      audioCodec
-    };
-  }
-}

package/js/adapters/VideoJsAdapter.js

@@ -1,455 +0,0 @@
-/* global videojs */
-
-import Events from '../enums/Events';
-
-const BUFFERING_TIMECHANGED_TIMEOUT = 1000;
-
-class VideoJsAdapter {
-  constructor(player, eventCallback, stateMachine) {
-    this.onBeforeUnLoadEvent = false;
-    this.player = player;
-    this.eventCallback = eventCallback;
-    this.stateMachine = stateMachine;
-    this.register();
-  }
-
-  getStreamType(url) {
-    if (url.endsWith('.m3u8')) {
-      return 'hls';
-    }
-    if (url.endsWith('.mpd')) {
-      return 'dash';
-    }
-    return 'progressive';
-  }
-
-  // this seems very generic. one could put it in a helper
-  // and use it in many adapter implementations.
-  getStreamSources(url) {
-    let mpdUrl       = null;
-    let m3u8Url      = null;
-    let progUrl      = null;
-    const streamType = this.getStreamType(url);
-    switch (streamType) {
-      case 'hls':
-        m3u8Url = url;
-        break;
-      case 'dash':
-        mpdUrl = url;
-        break;
-      default:
-        progUrl = url;
-    }
-    return {
-      mpdUrl,
-      m3u8Url,
-      progUrl
-    };
-  }
-
-  getVideoWindowDimensions(player) {
-    // return {
-    //   width : player.width(),
-    //   height: player.height()
-    // };
-    return {
-        width : player.el_.clientWidth,
-        height: player.el_.clientHeight
-    }
-  }
-
-  getVideoSourceDimensions(tech) {
-    return {
-      videoWidth : tech.videoWidth(),
-      videoHeight: tech.videoHeight()
-    };
-  }
-
-  /**
-   * @returns {string} 'native' | 'flash' | 'html5'
-   */
-  getVideojsSourceHandlerMode_() {
-    const tech = this.player.tech({IWillNotUseThisInPlugins: true});
-
-    if (!tech.sourceHandler_) {
-      return 'native';
-    } else {
-      return tech.sourceHandler_.options_.mode;
-    }
-  }
-
-  register() {
-    const that = this;
-    this.player.on('loadedmetadata', function() {
-      const streamType = that.getStreamType(this.currentSrc());
-      const sources    = that.getStreamSources(this.currentSrc());
-      const mode = that.getVideojsSourceHandlerMode_();
-      const info       = {
-        isLive     : this.duration() === Infinity,
-        version    : videojs.VERSION,
-        type       : mode,
-        duration   : this.duration(),
-        streamType,
-        autoplay   : this.autoplay(),
-        ...sources,
-        ...that.getVideoWindowDimensions(this),
-        videoWindowWidth : this.videoWidth(),
-        videoWindowHeight: this.videoHeight(),
-        muted      : this.muted()
-      };
-      that.stateMachine.updateMetadata(info);
-      that.eventCallback(Events.SOURCE_LOADED, info);
-    });
-
-    this.player.on('loadeddata', function() {
-    });
-
-    this.player.ready(function() {
-      const streamType = that.getStreamType(this.currentSrc());
-      const sources    = that.getStreamSources(this.currentSrc());
-      const mode = that.getVideojsSourceHandlerMode_();
-      let playerDimensions = that.getVideoWindowDimensions(this);
-
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-
-
-      const info       = {
-        isLive     : false,
-        version    : videojs.VERSION,
-        type       : mode,
-        duration   : this.duration(),
-        streamType,
-        autoplay   : this.autoplay(),
-        ...sources,
-        ...that.getVideoWindowDimensions(this),
-        // videoWindowWidth : this.videoWidth(),
-        // videoWindowHeight: this.videoHeight(),
-        videoWindowWidth : playerDimensions.width,
-        videoWindowHeight: playerDimensions.height,
-        muted      : this.muted(),
-        currentVideoData: currentVideoData
-      };
-      that.eventCallback(Events.READY, info);
-    });
-    
-    this.player.on('play', function() {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']          = attributes.BANDWIDTH;
-          currentVideoData['width']            = attributes.RESOLUTION.width;
-          currentVideoData['height']           = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.PLAY, {
-        currentTime: this.currentTime(),
-        currentVideoData: currentVideoData
-      });
-    });
-
-    this.player.on('pause', function() {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.PAUSE, {
-        currentTime: this.currentTime(),
-        currentVideoData: currentVideoData
-      });
-    });
-    this.player.on('ended', function() {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.END, {
-        currentTime: this.currentTime()
-      });
-    });
-    this.player.on('error', function() {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-        }
-      }
-
-      const error = this.error();
-      that.eventCallback(Events.ERROR, {
-        currentTime: this.currentTime(),
-        code       : error.code,
-        message    : error.message
-      });
-    });
-    this.player.on('volumechange', function() {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      const muted = this.muted();
-      if (muted) {
-        that.eventCallback(Events.MUTE, {
-          currentTime: this.currentTime(),
-          currentVideoData: currentVideoData
-        });
-      } else {
-        that.eventCallback(Events.UN_MUTE, {
-          currentTime: this.currentTime(),
-          currentVideoData: currentVideoData
-        });
-      }
-    });
-    this.player.on('seeking', function () {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.SEEK, {
-        currentTime: this.currentTime(),
-        droppedFrames: 0,
-        currentVideoData: currentVideoData
-      });
-    });
-    this.player.on('seeked', function () {
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      if (this.tech_.hls) {
-        const selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.SEEKED, {
-        currentTime: this.currentTime(),
-        droppedFrames: 0,
-        currentVideoData: currentVideoData
-      });
-    });
-
-    let analyticsBitrate;
-    let bufferingTimeout;
-    // eslint-disable-next-line
-    let lastTimeupdate   = Date.now();
-    let isStalling       = false;
-
-    this.player.on('timeupdate', function() {
-      clearTimeout(bufferingTimeout);
-      isStalling     = false;
-      lastTimeupdate = Date.now();
-
-      let currentVideoData = {width:null, height:null, bitrate:null};
-      let selectedPlaylist = null;
-      if (this.tech_.hls) {
-        selectedPlaylist = this.tech_.hls.playlists.media();
-        if (selectedPlaylist) {
-          const {attributes} = selectedPlaylist;
-          currentVideoData['bitrate']      = attributes.BANDWIDTH;
-          currentVideoData['width']        = attributes.RESOLUTION.width;
-          currentVideoData['height']       = attributes.RESOLUTION.height;
-          currentVideoData['videoCodec']       = attributes.CODECS.split(",")[0];
-          currentVideoData['audioCodec']       = attributes.CODECS.split(",")[1];
-        }
-      }
-
-      that.eventCallback(Events.TIMECHANGED, {
-        currentTime: this.currentTime(),
-        currentVideoData: currentVideoData
-      });
-
-      // // that is not the quality that is currently being played.
-      // // for more accuracy one can use the segment-metadata cue tracking:
-      // // https://github.com/videojs/videojs-contrib-hls#segment-metadata
-      // const selectedPlaylist = this.tech_.hls.playlists.media();
-      if (!selectedPlaylist) {
-        return;
-      }
-      //
-      const {attributes} = selectedPlaylist;
-      const bitrate      = attributes.BANDWIDTH;
-      const width        = attributes.RESOLUTION.width;
-      const height       = attributes.RESOLUTION.height;
-      const videoCodec       = attributes.CODECS.split(",")[0];
-      const audioCodec       = attributes.CODECS.split(",")[1];
-
-      // let currentVideoData = {width:null, height:null, bitrate:null}
-      // if (selectedPlaylist) {
-      //   const {attributes} = selectedPlaylist;
-      //   currentVideoData['bitrate']      = bitrate;
-      //   currentVideoData['width']        = width;
-      //   currentVideoData['height']       = height;
-      // }
-
-      if (analyticsBitrate !== bitrate) {
-        const eventObject = {
-          width,
-          height,
-          bitrate,
-          videoCodec,
-          audioCodec,
-          currentTime: this.currentTime(),
-          currentVideoData: currentVideoData
-        };
-
-        that.eventCallback(Events.VIDEO_CHANGE, eventObject);
-        analyticsBitrate = bitrate;
-      }
-
-      bufferingTimeout = setTimeout(() => {
-        if ((this.paused() || this.ended()) && !isStalling) {
-          return;
-        }
-
-        that.eventCallback(Events.START_BUFFERING, {
-          currentTime: this.currentTime()
-        });
-      }, BUFFERING_TIMECHANGED_TIMEOUT);
-
-      // Check for HLS source-handler (videojs-contrib-hls)
-      // When we just use Videojs without any specific source-handler (not using MSE API based engine)
-      // but just native technology (HTML5/Flash) to do for example "progressive download" with plain Webm/Mp4
-      // or use native HLS on Safari this may not not be present. In that case Videojs is just
-      // a wrapper around the respective playback tech (HTML or Flash).
-
-      const tech = this.tech({IWillNotUseThisInPlugins: true});
-      if (tech.hls) {
-
-        // From here we are going onto Videojs-HLS source-handler specific API
-        //
-        const hls = this.tech_.hls;
-
-        // Maybe we have the HLS source-handler initialized, but it is
-        // not actually activated and used (just wrapping HTML5 built-in HLS playback like in Safari)
-        if (!hls.playlists || typeof hls.playlists.media !== 'function') {
-          return;
-        }
-
-        // Check for current media playlist
-        const selectedPlaylist = hls.playlists.media();
-        if (!selectedPlaylist) {
-          return;
-        }
-
-        const {attributes} = selectedPlaylist;
-        const bitrate      = attributes.BANDWIDTH;
-        const width        = attributes.RESOLUTION.width;
-        const height       = attributes.RESOLUTION.height;
-        const videoCodec       = attributes.CODECS.split(",")[0];
-        const audioCodec       = attributes.CODECS.split(",")[1];
-
-        let currentVideoData = {
-          width:width,
-          height:height,
-          bitrate:bitrate,
-          videoCodec:videoCodec,
-          audioCodec:audioCodec
-        }
-
-        // update actual bitrate
-        if (isNaN(analyticsBitrate) || analyticsBitrate !== bitrate) {
-          const eventObject = {
-            width,
-            height,
-            bitrate,
-            currentTime: this.currentTime(),
-            currentVideoData: currentVideoData
-          };
-
-          that.eventCallback(Events.VIDEO_CHANGE, eventObject);
-          analyticsBitrate = bitrate;
-        }
-      }
-
-    });
-
-    this.player.on('stalled', function() {
-      isStalling = true;
-    });
-
-    if (typeof window !== "undefined")
-    {
-      window.onunload = window.onbeforeunload = () => {
-        if (!this.onBeforeUnLoadEvent) {
-          this.onBeforeUnLoadEvent = true;
-          this.eventCallback(Events.UNLOAD, {
-            currentTime: this.player.currentTime()
-            
-          });
-        }
-      };
-    }
-    else
-    {
-      if (!this.onBeforeUnLoadEvent) {
-        this.onBeforeUnLoadEvent = true;
-        this.eventCallback(Events.UNLOAD, {
-          currentTime: this.player.currentTime()
-        });
-      }
-    }
-    
-  }
-}
-
-export default VideoJsAdapter;