shaka-packager/docs/d9/d8c/classshaka_1_1media_1_1AesR...

177 lines
11 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::AesRequestSigner 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/d8c/classshaka_1_1media_1_1AesRequestSigner.html">AesRequestSigner</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="../../d8/d92/classshaka_1_1media_1_1AesRequestSigner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::AesRequestSigner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html" title="AesRequestSigner uses AES-CBC signing.">AesRequestSigner</a> uses AES-CBC signing.
<a href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d7/dd4/request__signer_8h_source.html">request_signer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::AesRequestSigner:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.png" usemap="#shaka::media::AesRequestSigner_map" alt=""/>
<map id="shaka::media::AesRequestSigner_map" name="shaka::media::AesRequestSigner_map">
<area href="../../df/d3c/classshaka_1_1media_1_1RequestSigner.html" title="Abstract class used for signature generation." alt="shaka::media::RequestSigner" shape="rect" coords="0,0,193,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:a3010ad8c4c1588358a8d31a97afd6428"><td class="memItemLeft" align="right" valign="top"><a id="a3010ad8c4c1588358a8d31a97afd6428"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html#a3010ad8c4c1588358a8d31a97afd6428">GenerateSignature</a> (const std::string &amp;message, std::string *signature) override</td></tr>
<tr class="memdesc:a3010ad8c4c1588358a8d31a97afd6428"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../df/d3c/classshaka_1_1media_1_1RequestSigner.html" title="Abstract class used for signature generation.">RequestSigner</a> implementation override. <br /></td></tr>
<tr class="separator:a3010ad8c4c1588358a8d31a97afd6428"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1RequestSigner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1RequestSigner')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../df/d3c/classshaka_1_1media_1_1RequestSigner.html">shaka::media::RequestSigner</a></td></tr>
<tr class="memitem:af867dbe96220d010b3602bd36738cb4b inherit pub_methods_classshaka_1_1media_1_1RequestSigner"><td class="memItemLeft" align="right" valign="top"><a id="af867dbe96220d010b3602bd36738cb4b"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>signer_name</b> () const</td></tr>
<tr class="separator:af867dbe96220d010b3602bd36738cb4b inherit pub_methods_classshaka_1_1media_1_1RequestSigner"><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:a8ae2058318e5894422acb95586e3c471"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html">AesRequestSigner</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html#a8ae2058318e5894422acb95586e3c471">CreateSigner</a> (const std::string &amp;signer_name, const std::vector&lt; uint8_t &gt; &amp;aes_key, const std::vector&lt; uint8_t &gt; &amp;iv)</td></tr>
<tr class="separator:a8ae2058318e5894422acb95586e3c471"><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_1RequestSigner"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1RequestSigner')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../df/d3c/classshaka_1_1media_1_1RequestSigner.html">shaka::media::RequestSigner</a></td></tr>
<tr class="memitem:a60388204b36d20aace63681107f663ff inherit pro_methods_classshaka_1_1media_1_1RequestSigner"><td class="memItemLeft" align="right" valign="top"><a id="a60388204b36d20aace63681107f663ff"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RequestSigner</b> (const std::string &amp;signer_name)</td></tr>
<tr class="separator:a60388204b36d20aace63681107f663ff inherit pro_methods_classshaka_1_1media_1_1RequestSigner"><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><a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html" title="AesRequestSigner uses AES-CBC signing.">AesRequestSigner</a> uses AES-CBC signing. </p>
<p class="definition">Definition at line <a class="el" href="../../d7/dd4/request__signer_8h_source.html#l00045">45</a> of file <a class="el" href="../../d7/dd4/request__signer_8h_source.html">request_signer.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8ae2058318e5894422acb95586e3c471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ae2058318e5894422acb95586e3c471">&#9670;&nbsp;</a></span>CreateSigner()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html">AesRequestSigner</a> * shaka::media::AesRequestSigner::CreateSigner </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>signer_name</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>aes_key</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>iv</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>Create an AesSigner object from key and iv. </p><dl class="section return"><dt>Returns</dt><dd>The created <a class="el" href="../../d9/d8c/classshaka_1_1media_1_1AesRequestSigner.html" title="AesRequestSigner uses AES-CBC signing.">AesRequestSigner</a> object on success, NULL otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/df5/request__signer_8cc_source.html#l00028">28</a> of file <a class="el" href="../../d4/df5/request__signer_8cc_source.html">request_signer.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="../../d7/dd4/request__signer_8h_source.html">request_signer.h</a></li>
<li>packager/media/base/<a class="el" href="../../d4/df5/request__signer_8cc_source.html">request_signer.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:05 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>