shaka-packager/docs/d3/df5/structshaka_1_1PlayreadyEnc...

164 lines
12 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>DASH Media Packaging SDK: shaka::PlayreadyEncryptionParams Struct 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">DASH Media Packaging 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></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"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html">PlayreadyEncryptionParams</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d7/df9/structshaka_1_1PlayreadyEncryptionParams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::PlayreadyEncryptionParams Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3a31b3002f86834b1799279bf5b5fc11"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a31b3002f86834b1799279bf5b5fc11"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a3a31b3002f86834b1799279bf5b5fc11">key_server_url</a></td></tr>
<tr class="memdesc:a3a31b3002f86834b1799279bf5b5fc11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Playready license / key server URL. <br/></td></tr>
<tr class="separator:a3a31b3002f86834b1799279bf5b5fc11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74199b0293ca77eaac30aea53a9ec2aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74199b0293ca77eaac30aea53a9ec2aa"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a74199b0293ca77eaac30aea53a9ec2aa">program_identifier</a></td></tr>
<tr class="memdesc:a74199b0293ca77eaac30aea53a9ec2aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Playready program identifier. <br/></td></tr>
<tr class="separator:a74199b0293ca77eaac30aea53a9ec2aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a745d002043a10ae7c01983fe5fe93846"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a745d002043a10ae7c01983fe5fe93846">ca_file</a></td></tr>
<tr class="separator:a745d002043a10ae7c01983fe5fe93846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc9477270b8a626163940cddff4fa8c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdc9477270b8a626163940cddff4fa8c"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#afdc9477270b8a626163940cddff4fa8c">client_cert_file</a></td></tr>
<tr class="memdesc:afdc9477270b8a626163940cddff4fa8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute path to client certificate file. <br/></td></tr>
<tr class="separator:afdc9477270b8a626163940cddff4fa8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6f3b909425a27e17a7d6e473d7eb8ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6f3b909425a27e17a7d6e473d7eb8ac"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#af6f3b909425a27e17a7d6e473d7eb8ac">client_cert_private_key_file</a></td></tr>
<tr class="memdesc:af6f3b909425a27e17a7d6e473d7eb8ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute path to the private key file. <br/></td></tr>
<tr class="separator:af6f3b909425a27e17a7d6e473d7eb8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d492f0c28b5d291ef512aa0248dc8ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d492f0c28b5d291ef512aa0248dc8ba"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a2d492f0c28b5d291ef512aa0248dc8ba">client_cert_private_key_password</a></td></tr>
<tr class="memdesc:a2d492f0c28b5d291ef512aa0248dc8ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Password to the private key file. <br/></td></tr>
<tr class="separator:a2d492f0c28b5d291ef512aa0248dc8ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872107e40137be5a6c1f932db67c2a9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a872107e40137be5a6c1f932db67c2a9d"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a872107e40137be5a6c1f932db67c2a9d">key_id</a></td></tr>
<tr class="memdesc:a872107e40137be5a6c1f932db67c2a9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a raw Playready KeyId. <br/></td></tr>
<tr class="separator:a872107e40137be5a6c1f932db67c2a9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba545b465d64da1ac9458ba45338f76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba545b465d64da1ac9458ba45338f76"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html#a2ba545b465d64da1ac9458ba45338f76">key</a></td></tr>
<tr class="memdesc:a2ba545b465d64da1ac9458ba45338f76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a raw Playready Key. <br/></td></tr>
<tr class="separator:a2ba545b465d64da1ac9458ba45338f76"><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>Playready encryption parameters. Two different modes of playready key acquisition is supported: (1) Fetch from a key server. <code>key_server_url</code> and <code>program_identifier</code> are required. The presence of other parameters may be necessary depends on server configuration. (2) Provide the raw key directly. Both <code>key_id</code> and <code>key</code> are required. We are planning to merge this mode with <code><a class="el" href="../../d0/d5d/structshaka_1_1RawKeyEncryptionParams.html" title="Raw key encryption parameters, i.e. with key parameters provided. ">RawKeyEncryptionParams</a></code>. </p>
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00076">76</a> of file <a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a745d002043a10ae7c01983fe5fe93846"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::PlayreadyEncryptionParams::ca_file</td>
</tr>
</table>
</div><div class="memdoc">
<p>Absolute path to the Certificate Authority file for the server cert in PEM format. </p>
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00083">83</a> of file <a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>media/public/<a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 18 2017 21:09:34 for DASH Media Packaging 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>