shaka-packager/docs/d8/d86/classshaka_1_1media_1_1WebM...

216 lines
14 KiB
HTML

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::WebMTracksParser 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.9.1 -->
<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','.html');
/* @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="../../d8/d86/classshaka_1_1media_1_1WebMTracksParser.html">WebMTracksParser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../de/d33/classshaka_1_1media_1_1WebMTracksParser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::WebMTracksParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parser for WebM Tracks element.
<a href="../../d8/d86/classshaka_1_1media_1_1WebMTracksParser.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d6/d7b/webm__tracks__parser_8h_source.html">webm_tracks_parser.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::WebMTracksParser:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d8/d86/classshaka_1_1media_1_1WebMTracksParser.png" usemap="#shaka::media::WebMTracksParser_map" alt=""/>
<map id="shaka::media::WebMTracksParser_map" name="shaka::media::WebMTracksParser_map">
<area href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html" alt="shaka::media::WebMParserClient" shape="rect" coords="0,0,202,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a5ce5a7c0d8774d993a99a40f14f65148"><td class="memItemLeft" align="right" valign="top"><a id="a5ce5a7c0d8774d993a99a40f14f65148"></a>
typedef std::map&lt; int, <a class="el" href="../../de/db3/classshaka_1_1media_1_1TextTrackConfig.html">TextTrackConfig</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>TextTracks</b></td></tr>
<tr class="separator:a5ce5a7c0d8774d993a99a40f14f65148"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:acebeebca144606996d82839f46fa8f30"><td class="memItemLeft" align="right" valign="top"><a id="acebeebca144606996d82839f46fa8f30"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>WebMTracksParser</b> (bool ignore_text_tracks)</td></tr>
<tr class="separator:acebeebca144606996d82839f46fa8f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4b6d4ac9fa57b47cbc17ee7c1bd3639"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d86/classshaka_1_1media_1_1WebMTracksParser.html#aa4b6d4ac9fa57b47cbc17ee7c1bd3639">Parse</a> (const uint8_t *buf, int size)</td></tr>
<tr class="separator:aa4b6d4ac9fa57b47cbc17ee7c1bd3639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6011ec28d219597e19dfa8b7542aebed"><td class="memItemLeft" align="right" valign="top"><a id="a6011ec28d219597e19dfa8b7542aebed"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>audio_track_num</b> () const</td></tr>
<tr class="separator:a6011ec28d219597e19dfa8b7542aebed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec1e5ab28f0694ec19a4f9d43038f056"><td class="memItemLeft" align="right" valign="top"><a id="aec1e5ab28f0694ec19a4f9d43038f056"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>video_track_num</b> () const</td></tr>
<tr class="separator:aec1e5ab28f0694ec19a4f9d43038f056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a705e3db731b14aa692abad4e2c7ad4c8"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d86/classshaka_1_1media_1_1WebMTracksParser.html#a705e3db731b14aa692abad4e2c7ad4c8">GetAudioDefaultDuration</a> (const double timecode_scale_in_us) const</td></tr>
<tr class="separator:a705e3db731b14aa692abad4e2c7ad4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab63eef0db9c1f33a07a8b2fd758d2236"><td class="memItemLeft" align="right" valign="top"><a id="ab63eef0db9c1f33a07a8b2fd758d2236"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetVideoDefaultDuration</b> (const double timecode_scale_in_us) const</td></tr>
<tr class="separator:ab63eef0db9c1f33a07a8b2fd758d2236"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1b3cd6e3d4bc3cadc8a79103fd5bb04"><td class="memItemLeft" align="right" valign="top"><a id="ae1b3cd6e3d4bc3cadc8a79103fd5bb04"></a>
const std::set&lt; int64_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>ignored_tracks</b> () const</td></tr>
<tr class="separator:ae1b3cd6e3d4bc3cadc8a79103fd5bb04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81aa332719ed55b913345765e4e0b046"><td class="memItemLeft" align="right" valign="top"><a id="a81aa332719ed55b913345765e4e0b046"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>audio_encryption_key_id</b> () const</td></tr>
<tr class="separator:a81aa332719ed55b913345765e4e0b046"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6704391f3ee61d32c52150ed8d3dff1"><td class="memItemLeft" align="right" valign="top"><a id="af6704391f3ee61d32c52150ed8d3dff1"></a>
std::shared_ptr&lt; <a class="el" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>audio_stream_info</b> ()</td></tr>
<tr class="separator:af6704391f3ee61d32c52150ed8d3dff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad279500ca7dfdc10f8742a64da680328"><td class="memItemLeft" align="right" valign="top"><a id="ad279500ca7dfdc10f8742a64da680328"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>video_encryption_key_id</b> () const</td></tr>
<tr class="separator:ad279500ca7dfdc10f8742a64da680328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c570a38e301273d773c4490e596a28c"><td class="memItemLeft" align="right" valign="top"><a id="a3c570a38e301273d773c4490e596a28c"></a>
std::shared_ptr&lt; <a class="el" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>video_stream_info</b> ()</td></tr>
<tr class="separator:a3c570a38e301273d773c4490e596a28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c252e2a1bdd098c378016775de752ff"><td class="memItemLeft" align="right" valign="top"><a id="a7c252e2a1bdd098c378016775de752ff"></a>
const TextTracks &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>text_tracks</b> () const</td></tr>
<tr class="separator:a7c252e2a1bdd098c378016775de752ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d55767164e76c75bec780b921c8ce4c"><td class="memItemLeft" align="right" valign="top"><a id="a6d55767164e76c75bec780b921c8ce4c"></a>
const <a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>vp_config</b> () const</td></tr>
<tr class="separator:a6d55767164e76c75bec780b921c8ce4c"><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 pro_methods_classshaka_1_1media_1_1WebMParserClient"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1WebMParserClient')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html">shaka::media::WebMParserClient</a></td></tr>
<tr class="memitem:ae8d4510591d9c8eb11a3f41180e11efc inherit pro_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memItemLeft" align="right" valign="top"><a id="ae8d4510591d9c8eb11a3f41180e11efc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DISALLOW_COPY_AND_ASSIGN</b> (<a class="el" href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html">WebMParserClient</a>)</td></tr>
<tr class="separator:ae8d4510591d9c8eb11a3f41180e11efc inherit pro_methods_classshaka_1_1media_1_1WebMParserClient"><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>Parser for WebM Tracks element. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d7b/webm__tracks__parser_8h_source.html#l00027">27</a> of file <a class="el" href="../../d6/d7b/webm__tracks__parser_8h_source.html">webm_tracks_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a705e3db731b14aa692abad4e2c7ad4c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a705e3db731b14aa692abad4e2c7ad4c8">&#9670;&nbsp;</a></span>GetAudioDefaultDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::media::WebMTracksParser::GetAudioDefaultDuration </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>timecode_scale_in_us</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>If TrackEntry DefaultDuration field existed for the associated audio or video track, returns that value converted from ns to base::TimeDelta with precision not greater than |timecode_scale_in_us|. Defaults to kNoTimestamp. </p>
<p class="definition">Definition at line <a class="el" href="../../d8/d9c/webm__tracks__parser_8cc_source.html#l00090">90</a> of file <a class="el" href="../../d8/d9c/webm__tracks__parser_8cc_source.html">webm_tracks_parser.cc</a>.</p>
</div>
</div>
<a id="aa4b6d4ac9fa57b47cbc17ee7c1bd3639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4b6d4ac9fa57b47cbc17ee7c1bd3639">&#9670;&nbsp;</a></span>Parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int shaka::media::WebMTracksParser::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>
</div><div class="memdoc">
<p>Parses a WebM Tracks element in |buf|. </p><dl class="section return"><dt>Returns</dt><dd>-1 if the parse fails. </dd>
<dd>
0 if more data is needed. </dd>
<dd>
The number of bytes parsed on success. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d8/d9c/webm__tracks__parser_8cc_source.html#l00065">65</a> of file <a class="el" href="../../d8/d9c/webm__tracks__parser_8cc_source.html">webm_tracks_parser.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/formats/webm/<a class="el" href="../../d6/d7b/webm__tracks__parser_8h_source.html">webm_tracks_parser.h</a></li>
<li>packager/media/formats/webm/<a class="el" href="../../d8/d9c/webm__tracks__parser_8cc_source.html">webm_tracks_parser.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 10 2021 21:44:28 for Shaka Packager SDK by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>