2015-10-16 00:33:37 +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.6" / >
2016-05-24 23:43:16 +00:00
< title > DASH Media Packaging SDK: shaka::media::OffsetByteQueue Class Reference< / title >
2015-10-16 00:33:37 +00:00
< 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/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / 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 style = "padding-left: 0.5em;" >
< div id = "projectname" > DASH Media Packaging SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "../../index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "../../namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li class = "current" > < a href = "../../annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "../../files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "../../search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "../../annotated.html" > < span > Class  List< / span > < / a > < / li >
< li > < a href = "../../classes.html" > < span > Class  Index< / span > < / a > < / li >
< li > < a href = "../../hierarchy.html" > < span > Class  Hierarchy< / span > < / a > < / li >
< li > < a href = "../../functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2016-05-11 18:03:07 +00:00
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Classes< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < / div >
2015-10-16 00:33:37 +00:00
<!-- 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 >
2016-05-24 23:43:16 +00:00
< li class = "navelem" > < a class = "el" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / li > < li class = "navelem" > < b > media< / b > < / li > < li class = "navelem" > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html" > OffsetByteQueue< / a > < / li > < / ul >
2015-10-16 00:33:37 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
2016-05-24 23:43:16 +00:00
< a href = "../../d1/d4f/classshaka_1_1media_1_1OffsetByteQueue-members.html" > List of all members< / a > < / div >
2015-10-16 00:33:37 +00:00
< div class = "headertitle" >
2016-05-24 23:43:16 +00:00
< div class = "title" > shaka::media::OffsetByteQueue Class Reference< / div > < / div >
2015-10-16 00:33:37 +00:00
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html" > offset_byte_queue.h< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:a68832e85b25a9b543e54033bb70c4df6" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a68832e85b25a9b543e54033bb70c4df6" > PeekAt< / a > (int64_t offset, const uint8_t **buf, int *size)< / td > < / tr >
< tr class = "separator:a68832e85b25a9b543e54033bb70c4df6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a77b9a12145dad80df95845bd2b66b6a8" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a77b9a12145dad80df95845bd2b66b6a8" > Trim< / a > (int64_t max_offset)< / td > < / tr >
< tr class = "separator:a77b9a12145dad80df95845bd2b66b6a8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1dfd11c891dd3b3171002cbc484eacdd" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#a1dfd11c891dd3b3171002cbc484eacdd" > head< / a > ()< / td > < / tr >
< tr class = "separator:a1dfd11c891dd3b3171002cbc484eacdd" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab1aa8f95daa784e4dc1ce34566cea164" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164" > tail< / a > ()< / td > < / tr >
< tr class = "separator:ab1aa8f95daa784e4dc1ce34566cea164" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< tr > < td colspan = "2" > < div class = "groupHeader" > These work like their underlying ByteQueue counterparts.< / div > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:aeba9d73927d141729fe5d743f679b631" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aeba9d73927d141729fe5d743f679b631" > < / a >
2015-10-16 00:33:37 +00:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > Reset< / b > ()< / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:aeba9d73927d141729fe5d743f679b631" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ada47e4998cbad83bdaa058a1cfbc6ef9" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ada47e4998cbad83bdaa058a1cfbc6ef9" > < / a >
2015-10-16 00:33:37 +00:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > Push< / b > (const uint8_t *buf, int size)< / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:ada47e4998cbad83bdaa058a1cfbc6ef9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad72a137b44fd86eda54d3e06b1793f5a" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad72a137b44fd86eda54d3e06b1793f5a" > < / a >
2015-10-16 00:33:37 +00:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > Peek< / b > (const uint8_t **buf, int *size)< / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:ad72a137b44fd86eda54d3e06b1793f5a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0338401ee845918697d3b9884deab3a1" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0338401ee845918697d3b9884deab3a1" > < / a >
2015-10-16 00:33:37 +00:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > Pop< / b > (int count)< / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:a0338401ee845918697d3b9884deab3a1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
2016-05-24 23:43:16 +00:00
< div class = "textblock" > < p > Wrapper around < a class = "el" href = "../../d7/dda/classshaka_1_1media_1_1ByteQueue.html" > ByteQueue< / a > , which encapsulates the notion of a monotonically-increasing byte offset. All buffer access is done by passing these offsets into this class, reducing the proliferation of many different meanings of "offset", "head", etc. < / p >
2015-10-16 00:33:37 +00:00
< p > Definition at line < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html#l00019" > 19< / a > of file < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html" > offset_byte_queue.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a1dfd11c891dd3b3171002cbc484eacdd" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > int64_t shaka::media::OffsetByteQueue::head < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The head position, in terms of the file's absolute offset. < / dd > < / dl >
< p > Definition at line < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html#l00052" > 52< / a > of file < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html" > offset_byte_queue.h< / a > .< / p >
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a68832e85b25a9b543e54033bb70c4df6" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > void shaka::media::OffsetByteQueue::PeekAt < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramtype" > int64_t  < / td >
< td class = "paramname" > < em > offset< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t **  < / td >
< td class = "paramname" > < em > buf< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int *  < / td >
< td class = "paramname" > < em > size< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Set < em > buf< / em > to point at the first buffered byte corresponding to < em > offset< / em > , and < em > size< / em > to the number of bytes available starting from that offset.< / p >
2016-05-24 23:43:16 +00:00
< p > It is an error if the offset is before the current head. It's not an error if the current offset is beyond < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164" > tail()< / a > , but you will of course get back a null < em > buf< / em > and a < em > size< / em > of zero. < / p >
2015-10-16 00:33:37 +00:00
< p > Definition at line < a class = "el" href = "../../df/d1a/offset__byte__queue_8cc_source.html#l00041" > 41< / a > of file < a class = "el" href = "../../df/d1a/offset__byte__queue_8cc_source.html" > offset_byte_queue.cc< / a > .< / p >
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "ab1aa8f95daa784e4dc1ce34566cea164" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > int64_t shaka::media::OffsetByteQueue::tail < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The tail position (exclusive), in terms of the file's absolute offset. < / dd > < / dl >
< p > Definition at line < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html#l00055" > 55< / a > of file < a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html" > offset_byte_queue.h< / a > .< / p >
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a77b9a12145dad80df95845bd2b66b6a8" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > bool shaka::media::OffsetByteQueue::Trim < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramtype" > int64_t  < / td >
< td class = "paramname" > < em > max_offset< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Mark the bytes up to (but not including) < em > max_offset< / em > as ready for deletion. This is relatively inexpensive, but will not necessarily reduce the resident buffer size right away (or ever).< / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > true if the full range of bytes were successfully trimmed, including the case where < em > max_offset< / em > is less than the current head. < / dd >
< dd >
2016-05-24 23:43:16 +00:00
false if < em > max_offset< / em > > < a class = "el" href = "../../d9/df9/classshaka_1_1media_1_1OffsetByteQueue.html#ab1aa8f95daa784e4dc1ce34566cea164" > tail()< / a > (although all bytes currently buffered are still cleared). < / dd > < / dl >
2015-10-16 00:33:37 +00:00
< p > Definition at line < a class = "el" href = "../../df/d1a/offset__byte__queue_8cc_source.html#l00051" > 51< / a > of file < a class = "el" href = "../../df/d1a/offset__byte__queue_8cc_source.html" > offset_byte_queue.cc< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > media/base/< a class = "el" href = "../../de/d34/offset__byte__queue_8h_source.html" > offset_byte_queue.h< / a > < / li >
< li > media/base/< a class = "el" href = "../../df/d1a/offset__byte__queue_8cc_source.html" > offset_byte_queue.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2017-05-02 18:44:28 +00:00
Generated on Tue May 2 2017 18:44:24 for DASH Media Packaging SDK by   < a href = "http://www.doxygen.org/index.html" >
2015-10-16 00:33:37 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
