shaka-packager/docs/d3/d7c/classshaka_1_1media_1_1WebM...

212 lines
14 KiB
HTML
Raw Normal View 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"/>
2021-06-22 00:16:40 +00:00
<meta name="generator" content="Doxygen 1.8.17"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::WebMAudioClient 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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
2018-02-10 23:37:42 +00:00
<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 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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="../../d3/d7c/classshaka_1_1media_1_1WebMAudioClient.html">WebMAudioClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dd/db0/classshaka_1_1media_1_1WebMAudioClient-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::WebMAudioClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Helper class used to parse an Audio element inside a TrackEntry element.
<a href="../../d3/d7c/classshaka_1_1media_1_1WebMAudioClient.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d3/d8d/webm__audio__client_8h_source.html">webm_audio_client.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::WebMAudioClient:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d3/d7c/classshaka_1_1media_1_1WebMAudioClient.png" usemap="#shaka::media::WebMAudioClient_map" alt=""/>
<map id="shaka::media::WebMAudioClient_map" name="shaka::media::WebMAudioClient_map">
<area href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html" alt="shaka::media::WebMParserClient" shape="rect" coords="0,0,196,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>
2018-02-10 23:37:42 +00:00
<tr class="memitem:afd1a338848c52dc4db79d89ae13b6ea6"><td class="memItemLeft" align="right" valign="top"><a id="afd1a338848c52dc4db79d89ae13b6ea6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d7c/classshaka_1_1media_1_1WebMAudioClient.html#afd1a338848c52dc4db79d89ae13b6ea6">Reset</a> ()</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memdesc:afd1a338848c52dc4db79d89ae13b6ea6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset this object's state so it can process a new audio track element. <br /></td></tr>
<tr class="separator:afd1a338848c52dc4db79d89ae13b6ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fcbddd20199044f860331b3bd9ef3b8"><td class="memItemLeft" align="right" valign="top">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"><a class="el" href="../../d3/d7c/classshaka_1_1media_1_1WebMAudioClient.html#a0fcbddd20199044f860331b3bd9ef3b8">GetAudioStreamInfo</a> (int64_t track_num, const std::string &amp;codec_id, const std::vector&lt; uint8_t &gt; &amp;codec_private, int64_t seek_preroll, int64_t codec_delay, const std::string &amp;language, bool is_encrypted)</td></tr>
<tr class="separator:a0fcbddd20199044f860331b3bd9ef3b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1WebMParserClient"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1WebMParserClient')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html">shaka::media::WebMParserClient</a></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a1c6e840008a1c99ec2b38e01f4e0651d inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memItemLeft" align="right" valign="top"><a id="a1c6e840008a1c99ec2b38e01f4e0651d"></a>
virtual <a class="el" href="../../d5/dec/classshaka_1_1media_1_1WebMParserClient.html">WebMParserClient</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>OnListStart</b> (int id)</td></tr>
<tr class="separator:a1c6e840008a1c99ec2b38e01f4e0651d inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a004c4838262c069268d8fe3240080a33 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memItemLeft" align="right" valign="top"><a id="a004c4838262c069268d8fe3240080a33"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>OnListEnd</b> (int id)</td></tr>
<tr class="separator:a004c4838262c069268d8fe3240080a33 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a9cd9f3b81d920b761cc15947bf0ba197 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memItemLeft" align="right" valign="top"><a id="a9cd9f3b81d920b761cc15947bf0ba197"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>OnBinary</b> (int id, const uint8_t *data, int size)</td></tr>
<tr class="separator:a9cd9f3b81d920b761cc15947bf0ba197 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a59e9fddc974f0898a3127007780470e7 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><td class="memItemLeft" align="right" valign="top"><a id="a59e9fddc974f0898a3127007780470e7"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>OnString</b> (int id, const std::string &amp;str)</td></tr>
<tr class="separator:a59e9fddc974f0898a3127007780470e7 inherit pub_methods_classshaka_1_1media_1_1WebMParserClient"><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>
2018-02-10 23:37:42 +00:00
<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>Helper class used to parse an Audio element inside a TrackEntry element. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d3/d8d/webm__audio__client_8h_source.html#l00020">20</a> of file <a class="el" href="../../d3/d8d/webm__audio__client_8h_source.html">webm_audio_client.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="a0fcbddd20199044f860331b3bd9ef3b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fcbddd20199044f860331b3bd9ef3b8">&#9670;&nbsp;</a></span>GetAudioStreamInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html">AudioStreamInfo</a> &gt; shaka::media::WebMAudioClient::GetAudioStreamInfo </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>track_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>codec_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>codec_private</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>seek_preroll</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>codec_delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_encrypted</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an <a class="el" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html" title="Holds audio stream information.">AudioStreamInfo</a> with the parameters specified. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">track_num</td><td>indicates the track number. </td></tr>
<tr><td class="paramname">codec_id</td><td>is the codec identifier. </td></tr>
<tr><td class="paramname">codec_private</td><td>contains codec specific data. </td></tr>
<tr><td class="paramname">seek_preroll</td><td>indicates seek preroll in nanoseconds. A negative value means that the value is not set; in this case, a default value of 0 is used. </td></tr>
<tr><td class="paramname">codec</td><td>delay indicates codec delay in nanoseconds. A negative value means that the value is not set; in this case, a default value of 0 is used. </td></tr>
<tr><td class="paramname">language</td><td>indicates the language for the track. </td></tr>
<tr><td class="paramname">is_encrypted</td><td>indicates whether the stream is encrypted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="../../da/d4e/classshaka_1_1media_1_1AudioStreamInfo.html" title="Holds audio stream information.">AudioStreamInfo</a> if successful. </dd>
<dd>
An empty pointer if there was unexpected values in the provided parameters or audio track element fields. </dd></dl>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../d1/d8e/webm__audio__client_8cc_source.html#l00031">31</a> of file <a class="el" href="../../d1/d8e/webm__audio__client_8cc_source.html">webm_audio_client.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="../../d3/d8d/webm__audio__client_8h_source.html">webm_audio_client.h</a></li>
<li>packager/media/formats/webm/<a class="el" href="../../d1/d8e/webm__audio__client_8cc_source.html">webm_audio_client.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-22 00:16:40 +00:00
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>