Source: externs/shaka/abr_manager.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. /**
  9.  * @externs
  10.  */
  13. /**
  14.  * An object which selects Streams from a set of possible choices.  This also
  15.  * watches for system changes to automatically adapt for the current streaming
  16.  * requirements.  For example, when the network slows down, this class is in
  17.  * charge of telling the Player which streams to switch to in order to reduce
  18.  * the required bandwidth.
  19.  *
  20.  * This class is given a set of streams to choose from when the Player starts
  21.  * up.  This class should store these and use them to make future decisions
  22.  * about ABR.  It is up to this class how those decisions are made.  All the
  23.  * Player will do is tell this class what streams to choose from.
  24.  *
  25.  * @interface
  26.  * @exportDoc
  27.  */
  28. shaka.extern.AbrManager = class {
  29.   constructor() {}
  31.   /**
  32.    * Initializes the AbrManager.
  33.    *
  34.    * @param {shaka.extern.AbrManager.SwitchCallback} switchCallback
  35.    * @exportDoc
  36.    */
  37.   init(switchCallback) {}
  39.   /**
  40.    * Stops any background timers and frees any objects held by this instance.
  41.    * This will only be called after a call to init.
  42.    *
  43.    * @exportDoc
  44.    */
  45.   stop() {}
  47.   /**
  48.    * Updates manager's variants collection.
  49.    *
  50.    * @param {!Array.<!shaka.extern.Variant>} variants
  51.    * @exportDoc
  52.    */
  53.   setVariants(variants) {}
  55.   /**
  56.    * Chooses one variant to switch to.  Called by the Player.
  57.    * @return {shaka.extern.Variant}
  58.    * @exportDoc
  59.    */
  60.   chooseVariant() {}
  62.   /**
  63.    * Enables automatic Variant choices from the last ones passed to setVariants.
  64.    * After this, the AbrManager may call switchCallback() at any time.
  65.    *
  66.    * @exportDoc
  67.    */
  68.   enable() {}
  70.   /**
  71.    * Disables automatic Stream suggestions. After this, the AbrManager may not
  72.    * call switchCallback().
  73.    *
  74.    * @exportDoc
  75.    */
  76.   disable() {}
  78.   /**
  79.    * Notifies the AbrManager that a segment has been downloaded (includes MP4
  80.    * SIDX data, WebM Cues data, initialization segments, and media segments).
  81.    *
  82.    * @param {number} deltaTimeMs The duration, in milliseconds, that the request
  83.    *     took to complete.
  84.    * @param {number} numBytes The total number of bytes transferred.
  85.    * @exportDoc
  86.    */
  87.   segmentDownloaded(deltaTimeMs, numBytes) {}
  89.   /**
  90.    * Gets an estimate of the current bandwidth in bit/sec.  This is used by the
  91.    * Player to generate stats.
  92.    *
  93.    * @return {number}
  94.    * @exportDoc
  95.    */
  96.   getBandwidthEstimate() {}
  98.   /**
  99.    * Updates manager playback rate.
  100.    *
  101.    * @param {number} rate
  102.    * @exportDoc
  103.    */
  104.   playbackRateChanged(rate) {}
  106.   /**
  107.    * Set media element.
  108.    *
  109.    * @param {HTMLMediaElement} mediaElement
  110.    * @exportDoc
  111.    */
  112.   setMediaElement(mediaElement) {}
  114.   /**
  115.    * Sets the ABR configuration.
  116.    *
  117.    * It is the responsibility of the AbrManager implementation to implement the
  118.    * restrictions behavior described in shaka.extern.AbrConfiguration.
  119.    *
  120.    * @param {shaka.extern.AbrConfiguration} config
  121.    * @exportDoc
  122.    */
  123.   configure(config) {}
  124. };
  127. /**
  128.  * A callback into the Player that should be called when the AbrManager decides
  129.  * it's time to change to a different variant.
  130.  *
  131.  * The first argument is a variant to switch to.
  132.  *
  133.  * The second argument is an optional boolean. If true, all data will be removed
  134.  * from the buffer, which will result in a buffering event. Unless a third
  135.  * argument is passed.
  136.  *
  137.  * The third argument in an optional number that specifies how much data (in
  138.  * seconds) should be retained when clearing the buffer. This can help achieve
  139.  * a fast switch that doesn't involve a buffering event. A minimum of two video
  140.  * segments should always be kept buffered to avoid temporary hiccups.
  141.  *
  142.  * @typedef {function(shaka.extern.Variant, boolean=, number=)}
  143.  * @exportDoc
  144.  */
  145. shaka.extern.AbrManager.SwitchCallback;
  148. /**
  149.  * A factory for creating the abr manager.
  150.  *
  151.  * @typedef {function():!shaka.extern.AbrManager}
  152.  * @exportDoc
  153.  */
  154. shaka.extern.AbrManager.Factory;