2017-02-13 22:34:30 +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" / >
2017-02-22 19:44:07 +00:00
< title > DASH Media Packaging SDK: shaka::media::WebVttSampleConverter Class Reference< / title >
2017-02-13 22:34:30 +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)">
< 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 >
<!-- 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 >
2017-02-22 19:44:07 +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 = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html" > WebVttSampleConverter< / a > < / li > < / ul >
2017-02-13 22:34:30 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
2017-02-22 19:44:07 +00:00
< a href = "../../db/da9/classshaka_1_1media_1_1WebVttSampleConverter-members.html" > List of all members< / a > < / div >
2017-02-13 22:34:30 +00:00
< div class = "headertitle" >
2017-02-22 19:44:07 +00:00
< div class = "title" > shaka::media::WebVttSampleConverter Class Reference< / div > < / div >
2017-02-13 22:34:30 +00:00
< / div > <!-- header -->
< div class = "contents" >
2017-02-22 19:44:07 +00:00
< p > < code > #include < < a class = "el" href = "../../db/d0b/webvtt__sample__converter_8h_source.html" > webvtt_sample_converter.h< / a > > < / code > < / p >
2017-02-13 22:34:30 +00:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2017-03-15 20:49:01 +00:00
< tr class = "memitem:a651f604362b1dd2660a6fbcdacb75331" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a651f604362b1dd2660a6fbcdacb75331" > PushCue< / a > (const < a class = "el" href = "../../dd/dce/structshaka_1_1media_1_1Cue.html" > Cue< / a > & cue)< / td > < / tr >
< tr class = "separator:a651f604362b1dd2660a6fbcdacb75331" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa02d5ce7d9609b3841835fbab74b8c81" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#aa02d5ce7d9609b3841835fbab74b8c81" > Flush< / a > ()< / td > < / tr >
2017-02-22 19:44:07 +00:00
< tr class = "separator:aa02d5ce7d9609b3841835fbab74b8c81" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-03-15 20:49:01 +00:00
< tr class = "memitem:a3b0e60f307c5ea57d232216eced6af76" > < td class = "memItemLeft" align = "right" valign = "top" > virtual size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a3b0e60f307c5ea57d232216eced6af76" > ReadySamplesSize< / a > ()< / td > < / tr >
2017-02-22 19:44:07 +00:00
< tr class = "separator:a3b0e60f307c5ea57d232216eced6af76" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-03-15 20:49:01 +00:00
< tr class = "memitem:a43fa59b53f847b638cf32c6f03f87dcd" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::shared_ptr< br class = "typebreak" / >
< < a class = "el" href = "../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" > MediaSample< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/ddd/classshaka_1_1media_1_1WebVttSampleConverter.html#a43fa59b53f847b638cf32c6f03f87dcd" > PopSample< / a > ()< / td > < / tr >
2017-02-22 19:44:07 +00:00
< tr class = "separator:a43fa59b53f847b638cf32c6f03f87dcd" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-02-13 22:34:30 +00:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > According to the spec, when cues overlap, samples must be created.< br / >
The example below has 2 WebVTT cues:< br / >
00:01:00.000 – > 00:02:00.000< br / >
hello< br / >
< br / >
00:01:15.000 – > 00:02:15.000< br / >
how are you?< br / >
< br / >
These are added (AddSample()) as 2 samples but must be split into 3 samples and 4 cues ('vttc' boxes).< br / >
First sample:< br / >
start_time: 00:01:00.000< br / >
duration: 15 seconds< br / >
cue payload: hello< br / >
< br / >
Second sample:< br / >
start_time: 00:01:15.000< br / >
duration: 45 seconds< br / >
cue payload: hello< br / >
cue payload: how are you?< br / >
< br / >
Third sample:< br / >
start_time: 00:02:00.000< br / >
duration: 15 seconds< br / >
cue payload: how are you?< br / >
< br / >
2017-03-15 20:49:01 +00:00
This class buffers the samples that are passed to AddSample() and creates more samples as necessary. Methods are virtual only for mocking, not intended for inheritance. < / p >
2017-02-13 22:34:30 +00:00
2017-03-15 20:49:01 +00:00
< p > Definition at line < a class = "el" href = "../../db/d0b/webvtt__sample__converter_8h_source.html#l00055" > 55< / a > of file < a class = "el" href = "../../db/d0b/webvtt__sample__converter_8h_source.html" > webvtt_sample_converter.h< / a > .< / p >
2017-02-13 22:34:30 +00:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2017-02-22 19:44:07 +00:00
< a class = "anchor" id = "aa02d5ce7d9609b3841835fbab74b8c81" > < / a >
2017-02-13 22:34:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
2017-03-15 20:49:01 +00:00
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
2017-02-13 22:34:30 +00:00
< table class = "memname" >
< tr >
2017-02-22 19:44:07 +00:00
< td class = "memname" > void shaka::media::WebVttSampleConverter::Flush < / td >
2017-02-13 22:34:30 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2017-03-15 20:49:01 +00:00
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
2017-02-13 22:34:30 +00:00
< / div > < div class = "memdoc" >
2017-03-15 20:49:01 +00:00
< p > Process all the buffered samples. This finalizes the object and further calls to PushSample() may result in an undefined behavior. < / p >
2017-02-13 22:34:30 +00:00
2017-03-15 20:49:01 +00:00
< p > Definition at line < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00174" > 174< / a > of file < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html" > webvtt_sample_converter.cc< / a > .< / p >
2017-02-13 22:34:30 +00:00
< / div >
< / div >
2017-02-22 19:44:07 +00:00
< a class = "anchor" id = "a43fa59b53f847b638cf32c6f03f87dcd" > < / a >
2017-02-13 22:34:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
2017-03-15 20:49:01 +00:00
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
2017-02-13 22:34:30 +00:00
< table class = "memname" >
< tr >
2017-02-22 19:44:07 +00:00
< td class = "memname" > std::shared_ptr< < a class = "el" href = "../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" > MediaSample< / a > > shaka::media::WebVttSampleConverter::PopSample < / td >
2017-02-13 22:34:30 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2017-03-15 20:49:01 +00:00
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
2017-02-13 22:34:30 +00:00
< / div > < div class = "memdoc" >
< p > Returns a < a class = "el" href = "../../d7/d6d/classshaka_1_1media_1_1MediaSample.html" title = "Class to hold a media sample. " > MediaSample< / a > that is non-overlapping with the previous samples that it has output. The data in the sample is one or more ISO-BMFF boxes for the duration of the sample. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > The first sample that is ready to be processed. < / dd > < / dl >
2017-03-15 20:49:01 +00:00
< p > Definition at line < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00199" > 199< / a > of file < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html" > webvtt_sample_converter.cc< / a > .< / p >
2017-02-13 22:34:30 +00:00
< / div >
< / div >
2017-03-15 20:49:01 +00:00
< a class = "anchor" id = "a651f604362b1dd2660a6fbcdacb75331" > < / a >
2017-02-13 22:34:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
2017-03-15 20:49:01 +00:00
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
2017-02-13 22:34:30 +00:00
< table class = "memname" >
< tr >
2017-03-15 20:49:01 +00:00
< td class = "memname" > void shaka::media::WebVttSampleConverter::PushCue < / td >
2017-02-13 22:34:30 +00:00
< td > (< / td >
2017-03-15 20:49:01 +00:00
< td class = "paramtype" > const < a class = "el" href = "../../dd/dce/structshaka_1_1media_1_1Cue.html" > Cue< / a > &   < / td >
< td class = "paramname" > < em > cue< / em > < / td > < td > )< / td >
2017-02-13 22:34:30 +00:00
< td > < / td >
< / tr >
< / table >
2017-03-15 20:49:01 +00:00
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
2017-02-13 22:34:30 +00:00
< / div > < div class = "memdoc" >
2017-03-15 20:49:01 +00:00
< p > Add a webvtt cue. < / p >
2017-02-13 22:34:30 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2017-03-15 20:49:01 +00:00
< tr > < td class = "paramname" > cue< / td > < td > is a webvtt cue. < / td > < / tr >
2017-02-13 22:34:30 +00:00
< / table >
< / dd >
< / dl >
2017-03-15 20:49:01 +00:00
< p > Definition at line < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00139" > 139< / a > of file < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html" > webvtt_sample_converter.cc< / a > .< / p >
2017-02-13 22:34:30 +00:00
< / div >
< / div >
2017-02-22 19:44:07 +00:00
< a class = "anchor" id = "a3b0e60f307c5ea57d232216eced6af76" > < / a >
2017-02-13 22:34:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
2017-03-15 20:49:01 +00:00
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
2017-02-13 22:34:30 +00:00
< table class = "memname" >
< tr >
2017-02-22 19:44:07 +00:00
< td class = "memname" > size_t shaka::media::WebVttSampleConverter::ReadySamplesSize < / td >
2017-02-13 22:34:30 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2017-03-15 20:49:01 +00:00
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
2017-02-13 22:34:30 +00:00
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The number of samples that are processed and ready to be popped. < / dd > < / dl >
2017-03-15 20:49:01 +00:00
< p > Definition at line < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html#l00195" > 195< / a > of file < a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html" > webvtt_sample_converter.cc< / a > .< / p >
2017-02-13 22:34:30 +00:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
2017-02-22 19:44:07 +00:00
< li > media/formats/webvtt/< a class = "el" href = "../../db/d0b/webvtt__sample__converter_8h_source.html" > webvtt_sample_converter.h< / a > < / li >
< li > media/formats/webvtt/< a class = "el" href = "../../d4/df5/webvtt__sample__converter_8cc_source.html" > webvtt_sample_converter.cc< / a > < / li >
2017-02-13 22:34:30 +00:00
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2017-05-23 17:39:33 +00:00
Generated on Tue May 23 2017 17:39:30 for DASH Media Packaging SDK by   < a href = "http://www.doxygen.org/index.html" >
2017-02-13 22:34:30 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
