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

196 lines
12 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::WebMVideoClient 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="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.html">WebMVideoClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dd/dd6/classshaka_1_1media_1_1WebMVideoClient-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::WebMVideoClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Helper class used to parse a Video element inside a TrackEntry element.
<a href="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d9/dcc/webm__video__client_8h_source.html">webm_video_client.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::WebMVideoClient:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.png" usemap="#shaka::media::WebMVideoClient_map" alt=""/>
<map id="shaka::media::WebMVideoClient_map" name="shaka::media::WebMVideoClient_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>
<tr class="memitem:af3ad16a6046f60abf43a798747fc1edc"><td class="memItemLeft" align="right" valign="top"><a id="af3ad16a6046f60abf43a798747fc1edc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.html#af3ad16a6046f60abf43a798747fc1edc">Reset</a> ()</td></tr>
<tr class="memdesc:af3ad16a6046f60abf43a798747fc1edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset this object's state so it can process a new video track element. <br /></td></tr>
<tr class="separator:af3ad16a6046f60abf43a798747fc1edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae71e739feadfb8e9207b8ceb9689ca66"><td class="memItemLeft" align="right" valign="top">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"><a class="el" href="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.html#ae71e739feadfb8e9207b8ceb9689ca66">GetVideoStreamInfo</a> (int64_t track_num, const std::string &amp;codec_id, const std::vector&lt; uint8_t &gt; &amp;codec_private, bool is_encrypted)</td></tr>
<tr class="separator:ae71e739feadfb8e9207b8ceb9689ca66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea98a1f803ed3d710a5d39fae089c5ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d67/classshaka_1_1media_1_1WebMVideoClient.html#aea98a1f803ed3d710a5d39fae089c5ea">GetVpCodecConfig</a> (const std::vector&lt; uint8_t &gt; &amp;codec_private)</td></tr>
<tr class="separator:aea98a1f803ed3d710a5d39fae089c5ea"><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>
<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>
<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 a Video element inside a TrackEntry element. </p>
<p class="definition">Definition at line <a class="el" href="../../d9/dcc/webm__video__client_8h_source.html#l00021">21</a> of file <a class="el" href="../../d9/dcc/webm__video__client_8h_source.html">webm_video_client.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae71e739feadfb8e9207b8ceb9689ca66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae71e739feadfb8e9207b8ceb9689ca66">&#9670;&nbsp;</a></span>GetVideoStreamInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html">VideoStreamInfo</a> &gt; shaka::media::WebMVideoClient::GetVideoStreamInfo </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">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 a <a class="el" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html" title="Holds video stream information.">VideoStreamInfo</a> with the data in |track_num|, |codec_id|, |codec_private|, |is_encrypted| and the fields parsed from the last video track element this object was used to parse. </p><dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="../../d6/db1/classshaka_1_1media_1_1VideoStreamInfo.html" title="Holds video stream information.">VideoStreamInfo</a> if successful. </dd>
<dd>
An empty pointer if there was unexpected values in the provided parameters or video track element fields. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d1/d7d/webm__video__client_8cc_source.html#l00050">50</a> of file <a class="el" href="../../d1/d7d/webm__video__client_8cc_source.html">webm_video_client.cc</a>.</p>
</div>
</div>
<a id="aea98a1f803ed3d710a5d39fae089c5ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea98a1f803ed3d710a5d39fae089c5ea">&#9670;&nbsp;</a></span>GetVpCodecConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html">VPCodecConfigurationRecord</a> shaka::media::WebMVideoClient::GetVpCodecConfig </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>codec_private</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts <a class="el" href="../../d1/da5/classshaka_1_1media_1_1VPCodecConfigurationRecord.html" title="Class for parsing or writing VP codec configuration record.">VPCodecConfigurationRecord</a> parsed from codec private data and Colour element. </p>
<p class="definition">Definition at line <a class="el" href="../../d1/d7d/webm__video__client_8cc_source.html#l00130">130</a> of file <a class="el" href="../../d1/d7d/webm__video__client_8cc_source.html">webm_video_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="../../d9/dcc/webm__video__client_8h_source.html">webm_video_client.h</a></li>
<li>packager/media/formats/webm/<a class="el" href="../../d1/d7d/webm__video__client_8cc_source.html">webm_video_client.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>