Source: lib/ads/ads_stats.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.ads.AdsStats');
  10. /**
  11.  * This class tracks all the various components (some optional) that are used to
  12.  * populate |shaka.extern.AdsStats| which is passed to the app.
  13.  *
  14.  * @final
  15.  */
  16. shaka.ads.AdsStats = class {
  17.   /** */
  18.   constructor() {
  19.     /** @private {!Array<number>} */
  20.     this.loadTimes_ = [];
  21.     /** @private {number} */
  22.     this.started_ = 0;
  23.     /** @private {number} */
  24.     this.overlayAds_ = 0;
  25.     /** @private {number} */
  26.     this.playedCompletely_ = 0;
  27.     /** @private {number} */
  28.     this.skipped_ = 0;
  29.     /** @private {number} */
  30.     this.errors_ = 0;
  31.   }
  33.   /**
  34.    * Record the time it took to get the final manifest.
  35.    *
  36.    * @param {number} seconds
  37.    */
  38.   addLoadTime(seconds) {
  39.     this.loadTimes_.push(seconds);
  40.   }
  42.   /**
  43.    * Increase the number of ads started by one.
  44.    */
  45.   incrementStarted() {
  46.     this.started_++;
  47.   }
  49.   /**
  50.    * Increase the number of overlay ads started by one.
  51.    */
  52.   incrementOverlayAds() {
  53.     this.overlayAds_++;
  54.   }
  56.   /**
  57.    * Increase the number of ads played completely by one.
  58.    */
  59.   incrementPlayedCompletely() {
  60.     this.playedCompletely_++;
  61.   }
  63.   /**
  64.    * Increase the number of ads skipped by one.
  65.    */
  66.   incrementSkipped() {
  67.     this.skipped_++;
  68.   }
  70.   /**
  71.    * Increase the number of ads with error by one.
  72.    */
  73.   incrementErrors() {
  74.     this.errors_++;
  75.   }
  77.   /**
  78.    * @return {number}
  79.    * @private
  80.    */
  81.   getAverageLoadTime_() {
  82.     if (!this.loadTimes_.length) {
  83.       return 0;
  84.     }
  85.     const sum = this.loadTimes_.reduce(
  86.         (accumulator, currentValue) => accumulator + currentValue, 0);
  87.     return sum / this.loadTimes_.length;
  88.   }
  90.   /**
  91.    * Create a stats blob that we can pass up to the app. This blob will not
  92.    * reference any internal data.
  93.    *
  94.    * @return {shaka.extern.AdsStats}
  95.    */
  96.   getBlob() {
  97.     return {
  98.       loadTimes: this.loadTimes_,
  99.       averageLoadTime: this.getAverageLoadTime_(),
  100.       started: this.started_,
  101.       overlayAds: this.overlayAds_,
  102.       playedCompletely: this.playedCompletely_,
  103.       skipped: this.skipped_,
  104.       errors: this.errors_,
  105.     };
  106.   }
  107. };