Source: externs/shaka/abr_manager.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  19. /** @externs */
  22. /**
  23.  * An object which selects Streams from a set of possible choices.  This also
  24.  * watches for system changes to automatically adapt for the current streaming
  25.  * requirements.  For example, when the network slows down, this class is in
  26.  * charge of telling the Player which streams to switch to in order to reduce
  27.  * the required bandwidth.
  28.  *
  29.  * This class is given a set of streams to choose from when the Player starts
  30.  * up.  This class should store these and use them to make future decisions
  31.  * about ABR.  It is up to this class how those decisions are made.  All the
  32.  * Player will do is tell this class what streams to choose from.
  33.  *
  34.  * @interface
  35.  * @exportDoc
  36.  */
  37. shakaExtern.AbrManager = function() {};
  40. /**
  41.  * A callback into the Player that should be called when the AbrManager decides
  42.  * it's time to change to a different variant.
  43.  *
  44.  * The first argument is a variant to switch to.
  45.  *
  46.  * The second argument is an optional boolean.  If true, all data will be
  47.  * from the buffer, which will result in a buffering event.
  48.  *
  49.  * @typedef {function(shakaExtern.Variant, boolean=)}
  50.  * @exportDoc
  51.  */
  52. shakaExtern.AbrManager.SwitchCallback;
  55. /**
  56.  * A factory for creating the abr manager.  This will be called with 'new'.
  57.  *
  58.  * @typedef {function(new:shakaExtern.AbrManager)}
  59.  * @exportDoc
  60.  */
  61. shakaExtern.AbrManager.Factory;
  64. /**
  65.  * Initializes the AbrManager.
  66.  *
  67.  * @param {shakaExtern.AbrManager.SwitchCallback} switchCallback
  68.  * @exportDoc
  69.  */
  70. shakaExtern.AbrManager.prototype.init = function(switchCallback) {};
  73. /**
  74.  * Stops any background timers and frees any objects held by this instance.
  75.  * This will only be called after a call to init.
  76.  *
  77.  * @exportDoc
  78.  */
  79. shakaExtern.AbrManager.prototype.stop = function() {};
  82. /**
  83.  * Updates manager's variants collection.
  84.  *
  85.  * @param {!Array.<!shakaExtern.Variant>} variants
  86.  * @exportDoc
  87.  */
  88. shakaExtern.AbrManager.prototype.setVariants = function(variants) {};
  91. /**
  92.  * Chooses one variant to switch to.  Called by the Player.
  93.  * @return {shakaExtern.Variant}
  94.  * @exportDoc
  95.  */
  96. shakaExtern.AbrManager.prototype.chooseVariant = function() {};
  99. /**
  100.  * Enables automatic Variant choices from the last ones passed to setVariants.
  101.  * After this, the AbrManager may call switchCallback() at any time.
  102.  *
  103.  * @exportDoc
  104.  */
  105. shakaExtern.AbrManager.prototype.enable = function() {};
  108. /**
  109.  * Disables automatic Stream suggestions. After this, the AbrManager may not
  110.  * call switchCallback().
  111.  *
  112.  * @exportDoc
  113.  */
  114. shakaExtern.AbrManager.prototype.disable = function() {};
  117. /**
  118.  * Notifies the AbrManager that a segment has been downloaded (includes MP4
  119.  * SIDX data, WebM Cues data, initialization segments, and media segments).
  120.  *
  121.  * @param {number} deltaTimeMs The duration, in milliseconds, that the request
  122.  *     took to complete.
  123.  * @param {number} numBytes The total number of bytes transferred.
  124.  * @exportDoc
  125.  */
  126. shakaExtern.AbrManager.prototype.segmentDownloaded = function(
  127.     deltaTimeMs, numBytes) {};
  130. /**
  131.  * Gets an estimate of the current bandwidth in bit/sec.  This is used by the
  132.  * Player to generate stats.
  133.  *
  134.  * @return {number}
  135.  * @exportDoc
  136.  */
  137. shakaExtern.AbrManager.prototype.getBandwidthEstimate = function() {};
  140. /**
  141.  * Sets the ABR configuration.
  142.  *
  143.  * It is the responsibility of the AbrManager implementation to implement the
  144.  * restrictions behavior described in shakaExtern.AbrConfiguration.
  145.  *
  146.  * @param {shakaExtern.AbrConfiguration} config
  147.  * @exportDoc
  148.  */
  149. shakaExtern.AbrManager.prototype.configure = function(config) {};