/**
* @license
* Copyright 2016 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** @externs */
/**
* An object which selects Streams for adaptive bit-rate presentations.
*
* @interface
* @exportDoc
*/
shakaExtern.AbrManager = function() {};
/**
* @typedef {function(!Object.<string, !shakaExtern.Stream>, number=)}
* A callback which implementations call to switch streams.
*
* The first argument is a map of content types to chosen streams.
*
* The second argument is an optional number of seconds of content to leave in
* the buffer ahead of the playhead. Anything beyond that will be cleared.
* This is used to make a resolution change take effect sooner, at the cost of
* wasting previously downloaded segments. If undefined, nothing will be
* cleared.
*/
shakaExtern.AbrManager.SwitchCallback;
/**
* Initializes the AbrManager.
*
* @param {shakaExtern.AbrManager.SwitchCallback} switchCallback
* @exportDoc
*/
shakaExtern.AbrManager.prototype.init = function(switchCallback) {};
/**
* Chooses one Stream from each StreamSet to switch to. All StreamSets must be
* from the same Period. Some StreamSets may be absent in the case of language
* changes.
*
* @param {!Object.<string, !shakaExtern.StreamSet>} streamSetsByType
* @return {!Object.<string, shakaExtern.Stream>}
* @exportDoc
*/
shakaExtern.AbrManager.prototype.chooseStreams = function(streamSetsByType) {};
/**
* Enables automatic Stream choices from the last StreamSets passed to
* chooseStreams(). After this, the AbrManager may call switchCallback() at any
* time.
*
* @exportDoc
*/
shakaExtern.AbrManager.prototype.enable = function() {};
/**
* Disables automatic Stream suggestions. After this, the AbrManager may not
* call switchCallback().
*
* @exportDoc
*/
shakaExtern.AbrManager.prototype.disable = function() {};
/**
* Notifies the AbrManager that a segment has been downloaded (includes MP4
* SIDX data, WebM Cues data, initialization segments, and media segments).
*
* @param {number} startTimeMs The wall-clock time, in milliseconds, when the
* request began (before any outbound request filters).
* @param {number} endTimeMs The wall-clock time, in milliseconds, when the
* response ended (after all retries and inbound response filters).
* @param {number} numBytes The total number of bytes transferred.
* @exportDoc
*/
shakaExtern.AbrManager.prototype.segmentDownloaded = function(
startTimeMs, endTimeMs, numBytes) {};
/**
* Stops any background timers and frees any objects held by this instance.
* This will only be called after a call to init.
*
* @exportDoc
*/
shakaExtern.AbrManager.prototype.stop = function() {};
/**
* Gets an estimate of the current bandwidth in bit/sec. This is used by the
* Player to generate stats.
*
* @return {number}
* @exportDoc
*/
shakaExtern.AbrManager.prototype.getBandwidthEstimate = function() {};
/**
* Sets the default bandwidth estimate to use if there is not enough data.
*
* @param {number} estimate The default bandwidth estimate, in bit/sec.
* @exportDoc
*/
shakaExtern.AbrManager.prototype.setDefaultEstimate = function(estimate) {};