2015-10-16 00:33:37 +00:00
<!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" / >
2016-05-24 23:43:16 +00:00
< title > DASH Media Packaging SDK: shaka::media::DecryptConfig Class Reference< / title >
2015-10-16 00:33:37 +00:00
< 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)">
2016-05-11 18:03:07 +00:00
< 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 >
2015-10-16 00:33:37 +00:00
<!-- 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 >
2016-05-24 23:43:16 +00:00
< 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 = "../../de/d49/classshaka_1_1media_1_1DecryptConfig.html" > DecryptConfig< / a > < / li > < / ul >
2015-10-16 00:33:37 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-static-attribs" > Static Public Attributes< / a > |
2016-05-24 23:43:16 +00:00
< a href = "../../d4/d5c/classshaka_1_1media_1_1DecryptConfig-members.html" > List of all members< / a > < / div >
2015-10-16 00:33:37 +00:00
< div class = "headertitle" >
2016-05-24 23:43:16 +00:00
< div class = "title" > shaka::media::DecryptConfig Class Reference< / div > < / div >
2015-10-16 00:33:37 +00:00
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "../../df/dad/decrypt__config_8h_source.html" > decrypt_config.h< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:a24035bb6edcb3aaaa9923bf385376ae5" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/d49/classshaka_1_1media_1_1DecryptConfig.html#a24035bb6edcb3aaaa9923bf385376ae5" > DecryptConfig< / a > (const std::vector< uint8_t > & key_id, const std::vector< uint8_t > & iv, const std::vector< < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > > & subsamples)< / td > < / tr >
< tr class = "separator:a24035bb6edcb3aaaa9923bf385376ae5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab2dfe0a2ee285539843ac55b5f1ac7c7" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/d49/classshaka_1_1media_1_1DecryptConfig.html#ab2dfe0a2ee285539843ac55b5f1ac7c7" > DecryptConfig< / a > (const std::vector< uint8_t > & key_id, const std::vector< uint8_t > & iv, const std::vector< < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > > & subsamples, FourCC protection_scheme, uint8_t crypt_byte_block, uint8_t skip_byte_block)< / td > < / tr >
< tr class = "separator:ab2dfe0a2ee285539843ac55b5f1ac7c7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3b92187577ea5b9cb44d98bfe215ea76" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a3b92187577ea5b9cb44d98bfe215ea76" > < / a >
2015-10-16 00:33:37 +00:00
const std::vector< uint8_t > &   < / td > < td class = "memItemRight" valign = "bottom" > < b > key_id< / b > () const < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:a3b92187577ea5b9cb44d98bfe215ea76" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad3e0ccf3ddec37dbb2d9bb2f08d201ee" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad3e0ccf3ddec37dbb2d9bb2f08d201ee" > < / a >
2015-10-16 00:33:37 +00:00
const std::vector< uint8_t > &   < / td > < td class = "memItemRight" valign = "bottom" > < b > iv< / b > () const < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:ad3e0ccf3ddec37dbb2d9bb2f08d201ee" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a097c475bf148bcd18f072393436e0f8d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a097c475bf148bcd18f072393436e0f8d" > < / a >
2015-10-16 00:33:37 +00:00
const std::vector< br class = "typebreak" / >
2016-05-24 23:43:16 +00:00
< < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > > &   < / td > < td class = "memItemRight" valign = "bottom" > < b > subsamples< / b > () const < / td > < / tr >
< tr class = "separator:a097c475bf148bcd18f072393436e0f8d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7b4fae5f581780d5ed077e55a3aa0a5c" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a7b4fae5f581780d5ed077e55a3aa0a5c" > < / a >
2016-04-12 23:13:12 +00:00
FourCC  < / td > < td class = "memItemRight" valign = "bottom" > < b > protection_scheme< / b > () const < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:a7b4fae5f581780d5ed077e55a3aa0a5c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad75505fe7b1a980c7ee644563f1a6ae1" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad75505fe7b1a980c7ee644563f1a6ae1" > < / a >
2016-04-15 19:07:50 +00:00
uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < b > crypt_byte_block< / b > () const < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:ad75505fe7b1a980c7ee644563f1a6ae1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a71e242e371b9c1367b2a0af401a2e67f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a71e242e371b9c1367b2a0af401a2e67f" > < / a >
2016-04-15 19:07:50 +00:00
uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < b > skip_byte_block< / b > () const < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:a71e242e371b9c1367b2a0af401a2e67f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / 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 >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:afa140203b87d3e46d5fd94b231734f53" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "afa140203b87d3e46d5fd94b231734f53" > < / a >
static const size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../de/d49/classshaka_1_1media_1_1DecryptConfig.html#afa140203b87d3e46d5fd94b231734f53" > kDecryptionKeySize< / a > = 16< / td > < / tr >
< tr class = "memdesc:afa140203b87d3e46d5fd94b231734f53" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Keys are always 128 bits. < br / > < / td > < / tr >
< tr class = "separator:afa140203b87d3e46d5fd94b231734f53" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Contains all the information that a decryptor needs to decrypt a media sample. < / p >
2016-03-18 05:18:31 +00:00
< p > Definition at line < a class = "el" href = "../../df/dad/decrypt__config_8h_source.html#l00040" > 40< / a > of file < a class = "el" href = "../../df/dad/decrypt__config_8h_source.html" > decrypt_config.h< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a24035bb6edcb3aaaa9923bf385376ae5" > < / a >
2016-04-12 23:13:12 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > shaka::media::DecryptConfig::DecryptConfig < / td >
2016-04-12 23:13:12 +00:00
< td > (< / td >
< td class = "paramtype" > const std::vector< uint8_t > &   < / td >
< td class = "paramname" > < em > key_id< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< uint8_t > &   < / td >
< td class = "paramname" > < em > iv< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-05-24 23:43:16 +00:00
< td class = "paramtype" > const std::vector< < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > > &   < / td >
2016-04-12 23:13:12 +00:00
< td class = "paramname" > < em > subsamples< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Create a 'cenc' decrypt config. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > key_id< / td > < td > is the ID that references the decryption key. < / td > < / tr >
< tr > < td class = "paramname" > iv< / td > < td > is the initialization vector defined by the encryptor. < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr > < td class = "paramname" > subsamples< / td > < td > defines the clear and encrypted portions of the sample as described in < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > . A decrypted buffer will be equal in size to the sum of the subsample sizes. < / td > < / tr >
2016-04-12 23:13:12 +00:00
< / table >
< / dd >
< / dl >
< p > Definition at line < a class = "el" href = "../../d3/d56/decrypt__config_8cc_source.html#l00012" > 12< / a > of file < a class = "el" href = "../../d3/d56/decrypt__config_8cc_source.html" > decrypt_config.cc< / a > .< / p >
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "ab2dfe0a2ee285539843ac55b5f1ac7c7" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > shaka::media::DecryptConfig::DecryptConfig < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramtype" > const std::vector< uint8_t > &   < / td >
< td class = "paramname" > < em > key_id< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< uint8_t > &   < / td >
< td class = "paramname" > < em > iv< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-05-24 23:43:16 +00:00
< td class = "paramtype" > const std::vector< < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > > &   < / td >
2016-03-18 05:18:31 +00:00
< td class = "paramname" > < em > subsamples< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-04-12 23:13:12 +00:00
< td class = "paramtype" > FourCC  < / td >
2016-04-15 19:07:50 +00:00
< td class = "paramname" > < em > protection_scheme< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > crypt_byte_block< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > skip_byte_block< / em >   < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-04-12 23:13:12 +00:00
< p > Create a general decrypt config with possible pattern-based encryption. < / p >
2015-10-16 00:33:37 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > key_id< / td > < td > is the ID that references the decryption key. < / td > < / tr >
< tr > < td class = "paramname" > iv< / td > < td > is the initialization vector defined by the encryptor. < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr > < td class = "paramname" > subsamples< / td > < td > defines the clear and encrypted portions of the sample as described in < a class = "el" href = "../../d1/d34/structshaka_1_1media_1_1SubsampleEntry.html" > SubsampleEntry< / a > . A decrypted buffer will be equal in size to the sum of the subsample sizes. < / td > < / tr >
2016-04-12 23:13:12 +00:00
< tr > < td class = "paramname" > protection_scheme< / td > < td > specifies the protection scheme: 'cenc', 'cens', 'cbc1', 'cbcs'. < / td > < / tr >
2016-04-15 19:07:50 +00:00
< tr > < td class = "paramname" > crypt_byte_block< / td > < td > indicates number of encrypted blocks (16-byte) in pattern based encryption, 'cens' and 'cbcs'. Ignored otherwise. < / td > < / tr >
< tr > < td class = "paramname" > skip_byte_block< / td > < td > indicates number of unencrypted blocks (16-byte) in pattern based encryption, 'cens' and 'cbcs'. Ignored otherwise. < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / table >
< / dd >
< / dl >
2016-04-12 23:13:12 +00:00
< p > Definition at line < a class = "el" href = "../../d3/d56/decrypt__config_8cc_source.html#l00017" > 17< / a > of file < a class = "el" href = "../../d3/d56/decrypt__config_8cc_source.html" > decrypt_config.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > media/base/< a class = "el" href = "../../df/dad/decrypt__config_8h_source.html" > decrypt_config.h< / a > < / li >
< li > media/base/< a class = "el" href = "../../d3/d56/decrypt__config_8cc_source.html" > decrypt_config.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2016-08-18 21:18:15 +00:00
Generated on Thu Aug 18 2016 21:18:08 for DASH Media Packaging SDK by   < a href = "http://www.doxygen.org/index.html" >
2015-10-16 00:33:37 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
