2018-05-23 23:12:00 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.13" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Shaka Packager SDK: shaka::BandwidthEstimator Class Reference< / title >
< link href = "../../tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "../../jquery.js" > < / script >
< script type = "text/javascript" src = "../../dynsections.js" > < / script >
< link href = "../../search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "../../search/searchdata.js" > < / script >
< script type = "text/javascript" src = "../../search/search.js" > < / script >
< link href = "../../doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > Shaka Packager SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
< / script >
< script type = "text/javascript" src = "../../menudata.js" > < / script >
< script type = "text/javascript" src = "../../menu.js" > < / script >
< script type = "text/javascript" >
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
< / script >
< div id = "main-nav" > < / div >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div id = "nav-path" class = "navpath" >
< ul >
< li class = "navelem" > < a class = "el" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html" > BandwidthEstimator< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Classes< / a > |
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-static-attribs" > Static Public Attributes< / a > |
< a href = "../../d4/d8c/classshaka_1_1BandwidthEstimator-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > shaka::BandwidthEstimator Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a5d151457635582d04bb40b329b2370d7" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a5d151457635582d04bb40b329b2370d7" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > BandwidthEstimator< / b > (size_t num_blocks)< / td > < / tr >
< tr class = "separator:a5d151457635582d04bb40b329b2370d7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7c73789c7c3f9b70dd2c23e49640fcc6" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a7c73789c7c3f9b70dd2c23e49640fcc6" > AddBlock< / a > (uint64_t size, double duration)< / td > < / tr >
< tr class = "separator:a7c73789c7c3f9b70dd2c23e49640fcc6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a9414560e16c46e7e2da3683a4dfb86cc" > < td class = "memItemLeft" align = "right" valign = "top" > uint64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a9414560e16c46e7e2da3683a4dfb86cc" > Estimate< / a > () const< / td > < / tr >
< tr class = "separator:a9414560e16c46e7e2da3683a4dfb86cc" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0df6c40f43a89d3d481392ac0298e37c" > < td class = "memItemLeft" align = "right" valign = "top" > uint64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a0df6c40f43a89d3d481392ac0298e37c" > Max< / a > () const< / td > < / tr >
< tr class = "separator:a0df6c40f43a89d3d481392ac0298e37c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-static-attribs" > < / a >
Static Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a418205a0cbb9f742f7f14730e4d628ed" > < td class = "memItemLeft" align = "right" valign = "top" > static constexpr size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../da/d2c/classshaka_1_1BandwidthEstimator.html#a418205a0cbb9f742f7f14730e4d628ed" > kUseAllBlocks< / a > = 0< / td > < / tr >
< tr class = "separator:a418205a0cbb9f742f7f14730e4d628ed" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" >
< p class = "definition" > Definition at line < a class = "el" href = "../../d8/d19/bandwidth__estimator_8h_source.html#l00017" > 17< / a > of file < a class = "el" href = "../../d8/d19/bandwidth__estimator_8h_source.html" > bandwidth_estimator.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a7c73789c7c3f9b70dd2c23e49640fcc6" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a7c73789c7c3f9b70dd2c23e49640fcc6" > ◆ < / a > < / span > AddBlock()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void shaka::BandwidthEstimator::AddBlock < / td >
< td > (< / td >
< td class = "paramtype" > uint64_t  < / td >
< td class = "paramname" > < em > size< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > double  < / td >
< td class = "paramname" > < em > duration< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > size< / td > < td > is the size of the block in bytes. Should be positive. < / td > < / tr >
< tr > < td class = "paramname" > duration< / td > < td > is the length in seconds. Should be positive. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00019" > 19< / a > of file < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html" > bandwidth_estimator.cc< / a > .< / p >
< / div >
< / div >
< a id = "a9414560e16c46e7e2da3683a4dfb86cc" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a9414560e16c46e7e2da3683a4dfb86cc" > ◆ < / a > < / span > Estimate()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint64_t shaka::BandwidthEstimator::Estimate < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The estimate bandwidth, in bits per second, from the harmonic mean of the number of blocks specified in the constructor. The value is rounded up to the nearest integer. < / dd > < / dl >
2018-06-29 00:34:00 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00030" > 30< / a > of file < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html" > bandwidth_estimator.cc< / a > .< / p >
2018-05-23 23:12:00 +00:00
< / div >
< / div >
< a id = "a0df6c40f43a89d3d481392ac0298e37c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0df6c40f43a89d3d481392ac0298e37c" > ◆ < / a > < / span > Max()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint64_t shaka::BandwidthEstimator::Max < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The max bandwidth, in bits per second, of the number of blocks specified in the constructor. The value is rounded up to the nearest integer. < / dd > < / dl >
2018-06-29 00:34:00 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html#l00037" > 37< / a > of file < a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html" > bandwidth_estimator.cc< / a > .< / p >
2018-05-23 23:12:00 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "a418205a0cbb9f742f7f14730e4d628ed" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a418205a0cbb9f742f7f14730e4d628ed" > ◆ < / a > < / span > kUseAllBlocks< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > constexpr size_t shaka::BandwidthEstimator::kUseAllBlocks = 0< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > num_blocks< / td > < td > is the number of latest blocks to use. 0 uses all. < / td > < / tr >
< / table >
< / dd >
< / dl >
< p class = "definition" > Definition at line < a class = "el" href = "../../d8/d19/bandwidth__estimator_8h_source.html#l00020" > 20< / a > of file < a class = "el" href = "../../d8/d19/bandwidth__estimator_8h_source.html" > bandwidth_estimator.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > packager/mpd/base/< a class = "el" href = "../../d8/d19/bandwidth__estimator_8h_source.html" > bandwidth_estimator.h< / a > < / li >
< li > packager/mpd/base/< a class = "el" href = "../../d6/d86/bandwidth__estimator_8cc_source.html" > bandwidth_estimator.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2018-06-29 00:34:00 +00:00
Generated on Thu Jun 28 2018 17:32:56 for Shaka Packager SDK by   < a href = "http://www.doxygen.org/index.html" >
2018-05-23 23:12:00 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.13
< / small > < / address >
< / body >
< / html >
