Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d9/d40/classshaka_1_1media_1_1WebV...

253 lines
15 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::WebVttParser 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html">WebVttParser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dc/d1f/classshaka_1_1media_1_1WebVttParser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::WebVttParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for shaka::media::WebVttParser:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d9/d40/classshaka_1_1media_1_1WebVttParser.png" usemap="#shaka::media::WebVttParser_map" alt=""/>
<map id="shaka::media::WebVttParser_map" name="shaka::media::WebVttParser_map">
<area href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html" alt="shaka::media::MediaParser" shape="rect" coords="0,0,168,24"/>
</map>
</div></div>
<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:a748578474cffb5e3a817a2eeeca50abb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a748578474cffb5e3a817a2eeeca50abb">Init</a> (const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">InitCB</a> &amp;init_cb, const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#ad86528c837c0a773f7e853c38a4a3af2">NewMediaSampleCB</a> &amp;new_media_sample_cb, const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">NewTextSampleCB</a> &amp;new_text_sample_cb, <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">KeySource</a> *decryption_key_source) override</td></tr>
<tr class="separator:a748578474cffb5e3a817a2eeeca50abb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521d223f2fe3c80f66cdc3bda8c07e91"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#a521d223f2fe3c80f66cdc3bda8c07e91">Flush</a> () override</td></tr>
<tr class="separator:a521d223f2fe3c80f66cdc3bda8c07e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa38d64a81319d43a1194d26e9a39ac1d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d40/classshaka_1_1media_1_1WebVttParser.html#aa38d64a81319d43a1194d26e9a39ac1d">Parse</a> (const uint8_t *buf, int size) override</td></tr>
<tr class="separator:aa38d64a81319d43a1194d26e9a39ac1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classshaka_1_1media_1_1MediaParser"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classshaka_1_1media_1_1MediaParser')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html">shaka::media::MediaParser</a></td></tr>
<tr class="memitem:aef5795d2b3df2526c6e8afe1e4d072bf inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memItemLeft" align="right" valign="top">typedef base::Callback&lt; void(const std::vector&lt; std::shared_ptr&lt; <a class="el" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a> &gt; &gt; &amp;stream_info)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">InitCB</a></td></tr>
<tr class="separator:aef5795d2b3df2526c6e8afe1e4d072bf inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad86528c837c0a773f7e853c38a4a3af2 inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memItemLeft" align="right" valign="top">typedef base::Callback&lt; bool(uint32_t track_id, std::shared_ptr&lt; <a class="el" href="../../d7/d6d/classshaka_1_1media_1_1MediaSample.html">MediaSample</a> &gt; media_sample)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#ad86528c837c0a773f7e853c38a4a3af2">NewMediaSampleCB</a></td></tr>
<tr class="separator:ad86528c837c0a773f7e853c38a4a3af2 inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1df661cd2b63498a87d6a253f6f7c195 inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memItemLeft" align="right" valign="top">typedef base::Callback&lt; bool(uint32_t track_id, std::shared_ptr&lt; <a class="el" href="../../db/d1f/classshaka_1_1media_1_1TextSample.html">TextSample</a> &gt; text_sample)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">NewTextSampleCB</a></td></tr>
<tr class="separator:a1df661cd2b63498a87d6a253f6f7c195 inherit pub_types_classshaka_1_1media_1_1MediaParser"><td class="memSeparator" colspan="2">&#160;</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="../../d0/dbc/webvtt__parser_8h_source.html#l00023">23</a> of file <a class="el" href="../../d0/dbc/webvtt__parser_8h_source.html">webvtt_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a521d223f2fe3c80f66cdc3bda8c07e91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521d223f2fe3c80f66cdc3bda8c07e91">&#9670;&nbsp;</a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::WebVttParser::Flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush data currently in the parser and put the parser in a state where it can receive data for a new seek point. </p><dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a26752164d7e8ae6a9a894512291ad9cd">shaka::media::MediaParser</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html#l00206">206</a> of file <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html">webvtt_parser.cc</a>.</p>
</div>
</div>
<a id="a748578474cffb5e3a817a2eeeca50abb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748578474cffb5e3a817a2eeeca50abb">&#9670;&nbsp;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void shaka::media::WebVttParser::Init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#aef5795d2b3df2526c6e8afe1e4d072bf">InitCB</a> &amp;&#160;</td>
<td class="paramname"><em>init_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#ad86528c837c0a773f7e853c38a4a3af2">NewMediaSampleCB</a> &amp;&#160;</td>
<td class="paramname"><em>new_media_sample_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a1df661cd2b63498a87d6a253f6f7c195">NewTextSampleCB</a> &amp;&#160;</td>
<td class="paramname"><em>new_text_sample_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">KeySource</a> *&#160;</td>
<td class="paramname"><em>decryption_key_source</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the parser with necessary callbacks. Must be called before any data is passed to Parse(). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">init_cb</td><td>will be called once enough data has been parsed to determine the initial stream configurations. </td></tr>
<tr><td class="paramname">new_media_sample_cb</td><td>will be called each time a new media sample is available from the parser. </td></tr>
<tr><td class="paramname">new_text_sample_cb</td><td>will be called each time a new text sample is available from the parser. </td></tr>
<tr><td class="paramname">decryption_key_source</td><td>the key source to decrypt the frames. May be NULL, and caller retains ownership. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a6934a294d4601fdcaf53719ecbcb82ff">shaka::media::MediaParser</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html#l00193">193</a> of file <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html">webvtt_parser.cc</a>.</p>
</div>
</div>
<a id="aa38d64a81319d43a1194d26e9a39ac1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa38d64a81319d43a1194d26e9a39ac1d">&#9670;&nbsp;</a></span>Parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::WebVttParser::Parse </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Should be called when there is new data to parse. </p><dl class="section return"><dt>Returns</dt><dd>true if successful. </dd></dl>
<p>Implements <a class="el" href="../../d3/d0a/classshaka_1_1media_1_1MediaParser.html#a0c85f3cb0591f67c036276be82a1ba9d">shaka::media::MediaParser</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html#l00211">211</a> of file <a class="el" href="../../db/d04/webvtt__parser_8cc_source.html">webvtt_parser.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/formats/webvtt/<a class="el" href="../../d0/dbc/webvtt__parser_8h_source.html">webvtt_parser.h</a></li>
<li>packager/media/formats/webvtt/<a class="el" href="../../db/d04/webvtt__parser_8cc_source.html">webvtt_parser.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:06 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink