230 lines
17 KiB
HTML
230 lines
17 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::EncryptionParams 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 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 List</span></a></li>
|
|
<li><a href="../../classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="../../hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="../../functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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="../../dc/da0/structshaka_1_1EncryptionParams.html">EncryptionParams</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="../../dc/d35/structshaka_1_1EncryptionParams-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::EncryptionParams Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Encryption parameters.
|
|
<a href="../../dc/da0/structshaka_1_1EncryptionParams.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html">EncryptedStreamAttributes</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Encrypted stream information that is used to determine stream label. <a href="../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html#details">More...</a><br/></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:adcf61ebf8d129a5bcf3f159b9b076eed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/daf/namespaceshaka.html#a539b99ce5c34193e294bc544437e9185">KeyProvider</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#adcf61ebf8d129a5bcf3f159b9b076eed">key_provider</a> = KeyProvider::kNone</td></tr>
|
|
<tr class="separator:adcf61ebf8d129a5bcf3f159b9b076eed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68e24d0afdf13c521f6b78f27cb058e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68e24d0afdf13c521f6b78f27cb058e8"></a>
|
|
<a class="el" href="../../d9/dd2/structshaka_1_1WidevineEncryptionParams.html">WidevineEncryptionParams</a> </td><td class="memItemRight" valign="bottom"><b>widevine</b></td></tr>
|
|
<tr class="separator:a68e24d0afdf13c521f6b78f27cb058e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcae49df9adf14e33a0e5a583f41fcc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcae49df9adf14e33a0e5a583f41fcc0"></a>
|
|
<a class="el" href="../../d3/df5/structshaka_1_1PlayreadyEncryptionParams.html">PlayreadyEncryptionParams</a> </td><td class="memItemRight" valign="bottom"><b>playready</b></td></tr>
|
|
<tr class="separator:afcae49df9adf14e33a0e5a583f41fcc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7aa0aaf12b6abe775d75579bc7f41c32"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7aa0aaf12b6abe775d75579bc7f41c32"></a>
|
|
<a class="el" href="../../d0/d5d/structshaka_1_1RawKeyEncryptionParams.html">RawKeyEncryptionParams</a> </td><td class="memItemRight" valign="bottom"><b>raw_key</b></td></tr>
|
|
<tr class="separator:a7aa0aaf12b6abe775d75579bc7f41c32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ad46963dc926aa4b72813dccb3f6a45"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ad46963dc926aa4b72813dccb3f6a45"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a1ad46963dc926aa4b72813dccb3f6a45">clear_lead_in_seconds</a> = 0</td></tr>
|
|
<tr class="memdesc:a1ad46963dc926aa4b72813dccb3f6a45"><td class="mdescLeft"> </td><td class="mdescRight">Clear lead duration in seconds. <br/></td></tr>
|
|
<tr class="separator:a1ad46963dc926aa4b72813dccb3f6a45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b86a3f13f144a0722432b8ee356c598"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b86a3f13f144a0722432b8ee356c598"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>protection_scheme</b> = <a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a1d7a8c6b5e46b51ccadcaef3f9cf9cb0">kProtectionSchemeCenc</a></td></tr>
|
|
<tr class="separator:a9b86a3f13f144a0722432b8ee356c598"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89c4299db866d03398d8518d693cdd10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89c4299db866d03398d8518d693cdd10"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><b>crypto_period_duration_in_seconds</b> = <a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a92ad4ca8e1ccb7d6b5fa2ee0b1b196fa">kNoKeyRotation</a></td></tr>
|
|
<tr class="separator:a89c4299db866d03398d8518d693cdd10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48d415f17d51306ce7e1931fd954c37c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48d415f17d51306ce7e1931fd954c37c"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a48d415f17d51306ce7e1931fd954c37c">vp9_subsample_encryption</a> = true</td></tr>
|
|
<tr class="memdesc:a48d415f17d51306ce7e1931fd954c37c"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable subsample encryption for VP9. <br/></td></tr>
|
|
<tr class="separator:a48d415f17d51306ce7e1931fd954c37c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7686a6aca6a7c3d077a5d7215c39fc51"><td class="memItemLeft" align="right" valign="top">std::function< std::string(const <br class="typebreak"/>
|
|
<a class="el" href="../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html">EncryptedStreamAttributes</a> <br class="typebreak"/>
|
|
&stream_attributes)> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a7686a6aca6a7c3d077a5d7215c39fc51">stream_label_func</a></td></tr>
|
|
<tr class="separator:a7686a6aca6a7c3d077a5d7215c39fc51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a1d7a8c6b5e46b51ccadcaef3f9cf9cb0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d7a8c6b5e46b51ccadcaef3f9cf9cb0"></a>
|
|
static constexpr uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a1d7a8c6b5e46b51ccadcaef3f9cf9cb0">kProtectionSchemeCenc</a> = 0x63656E63</td></tr>
|
|
<tr class="memdesc:a1d7a8c6b5e46b51ccadcaef3f9cf9cb0"><td class="mdescLeft"> </td><td class="mdescRight">The protection scheme: "cenc", "cens", "cbc1", "cbcs". <br/></td></tr>
|
|
<tr class="separator:a1d7a8c6b5e46b51ccadcaef3f9cf9cb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affb9b3776a59d5b7aea6f31d79ab6ac1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affb9b3776a59d5b7aea6f31d79ab6ac1"></a>
|
|
static constexpr uint32_t </td><td class="memItemRight" valign="bottom"><b>kProtectionSchemeCbc1</b> = 0x63626331</td></tr>
|
|
<tr class="separator:affb9b3776a59d5b7aea6f31d79ab6ac1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a975dc1521529a5598b5f222898b53cc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a975dc1521529a5598b5f222898b53cc0"></a>
|
|
static constexpr uint32_t </td><td class="memItemRight" valign="bottom"><b>kProtectionSchemeCens</b> = 0x63656E73</td></tr>
|
|
<tr class="separator:a975dc1521529a5598b5f222898b53cc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8aa01ef2b8e7b60a116c4a73b75acc1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8aa01ef2b8e7b60a116c4a73b75acc1"></a>
|
|
static constexpr uint32_t </td><td class="memItemRight" valign="bottom"><b>kProtectionSchemeCbcs</b> = 0x63626373</td></tr>
|
|
<tr class="separator:ad8aa01ef2b8e7b60a116c4a73b75acc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92ad4ca8e1ccb7d6b5fa2ee0b1b196fa"><td class="memItemLeft" align="right" valign="top">static constexpr double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da0/structshaka_1_1EncryptionParams.html#a92ad4ca8e1ccb7d6b5fa2ee0b1b196fa">kNoKeyRotation</a> = 0</td></tr>
|
|
<tr class="separator:a92ad4ca8e1ccb7d6b5fa2ee0b1b196fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Encryption parameters. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00119">119</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="adcf61ebf8d129a5bcf3f159b9b076eed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../d8/daf/namespaceshaka.html#a539b99ce5c34193e294bc544437e9185">KeyProvider</a> shaka::EncryptionParams::key_provider = KeyProvider::kNone</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Specifies the key provider, which determines which key provider is used and which encryption params is valid. 'kNone' means not to encrypt the streams. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00123">123</a> of file <a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a92ad4ca8e1ccb7d6b5fa2ee0b1b196fa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr double shaka::EncryptionParams::kNoKeyRotation = 0</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>Crypto period duration in seconds. A positive value means key rotation is enabled, the key provider must support key rotation in this case. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00139">139</a> of file <a class="el" href="../../dd/d58/crypto__params_8h_source.html">crypto_params.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7686a6aca6a7c3d077a5d7215c39fc51"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<std::string(const <a class="el" href="../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html">EncryptedStreamAttributes</a>& stream_attributes)> shaka::EncryptionParams::stream_label_func</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Stream label function assigns a stream label to the stream to be encrypted. Stream label is used to associate KeyPair with streams. Streams with the same stream label always uses the same keyPair; Streams with different stream label could use the same or different KeyPairs. A default stream label function will be generated if not set. </p>
|
|
|
|
<p>Definition at line <a class="el" href="../../dd/d58/crypto__params_8h_source.html#l00174">174</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|