shaka-packager/docs/d6/d82/structshaka_1_1media_1_1Enc...

170 lines
11 KiB
HTML
Raw Normal View History

<!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::media::EncryptionOptions 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"><b>media</b></li><li class="navelem"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html">EncryptionOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d3/db3/structshaka_1_1media_1_1EncryptionOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::EncryptionOptions Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This structure defines encryption options.
<a href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../dd/dbc/encryption__handler_8h_source.html">encryption_handler.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:a3d58dc01a4af0ebfb56f3c4979f745f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d58dc01a4af0ebfb56f3c4979f745f7"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#a3d58dc01a4af0ebfb56f3c4979f745f7">clear_lead_in_seconds</a> = 0</td></tr>
<tr class="memdesc:a3d58dc01a4af0ebfb56f3c4979f745f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear lead duration in seconds. <br/></td></tr>
<tr class="separator:a3d58dc01a4af0ebfb56f3c4979f745f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac858b4c03e49e871e07e38fc35893088"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac858b4c03e49e871e07e38fc35893088"></a>
FourCC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#ac858b4c03e49e871e07e38fc35893088">protection_scheme</a> = FOURCC_cenc</td></tr>
<tr class="memdesc:ac858b4c03e49e871e07e38fc35893088"><td class="mdescLeft">&#160;</td><td class="mdescRight">The protection scheme: 'cenc', 'cens', 'cbc1', 'cbcs'. <br/></td></tr>
<tr class="separator:ac858b4c03e49e871e07e38fc35893088"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20acea0141ca7c8dd57d0129c53a6d13"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#a20acea0141ca7c8dd57d0129c53a6d13">crypto_period_duration_in_seconds</a> = 0</td></tr>
<tr class="separator:a20acea0141ca7c8dd57d0129c53a6d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f971f63a7525a777d5578d87ef0c99f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f971f63a7525a777d5578d87ef0c99f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#a2f971f63a7525a777d5578d87ef0c99f">vp9_subsample_encryption</a> = true</td></tr>
<tr class="memdesc:a2f971f63a7525a777d5578d87ef0c99f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable subsample encryption for VP9. <br/></td></tr>
<tr class="separator:a2f971f63a7525a777d5578d87ef0c99f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586017f7bf6490e06a61c1f6eaf7970c"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::string(const <br class="typebreak"/>
EncryptionParams::EncryptedStreamAttributes <br class="typebreak"/>
&amp;stream_attributes)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d82/structshaka_1_1media_1_1EncryptionOptions.html#a586017f7bf6490e06a61c1f6eaf7970c">stream_label_func</a></td></tr>
<tr class="separator:a586017f7bf6490e06a61c1f6eaf7970c"><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>This structure defines encryption options. </p>
<p>Definition at line <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html#l00024">24</a> of file <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html">encryption_handler.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a20acea0141ca7c8dd57d0129c53a6d13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::media::EncryptionOptions::crypto_period_duration_in_seconds = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Crypto period duration in seconds. A positive value means key rotation is enabled, the key source must support key rotation in this case. </p>
<p>Definition at line <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html#l00031">31</a> of file <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html">encryption_handler.h</a>.</p>
</div>
</div>
<a class="anchor" id="a586017f7bf6490e06a61c1f6eaf7970c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::function&lt;std::string( const EncryptionParams::EncryptedStreamAttributes&amp; stream_attributes)&gt; shaka::media::EncryptionOptions::stream_label_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stream label function used to get the label of the encrypted stream. Must be set. </p>
<p>Definition at line <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html#l00038">38</a> of file <a class="el" href="../../dd/dbc/encryption__handler_8h_source.html">encryption_handler.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>media/crypto/<a class="el" href="../../dd/dbc/encryption__handler_8h_source.html">encryption_handler.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 13 2017 00:24:29 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>