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.   }
  29.   /**
  30.    * Record the time it took to get the final manifest.
  31.    *
  32.    * @param {number} seconds
  33.    */
  34.   addLoadTime(seconds) {
  35.     this.loadTimes_.push(seconds);
  36.   }
  38.   /**
  39.    * Increase the number of ads started by one.
  40.    */
  41.   incrementStarted() {
  42.     this.started_++;
  43.   }
  45.   /**
  46.    * Increase the number of ads played completely by one.
  47.    */
  48.   incrementPlayedCompletely() {
  49.     this.playedCompletely_++;
  50.   }
  52.   /**
  53.    * Increase the number of ads skipped by one.
  54.    */
  55.   incrementSkipped() {
  56.     this.skipped_++;
  57.   }
  59.   /**
  60.    * Create a stats blob that we can pass up to the app. This blob will not
  61.    * reference any internal data.
  62.    *
  63.    * @return {shaka.extern.AdsStats}
  64.    */
  65.   getBlob() {
  66.     return {
  67.       loadTimes: this.loadTimes_,
  68.       started: this.started_,
  69.       playedCompletely: this.playedCompletely_,
  70.       skipped: this.skipped_,
  71.     };
  72.   }
  73. };