shaka-packager/docs/dc/da6/classshaka_1_1media_1_1Cont...

217 lines
14 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::media::ContentEncoding 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/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="../../dc/da6/classshaka_1_1media_1_1ContentEncoding.html">ContentEncoding</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="../../d7/d36/classshaka_1_1media_1_1ContentEncoding-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::ContentEncoding Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a3a4bd0100326c38ad85e8fa73558c45f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Scope</b> { <br/>
&#160;&#160;<b>kScopeInvalid</b> = 0,
<b>kScopeAllFrameContents</b> = 1,
<b>kScopeTrackPrivateData</b> = 2,
<b>kScopeNextContentEncodingData</b> = 4,
<br/>
&#160;&#160;<b>kScopeMax</b> = 7
<br/>
}</td></tr>
<tr class="separator:a3a4bd0100326c38ad85e8fa73558c45f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a139b4afbbe0046847f76f7fd9d38cd0f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>kTypeInvalid</b> = -1,
<b>kTypeCompression</b> = 0,
<b>kTypeEncryption</b> = 1
}</td></tr>
<tr class="separator:a139b4afbbe0046847f76f7fd9d38cd0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a973da342b6fb4e84d21a748dc85f678f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>EncryptionAlgo</b> { <br/>
&#160;&#160;<b>kEncAlgoInvalid</b> = -1,
<b>kEncAlgoNotEncrypted</b> = 0,
<b>kEncAlgoDes</b> = 1,
<b>kEncAlgo3des</b> = 2,
<br/>
&#160;&#160;<b>kEncAlgoTwofish</b> = 3,
<b>kEncAlgoBlowfish</b> = 4,
<b>kEncAlgoAes</b> = 5
<br/>
}</td></tr>
<tr class="separator:a973da342b6fb4e84d21a748dc85f678f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a232f961852a363c81f9027f79d59bc7d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><b>CipherMode</b> { <b>kCipherModeInvalid</b> = 0,
<b>kCipherModeCtr</b> = 1
}</td></tr>
<tr class="separator:a232f961852a363c81f9027f79d59bc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:acec2b379858f815df5a6c4cc66bbe189"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec2b379858f815df5a6c4cc66bbe189"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>order</b> () const </td></tr>
<tr class="separator:acec2b379858f815df5a6c4cc66bbe189"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dbdf7e54264be2cbbb4eacb3b33dc8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dbdf7e54264be2cbbb4eacb3b33dc8b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_order</b> (int64_t order)</td></tr>
<tr class="separator:a1dbdf7e54264be2cbbb4eacb3b33dc8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61136c496bbf14e22a2d86af773dca1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61136c496bbf14e22a2d86af773dca1e"></a>
Scope&#160;</td><td class="memItemRight" valign="bottom"><b>scope</b> () const </td></tr>
<tr class="separator:a61136c496bbf14e22a2d86af773dca1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a120015c1a8f60f30ce95978aeb0aca64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a120015c1a8f60f30ce95978aeb0aca64"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_scope</b> (Scope scope)</td></tr>
<tr class="separator:a120015c1a8f60f30ce95978aeb0aca64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae96f743ab1ff321d1c0067cd552b117e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae96f743ab1ff321d1c0067cd552b117e"></a>
Type&#160;</td><td class="memItemRight" valign="bottom"><b>type</b> () const </td></tr>
<tr class="separator:ae96f743ab1ff321d1c0067cd552b117e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a528a1f34b9a46541a9da98aa7766fd46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a528a1f34b9a46541a9da98aa7766fd46"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_type</b> (Type type)</td></tr>
<tr class="separator:a528a1f34b9a46541a9da98aa7766fd46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad64dd09b12fb1714f38c8c989bc416dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad64dd09b12fb1714f38c8c989bc416dc"></a>
EncryptionAlgo&#160;</td><td class="memItemRight" valign="bottom"><b>encryption_algo</b> () const </td></tr>
<tr class="separator:ad64dd09b12fb1714f38c8c989bc416dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad25358e6cd90030ce9588aa90fcdd945"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad25358e6cd90030ce9588aa90fcdd945"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_encryption_algo</b> (EncryptionAlgo encryption_algo)</td></tr>
<tr class="separator:ad25358e6cd90030ce9588aa90fcdd945"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06c5eb3c618e14d09338044dfae3348e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06c5eb3c618e14d09338044dfae3348e"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>encryption_key_id</b> () const </td></tr>
<tr class="separator:a06c5eb3c618e14d09338044dfae3348e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af15a1d0c2e475048715275d8c6c49b29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af15a1d0c2e475048715275d8c6c49b29"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetEncryptionKeyId</b> (const uint8_t *encryption_key_id, int size)</td></tr>
<tr class="separator:af15a1d0c2e475048715275d8c6c49b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9544155c46239ef9b17842fbd54a4f9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9544155c46239ef9b17842fbd54a4f9b"></a>
CipherMode&#160;</td><td class="memItemRight" valign="bottom"><b>cipher_mode</b> () const </td></tr>
<tr class="separator:a9544155c46239ef9b17842fbd54a4f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4a2e7cc8310e0d3e269ee117dd8d379"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4a2e7cc8310e0d3e269ee117dd8d379"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_cipher_mode</b> (CipherMode mode)</td></tr>
<tr class="separator:ac4a2e7cc8310e0d3e269ee117dd8d379"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a3ba32d5ca8b0688b2dc6b2ec8a5be6d2"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/da6/classshaka_1_1media_1_1ContentEncoding.html#a3ba32d5ca8b0688b2dc6b2ec8a5be6d2">kOrderInvalid</a> = -1</td></tr>
<tr class="separator:a3ba32d5ca8b0688b2dc6b2ec8a5be6d2"><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>Definition at line <a class="el" href="../../d9/d3b/webm__content__encodings_8h_source.html#l00015">15</a> of file <a class="el" href="../../d9/d3b/webm__content__encodings_8h_source.html">webm_content_encodings.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a3ba32d5ca8b0688b2dc6b2ec8a5be6d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int shaka::media::ContentEncoding::kOrderInvalid = -1</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>The following enum definitions are based on the <a class="el" href="../../dc/da6/classshaka_1_1media_1_1ContentEncoding.html">ContentEncoding</a> element specified in the Matroska spec. </p>
<p>Definition at line <a class="el" href="../../d9/d3b/webm__content__encodings_8h_source.html#l00020">20</a> of file <a class="el" href="../../d9/d3b/webm__content__encodings_8h_source.html">webm_content_encodings.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>media/formats/webm/<a class="el" href="../../d9/d3b/webm__content__encodings_8h_source.html">webm_content_encodings.h</a></li>
<li>media/formats/webm/<a class="el" href="../../d6/d35/webm__content__encodings_8cc_source.html">webm_content_encodings.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 16 2017 22:29:38 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>