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::media::SyncPointQueue 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" > < b > media< / b > < / li > < li class = "navelem" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html" > SyncPointQueue< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "../../d7/d5a/classshaka_1_1media_1_1SyncPointQueue-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > shaka::media::SyncPointQueue Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > A synchronized queue for cue points.
< a href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "../../d3/d5f/sync__point__queue_8h_source.html" > sync_point_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 >
< tr class = "memitem:ad768d93e6a812c5430371f076ee5da70" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "ad768d93e6a812c5430371f076ee5da70" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > SyncPointQueue< / b > (const < a class = "el" href = "../../dd/dfd/structshaka_1_1AdCueGeneratorParams.html" > AdCueGeneratorParams< / a > & params)< / td > < / tr >
< tr class = "separator:ad768d93e6a812c5430371f076ee5da70" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a84f1c4ad047ffa4bd75d5d1426bf9cd2" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a84f1c4ad047ffa4bd75d5d1426bf9cd2" > AddThread< / a > ()< / td > < / tr >
< tr class = "separator:a84f1c4ad047ffa4bd75d5d1426bf9cd2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a77ec615ca1fa21d347bf03c537af9ed8" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a77ec615ca1fa21d347bf03c537af9ed8" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a77ec615ca1fa21d347bf03c537af9ed8" > Cancel< / a > ()< / td > < / tr >
< tr class = "memdesc:a77ec615ca1fa21d347bf03c537af9ed8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Cancel the queue and unblock all threads. < br / > < / td > < / tr >
< tr class = "separator:a77ec615ca1fa21d347bf03c537af9ed8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aef18f6547ff76cb8c6a5e14270950a59" > < td class = "memItemLeft" align = "right" valign = "top" > double  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#aef18f6547ff76cb8c6a5e14270950a59" > GetHint< / a > (double time_in_seconds)< / td > < / tr >
< tr class = "separator:aef18f6547ff76cb8c6a5e14270950a59" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a49bdaa61608fe2229eaff4032dd804b1" > < td class = "memItemLeft" align = "right" valign = "top" > std::shared_ptr< const < a class = "el" href = "../../da/d93/structshaka_1_1media_1_1CueEvent.html" > CueEvent< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a49bdaa61608fe2229eaff4032dd804b1" > GetNext< / a > (double hint_in_seconds)< / td > < / tr >
< tr class = "separator:a49bdaa61608fe2229eaff4032dd804b1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a17af2cb9949f40ee8aa06cfdd55b2c16" > < td class = "memItemLeft" align = "right" valign = "top" > std::shared_ptr< const < a class = "el" href = "../../da/d93/structshaka_1_1media_1_1CueEvent.html" > CueEvent< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a17af2cb9949f40ee8aa06cfdd55b2c16" > PromoteAt< / a > (double time_in_seconds)< / td > < / tr >
< tr class = "separator:a17af2cb9949f40ee8aa06cfdd55b2c16" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5d27bfb8e8c3209222352f721f9b5236" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a5d27bfb8e8c3209222352f721f9b5236" > HasMore< / a > (double hint_in_seconds) const< / td > < / tr >
< tr class = "separator:a5d27bfb8e8c3209222352f721f9b5236" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > A synchronized queue for cue points. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "../../d3/d5f/sync__point__queue_8h_source.html#l00020" > 20< / a > of file < a class = "el" href = "../../d3/d5f/sync__point__queue_8h_source.html" > sync_point_queue.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a84f1c4ad047ffa4bd75d5d1426bf9cd2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a84f1c4ad047ffa4bd75d5d1426bf9cd2" > ◆ < / a > < / span > AddThread()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void shaka::media::SyncPointQueue::AddThread < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Add a new thread. Each thread using this instance must call this method in order to keep track of its clients. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html#l00025" > 25< / a > of file < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > .< / p >
< / div >
< / div >
< a id = "aef18f6547ff76cb8c6a5e14270950a59" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aef18f6547ff76cb8c6a5e14270950a59" > ◆ < / a > < / span > GetHint()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > double shaka::media::SyncPointQueue::GetHint < / td >
< td > (< / td >
< td class = "paramtype" > double  < / td >
< td class = "paramname" > < em > time_in_seconds< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > A hint for when the next cue event would be. The returned hint is not less than < em > time_in_seconds< / em > . The actual time for the next cue event will not be less than the returned hint, with the exact value depends on promotion. < / dd > < / dl >
< p class = "definition" > Definition at line < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html#l00038" > 38< / a > of file < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > .< / p >
< / div >
< / div >
< a id = "a49bdaa61608fe2229eaff4032dd804b1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a49bdaa61608fe2229eaff4032dd804b1" > ◆ < / a > < / span > GetNext()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::shared_ptr< const < a class = "el" href = "../../da/d93/structshaka_1_1media_1_1CueEvent.html" > CueEvent< / a > > shaka::media::SyncPointQueue::GetNext < / td >
< td > (< / td >
< td class = "paramtype" > double  < / td >
< td class = "paramname" > < em > hint_in_seconds< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The next cue based on a previous hint. If a cue has been promoted that comes after < em > hint_in_seconds< / em > it is returned. If no cue after < em > hint_in_seconds< / em > has been promoted, this will block until either a cue is promoted or all threads are blocked (in which case, the unpromoted cue at < em > hint_in_seconds< / em > will be self-promoted and returned) or < a class = "el" href = "../../d0/dea/classshaka_1_1media_1_1SyncPointQueue.html#a77ec615ca1fa21d347bf03c537af9ed8" title = "Cancel the queue and unblock all threads. " > Cancel()< / a > is called. < / dd > < / dl >
< p class = "definition" > Definition at line < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html#l00054" > 54< / a > of file < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > .< / p >
< / div >
< / div >
< a id = "a5d27bfb8e8c3209222352f721f9b5236" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5d27bfb8e8c3209222352f721f9b5236" > ◆ < / a > < / span > HasMore()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool shaka::media::SyncPointQueue::HasMore < / td >
< td > (< / td >
< td class = "paramtype" > double  < / td >
< td class = "paramname" > < em > hint_in_seconds< / em > < / td > < td > )< / td >
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > True if there are more cues after the given hint. The hint must be a hint returned from |GetHint|. Using any other value results in undefined behavior. < / dd > < / dl >
< p class = "definition" > Definition at line < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html#l00090" > 90< / a > of file < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > .< / p >
< / div >
< / div >
< a id = "a17af2cb9949f40ee8aa06cfdd55b2c16" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a17af2cb9949f40ee8aa06cfdd55b2c16" > ◆ < / a > < / span > PromoteAt()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::shared_ptr< const < a class = "el" href = "../../da/d93/structshaka_1_1media_1_1CueEvent.html" > CueEvent< / a > > shaka::media::SyncPointQueue::PromoteAt < / td >
< td > (< / td >
< td class = "paramtype" > double  < / td >
< td class = "paramname" > < em > time_in_seconds< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Promote the first cue that is not greater than < em > time_in_seconds< / em > . All unpromoted cues before the cue will be discarded. < / p >
< p class = "definition" > Definition at line < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html#l00084" > 84< / a > of file < a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > packager/media/chunking/< a class = "el" href = "../../d3/d5f/sync__point__queue_8h_source.html" > sync_point_queue.h< / a > < / li >
< li > packager/media/chunking/< a class = "el" href = "../../dc/d52/sync__point__queue_8cc_source.html" > sync_point_queue.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2018-08-16 00:35:22 +00:00
Generated on Wed Aug 15 2018 17:34:27 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 >
