shaka-packager/docs/d4/da6/classshaka_1_1media_1_1Play...

497 lines
29 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::PlayReadyKeySource 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html">PlayReadyKeySource</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="../../d1/dbe/classshaka_1_1media_1_1PlayReadyKeySource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::PlayReadyKeySource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A key source that uses PlayReady for encryption.
<a href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../df/d00/playready__key__source_8h_source.html">playready_key_source.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::PlayReadyKeySource:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.png" usemap="#shaka::media::PlayReadyKeySource_map" alt=""/>
<map id="shaka::media::PlayReadyKeySource_map" name="shaka::media::PlayReadyKeySource_map">
<area href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html" title="KeySource is responsible for encryption key acquisition. " alt="shaka::media::KeySource" shape="rect" coords="0,0,214,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:a5ae76a510d842f81e6880711c588dd0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#a5ae76a510d842f81e6880711c588dd0f">PlayReadyKeySource</a> (const std::string &amp;server_url, int protection_systems_flags, FourCC protection_scheme)</td></tr>
<tr class="separator:a5ae76a510d842f81e6880711c588dd0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab613327ec5915f5cd20902141ae8f66a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#ab613327ec5915f5cd20902141ae8f66a">PlayReadyKeySource</a> (const std::string &amp;server_url, const std::string &amp;client_cert_file, const std::string &amp;client_cert_private_key_file, const std::string &amp;client_cert_private_key_password, int protection_systems_flags, FourCC protection_scheme)</td></tr>
<tr class="separator:ab613327ec5915f5cd20902141ae8f66a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5efb834e8fc43340767a56519908637"><td class="memItemLeft" align="right" valign="top"><a id="ae5efb834e8fc43340767a56519908637"></a>
virtual <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>FetchKeysWithProgramIdentifier</b> (const std::string &amp;program_identifier)</td></tr>
<tr class="separator:ae5efb834e8fc43340767a56519908637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeac90b9cff39bfa259f81ff3e93679c"><td class="memItemLeft" align="right" valign="top"><a id="adeac90b9cff39bfa259f81ff3e93679c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#adeac90b9cff39bfa259f81ff3e93679c">SetCaFile</a> (const std::string &amp;ca_file)</td></tr>
<tr class="memdesc:adeac90b9cff39bfa259f81ff3e93679c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Certificate Authority file for validating self-signed certificates. <br /></td></tr>
<tr class="separator:adeac90b9cff39bfa259f81ff3e93679c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">KeySource implementation overrides.</div></td></tr>
<tr class="memitem:a6311482a3f3ddec70da595f0dc1580ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#a6311482a3f3ddec70da595f0dc1580ae">FetchKeys</a> (EmeInitDataType init_data_type, const std::vector&lt; uint8_t &gt; &amp;init_data) override</td></tr>
<tr class="separator:a6311482a3f3ddec70da595f0dc1580ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d2e038e477a5a2bc903292977fc65bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#a0d2e038e477a5a2bc903292977fc65bd">GetKey</a> (const std::string &amp;stream_label, <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *key) override</td></tr>
<tr class="separator:a0d2e038e477a5a2bc903292977fc65bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41c393f477ff4b723aa448b35e9ee896"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#a41c393f477ff4b723aa448b35e9ee896">GetKey</a> (const std::vector&lt; uint8_t &gt; &amp;key_id, <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *key) override</td></tr>
<tr class="separator:a41c393f477ff4b723aa448b35e9ee896"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad155a38ccb7bd7cfa991580eb0e1bbd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#ad155a38ccb7bd7cfa991580eb0e1bbd3">GetCryptoPeriodKey</a> (uint32_t crypto_period_index, uint32_t crypto_period_duration_in_seconds, const std::string &amp;stream_label, <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *key) override</td></tr>
<tr class="separator:ad155a38ccb7bd7cfa991580eb0e1bbd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1KeySource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1KeySource')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">shaka::media::KeySource</a></td></tr>
<tr class="memitem:a76e6de4121fd0a63c2e9caf7793ee26a inherit pub_methods_classshaka_1_1media_1_1KeySource"><td class="memItemLeft" align="right" valign="top"><a id="a76e6de4121fd0a63c2e9caf7793ee26a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>KeySource</b> (int protection_systems_flags, FourCC protection_scheme)</td></tr>
<tr class="separator:a76e6de4121fd0a63c2e9caf7793ee26a inherit pub_methods_classshaka_1_1media_1_1KeySource"><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:a4d2c2abf7deb4ea04aa11b268155c50b"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html">PlayReadyKeySource</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html#a4d2c2abf7deb4ea04aa11b268155c50b">CreateFromKeyAndKeyId</a> (const std::vector&lt; uint8_t &gt; &amp;key_id, const std::vector&lt; uint8_t &gt; &amp;key)</td></tr>
<tr class="separator:a4d2c2abf7deb4ea04aa11b268155c50b"><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_1KeySource"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1KeySource')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">shaka::media::KeySource</a></td></tr>
<tr class="memitem:a8cb007e01d91f38d64cad4ba47f1208a inherit pro_methods_classshaka_1_1media_1_1KeySource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html#a8cb007e01d91f38d64cad4ba47f1208a">UpdateProtectionSystemInfo</a> (EncryptionKeyMap *encryption_key_map)</td></tr>
<tr class="separator:a8cb007e01d91f38d64cad4ba47f1208a inherit pro_methods_classshaka_1_1media_1_1KeySource"><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 key source that uses PlayReady for encryption. </p>
<p class="definition">Definition at line <a class="el" href="../../df/d00/playready__key__source_8h_source.html#l00020">20</a> of file <a class="el" href="../../df/d00/playready__key__source_8h_source.html">playready_key_source.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5ae76a510d842f81e6880711c588dd0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae76a510d842f81e6880711c588dd0f">&#9670;&nbsp;</a></span>PlayReadyKeySource() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shaka::media::PlayReadyKeySource::PlayReadyKeySource </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>server_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>protection_systems_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FourCC&#160;</td>
<td class="paramname"><em>protection_scheme</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html" title="A key source that uses PlayReady for encryption. ">PlayReadyKeySource</a> from the given packaging information. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server_url</td><td>PlayReady packaging server url. </td></tr>
<tr><td class="paramname">protection_systems_flags</td><td>is the flags indicating which PSSH should be included. </td></tr>
<tr><td class="paramname">protection_scheme</td><td>is the Protection Scheme to be used for encryption. It needs to be signalled in Widevine PSSH. This argument can be ignored if Widevine PSSH is not generated. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00065">65</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a>.</p>
</div>
</div>
<a id="ab613327ec5915f5cd20902141ae8f66a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab613327ec5915f5cd20902141ae8f66a">&#9670;&nbsp;</a></span>PlayReadyKeySource() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shaka::media::PlayReadyKeySource::PlayReadyKeySource </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>server_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>client_cert_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>client_cert_private_key_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>client_cert_private_key_password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>protection_systems_flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FourCC&#160;</td>
<td class="paramname"><em>protection_scheme</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html" title="A key source that uses PlayReady for encryption. ">PlayReadyKeySource</a> from the given packaging information. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server_url</td><td>PlayReady packaging server url. </td></tr>
<tr><td class="paramname">client_cert_file</td><td>absolute path to a client certificate. </td></tr>
<tr><td class="paramname">client_cert_private_key_file</td><td>absolute path to the private file for the client certificate. </td></tr>
<tr><td class="paramname">client_cert_private_key_password</td><td>password for the private key. </td></tr>
<tr><td class="paramname">protection_systems_flags</td><td>is the flags indicating which PSSH should be included. </td></tr>
<tr><td class="paramname">protection_scheme</td><td>is the Protection Scheme to be used for encryption. It needs to be signalled in Widevine PSSH. This argument can be ignored if Widevine PSSH is not generated. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00079">79</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4d2c2abf7deb4ea04aa11b268155c50b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2c2abf7deb4ea04aa11b268155c50b">&#9670;&nbsp;</a></span>CreateFromKeyAndKeyId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;<a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html">PlayReadyKeySource</a>&gt; shaka::media::PlayReadyKeySource::CreateFromKeyAndKeyId </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>key_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>key</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>Creates a new <a class="el" href="../../d4/da6/classshaka_1_1media_1_1PlayReadyKeySource.html" title="A key source that uses PlayReady for encryption. ">PlayReadyKeySource</a> from the given data. Returns null if the strings are invalid. Note: GetKey on the created key source will always return the same key for all track types. </p>
</div>
</div>
<a id="a6311482a3f3ddec70da595f0dc1580ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6311482a3f3ddec70da595f0dc1580ae">&#9670;&nbsp;</a></span>FetchKeys()</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="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::PlayReadyKeySource::FetchKeys </td>
<td>(</td>
<td class="paramtype">EmeInitDataType&#160;</td>
<td class="paramname"><em>init_data_type</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>init_data</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch keys based on the specified encrypted media init data. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">init_data_type</td><td>specifies the encrypted media init data type. </td></tr>
<tr><td class="paramname">init_data</td><td>contains the init data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OK on success, an error status otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html#a38dc8e7c48f86e2b3ab3c1ffe0d7916f">shaka::media::KeySource</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00200">200</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a>.</p>
</div>
</div>
<a id="ad155a38ccb7bd7cfa991580eb0e1bbd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad155a38ccb7bd7cfa991580eb0e1bbd3">&#9670;&nbsp;</a></span>GetCryptoPeriodKey()</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="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::PlayReadyKeySource::GetCryptoPeriodKey </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>crypto_period_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>crypto_period_duration_in_seconds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>stream_label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *&#160;</td>
<td class="paramname"><em>key</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get encryption key of the specified track type at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">crypto_period_index</td><td>is the sequence number of the key rotation period for which the key is being retrieved. </td></tr>
<tr><td class="paramname">crypto_period_duration_in_seconds</td><td>is the duration of the crypto period in seconds. </td></tr>
<tr><td class="paramname">stream_label</td><td>is the label of stream for which retrieving the key. </td></tr>
<tr><td class="paramname">key</td><td>is a pointer to the <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> which will hold the retrieved key. Owner retains ownership, and may not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OK on success, an error status otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html#aef67793f02b0cd34b57993fab9f789ae">shaka::media::KeySource</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00227">227</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a>.</p>
</div>
</div>
<a id="a0d2e038e477a5a2bc903292977fc65bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d2e038e477a5a2bc903292977fc65bd">&#9670;&nbsp;</a></span>GetKey() <span class="overload">[1/2]</span></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="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::PlayReadyKeySource::GetKey </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>stream_label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *&#160;</td>
<td class="paramname"><em>key</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get encryption key of the specified stream label. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream_label</td><td>is the label of stream for which retrieving the key. </td></tr>
<tr><td class="paramname">key</td><td>is a pointer to the <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> which will hold the retrieved key. Owner retains ownership, and may not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OK on success, an error status otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html#af56c833453d65297c4dc96c9d2f83e1a">shaka::media::KeySource</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00206">206</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a>.</p>
</div>
</div>
<a id="a41c393f477ff4b723aa448b35e9ee896"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41c393f477ff4b723aa448b35e9ee896">&#9670;&nbsp;</a></span>GetKey() <span class="overload">[2/2]</span></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="../../d2/d20/classshaka_1_1Status.html">Status</a> shaka::media::PlayReadyKeySource::GetKey </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>key_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> *&#160;</td>
<td class="paramname"><em>key</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the encryption key specified by the CENC key ID. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key_id</td><td>is the unique identifier for the key being retreived. </td></tr>
<tr><td class="paramname">key</td><td>is a pointer to the <a class="el" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a> which will hold the retrieved key. Owner retains ownership, and may not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>OK on success, or an error status otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html#ae33f2cdbd045572095acd7b8d6c1a789">shaka::media::KeySource</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html#l00217">217</a> of file <a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.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="../../df/d00/playready__key__source_8h_source.html">playready_key_source.h</a></li>
<li>packager/media/base/<a class="el" href="../../da/dd0/playready__key__source_8cc_source.html">playready_key_source.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 21 2020 16:58:52 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.13
</small></address>
</body>
</html>