shaka-packager/docs/d0/dd4/classshaka_1_1media_1_1Prot...

231 lines
15 KiB
HTML

<!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"/>
<title>Shaka Packager SDK: shaka::media::ProtectionSystemSpecificInfo 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/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">Shaka Packager 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&#160;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&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</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>
<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="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html">ProtectionSystemSpecificInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../d9/d90/classshaka_1_1media_1_1ProtectionSystemSpecificInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::ProtectionSystemSpecificInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a13b0f93b68efff614c5356df081f2560"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html#a13b0f93b68efff614c5356df081f2560">Parse</a> (const uint8_t *data, size_t data_size)</td></tr>
<tr class="separator:a13b0f93b68efff614c5356df081f2560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b917cb91b6c10ee7a6f5b41fc7e0d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9b917cb91b6c10ee7a6f5b41fc7e0d9"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html#af9b917cb91b6c10ee7a6f5b41fc7e0d9">CreateBox</a> () const </td></tr>
<tr class="memdesc:af9b917cb91b6c10ee7a6f5b41fc7e0d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a PSSH box for the current data. <br/></td></tr>
<tr class="separator:af9b917cb91b6c10ee7a6f5b41fc7e0d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54442f4eab63372b3aaeaf2c129d886f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54442f4eab63372b3aaeaf2c129d886f"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>pssh_box_version</b> () const </td></tr>
<tr class="separator:a54442f4eab63372b3aaeaf2c129d886f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a916371edaf3aab1457843636512a15e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a916371edaf3aab1457843636512a15e1"></a>
const std::vector&lt; uint8_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>system_id</b> () const </td></tr>
<tr class="separator:a916371edaf3aab1457843636512a15e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a211c43f1f648ede88c887cd1fbaf38d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a211c43f1f648ede88c887cd1fbaf38d7"></a>
const std::vector&lt; std::vector<br class="typebreak"/>
&lt; uint8_t &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>key_ids</b> () const </td></tr>
<tr class="separator:a211c43f1f648ede88c887cd1fbaf38d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a747e28674063da8451fb45cb58bbc244"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a747e28674063da8451fb45cb58bbc244"></a>
const std::vector&lt; uint8_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>pssh_data</b> () const </td></tr>
<tr class="separator:a747e28674063da8451fb45cb58bbc244"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb8607afe52118ebd69589c393d5e69b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb8607afe52118ebd69589c393d5e69b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_pssh_box_version</b> (uint8_t version)</td></tr>
<tr class="separator:abb8607afe52118ebd69589c393d5e69b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a725e7e87788050f863609c4854f36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89a725e7e87788050f863609c4854f36"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_system_id</b> (const uint8_t *system_id, size_t system_id_size)</td></tr>
<tr class="separator:a89a725e7e87788050f863609c4854f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d8c16bf07fd2b717796563b79615826"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d8c16bf07fd2b717796563b79615826"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>add_key_id</b> (const std::vector&lt; uint8_t &gt; &amp;key_id)</td></tr>
<tr class="separator:a2d8c16bf07fd2b717796563b79615826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6622072299b29574e2fbdd7bdb3d1dce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6622072299b29574e2fbdd7bdb3d1dce"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear_key_ids</b> ()</td></tr>
<tr class="separator:a6622072299b29574e2fbdd7bdb3d1dce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f70785f87999fab2d6fcc2d362a6d6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f70785f87999fab2d6fcc2d362a6d6b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_pssh_data</b> (const std::vector&lt; uint8_t &gt; &amp;pssh_data)</td></tr>
<tr class="separator:a7f70785f87999fab2d6fcc2d362a6d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa984e27d2655a451ea87ff0a4ddd8b79"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html#aa984e27d2655a451ea87ff0a4ddd8b79">ParseBoxes</a> (const uint8_t *data, size_t data_size, std::vector&lt; <a class="el" href="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html">ProtectionSystemSpecificInfo</a> &gt; *pssh_boxes)</td></tr>
<tr class="separator:aa984e27d2655a451ea87ff0a4ddd8b79"><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>Definition at line <a class="el" href="../../d6/d59/protection__system__specific__info_8h_source.html#l00019">19</a> of file <a class="el" href="../../d6/d59/protection__system__specific__info_8h_source.html">protection_system_specific_info.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a13b0f93b68efff614c5356df081f2560"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::ProtectionSystemSpecificInfo::Parse </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the given PSSH box into this object. </p>
<dl class="section return"><dt>Returns</dt><dd>true on success; false on failure. </dd></dl>
<p>Definition at line <a class="el" href="../../d7/d42/protection__system__specific__info_8cc_source.html#l00044">44</a> of file <a class="el" href="../../d7/d42/protection__system__specific__info_8cc_source.html">protection_system_specific_info.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aa984e27d2655a451ea87ff0a4ddd8b79"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::ProtectionSystemSpecificInfo::ParseBoxes </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>data_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="../../d0/dd4/classshaka_1_1media_1_1ProtectionSystemSpecificInfo.html">ProtectionSystemSpecificInfo</a> &gt; *&#160;</td>
<td class="paramname"><em>pssh_boxes</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses multiple PSSH boxes from <em>data</em>. These boxes should be concatenated together. Any non-PSSH box is an error. </p>
<dl class="section return"><dt>Returns</dt><dd>true on success; false on failure. </dd></dl>
<p>Definition at line <a class="el" href="../../d7/d42/protection__system__specific__info_8cc_source.html#l00025">25</a> of file <a class="el" href="../../d7/d42/protection__system__specific__info_8cc_source.html">protection_system_specific_info.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/base/<a class="el" href="../../d6/d59/protection__system__specific__info_8h_source.html">protection_system_specific_info.h</a></li>
<li>packager/media/base/<a class="el" href="../../d7/d42/protection__system__specific__info_8cc_source.html">protection_system_specific_info.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2017 19:34:19 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.6
</small></address>
</body>
</html>