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.playedCompletely_ = 0;
  25.     /** @private {number} */
  26.     this.skipped_ = 0;
  27.     /** @private {number} */
  28.     this.errors_ = 0;
  29.   }
  31.   /**
  32.    * Record the time it took to get the final manifest.
  33.    *
  34.    * @param {number} seconds
  35.    */
  36.   addLoadTime(seconds) {
  37.     this.loadTimes_.push(seconds);
  38.   }
  40.   /**
  41.    * Increase the number of ads started by one.
  42.    */
  43.   incrementStarted() {
  44.     this.started_++;
  45.   }
  47.   /**
  48.    * Increase the number of ads played completely by one.
  49.    */
  50.   incrementPlayedCompletely() {
  51.     this.playedCompletely_++;
  52.   }
  54.   /**
  55.    * Increase the number of ads skipped by one.
  56.    */
  57.   incrementSkipped() {
  58.     this.skipped_++;
  59.   }
  61.   /**
  62.    * Increase the number of ads with error by one.
  63.    */
  64.   incrementErrors() {
  65.     this.errors_++;
  66.   }
  68.   /**
  69.    * @return {number}
  70.    * @private
  71.    */
  72.   getAverageLoadTime_() {
  73.     if (!this.loadTimes_.length) {
  74.       return 0;
  75.     }
  76.     const sum = this.loadTimes_.reduce(
  77.         (accumulator, currentValue) => accumulator + currentValue, 0);
  78.     return sum / this.loadTimes_.length;
  79.   }
  81.   /**
  82.    * Create a stats blob that we can pass up to the app. This blob will not
  83.    * reference any internal data.
  84.    *
  85.    * @return {shaka.extern.AdsStats}
  86.    */
  87.   getBlob() {
  88.     return {
  89.       loadTimes: this.loadTimes_,
  90.       averageLoadTime: this.getAverageLoadTime_(),
  91.       started: this.started_,
  92.       playedCompletely: this.playedCompletely_,
  93.       skipped: this.skipped_,
  94.       errors: this.errors_,
  95.     };
  96.   }
  97. };