2021-04-10 04:00:37 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2017-09-20 02:35:05 +00:00
< 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" / >
2021-04-10 04:00:37 +00:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2018-02-10 23:37:42 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2017-09-20 02:35:05 +00:00
< title > Shaka Packager SDK: shaka::Packager 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" / >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "../../search/searchdata.js" > < / script >
2017-09-20 02:35:05 +00:00
< 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;" >
2018-02-10 23:37:42 +00:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2017-09-20 02:35:05 +00:00
< div id = "projectname" > Shaka Packager SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-04-10 04:00:37 +00:00
<!-- Generated by Doxygen 1.9.1 -->
2017-09-20 02:35:05 +00:00
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
2017-09-20 02:35:05 +00:00
< / script >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "../../menudata.js" > < / script >
< script type = "text/javascript" src = "../../menu.js" > < / script >
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-04-10 04:00:37 +00:00
/* @license-end */< / script >
2018-02-10 23:37:42 +00:00
< div id = "main-nav" > < / div >
2017-09-20 02:35:05 +00:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2018-02-10 23:37:42 +00:00
< / div >
2017-09-20 02:35:05 +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 >
< li class = "navelem" > < a class = "el" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html" > Packager< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-static-methods" > Static Public Member Functions< / a > |
< a href = "../../d5/d1a/classshaka_1_1Packager-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > shaka::Packager Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< 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:ae40969a98da3a27a0b1633927afb3ce2" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html#ae40969a98da3a27a0b1633927afb3ce2" > Initialize< / a > (const < a class = "el" href = "../../d5/de3/structshaka_1_1PackagingParams.html" > PackagingParams< / a > & packaging_params, const std::vector< < a class = "el" href = "../../d2/d7b/structshaka_1_1StreamDescriptor.html" > StreamDescriptor< / a > > & stream_descriptors)< / td > < / tr >
< tr class = "separator:ae40969a98da3a27a0b1633927afb3ce2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a48275206bc7032eb69607081ac0ada08" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html#a48275206bc7032eb69607081ac0ada08" > Run< / a > ()< / td > < / tr >
< tr class = "separator:a48275206bc7032eb69607081ac0ada08" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a5323e6dc242b1cdd6208cd6ea77dd0c7" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a5323e6dc242b1cdd6208cd6ea77dd0c7" > < / a >
2017-09-20 02:35:05 +00:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html#a5323e6dc242b1cdd6208cd6ea77dd0c7" > Cancel< / a > ()< / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memdesc:a5323e6dc242b1cdd6208cd6ea77dd0c7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Cancel packaging. Note that it has to be called from another thread. < br / > < / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a5323e6dc242b1cdd6208cd6ea77dd0c7" > < td class = "memSeparator" colspan = "2" >   < / 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:a7bae5b5c202a716f5d890e70afae51b2" > < td class = "memItemLeft" align = "right" valign = "top" > static std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html#a7bae5b5c202a716f5d890e70afae51b2" > GetLibraryVersion< / a > ()< / td > < / tr >
< tr class = "separator:a7bae5b5c202a716f5d890e70afae51b2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a59fec4e3f33138081e5222d3553ab948" > < td class = "memItemLeft" align = "right" valign = "top" > static std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../db/dd0/classshaka_1_1Packager.html#a59fec4e3f33138081e5222d3553ab948" > DefaultStreamLabelFunction< / a > (int max_sd_pixels, int max_hd_pixels, int max_uhd1_pixels, const < a class = "el" href = "../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html" > EncryptionParams::EncryptedStreamAttributes< / a > & stream_attributes)< / td > < / tr >
< tr class = "separator:a59fec4e3f33138081e5222d3553ab948" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" >
2021-04-10 04:00:37 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00145" > 145< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2018-02-10 23:37:42 +00:00
< a id = "a59fec4e3f33138081e5222d3553ab948" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a59fec4e3f33138081e5222d3553ab948" > ◆ < / a > < / span > DefaultStreamLabelFunction()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string shaka::Packager::DefaultStreamLabelFunction < / td >
< td > (< / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > max_sd_pixels< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > max_hd_pixels< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > max_uhd1_pixels< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const < a class = "el" href = "../../d7/d6d/structshaka_1_1EncryptionParams_1_1EncryptedStreamAttributes.html" > EncryptionParams::EncryptedStreamAttributes< / a > &   < / td >
< td class = "paramname" > < em > stream_attributes< / em >   < / 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" >
2018-02-10 23:37:42 +00:00
< p > Default stream label function implementation. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramname" > max_sd_pixels< / td > < td > The threshold to determine whether a video track should be considered as SD. If the max pixels per frame is no higher than max_sd_pixels, i.e. [0, max_sd_pixels], it is SD. < / td > < / tr >
< tr > < td class = "paramname" > max_hd_pixels< / td > < td > The threshold to determine whether a video track should be considered as HD. If the max pixels per frame is higher than max_sd_pixels, but no higher than max_hd_pixels, i.e. (max_sd_pixels, max_hd_pixels], it is HD. < / td > < / tr >
< tr > < td class = "paramname" > max_uhd1_pixels< / td > < td > The threshold to determine whether a video track should be considered as UHD1. If the max pixels per frame is higher than max_hd_pixels, but no higher than max_uhd1_pixels, i.e. (max_hd_pixels, max_uhd1_pixels], it is UHD1. Otherwise it is UHD2. < / td > < / tr >
< tr > < td class = "paramname" > stream_info< / td > < td > Encrypted stream info. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > the stream label associated with < code > stream_info< / code > . Can be "AUDIO", "SD", "HD", "UHD1" or "UHD2". < / dd > < / dl >
2021-04-10 04:00:37 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d3/d48/packager_8cc_source.html#l00982" > 982< / a > of file < a class = "el" href = "../../d3/d48/packager_8cc_source.html" > packager.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "a7bae5b5c202a716f5d890e70afae51b2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a7bae5b5c202a716f5d890e70afae51b2" > ◆ < / a > < / span > GetLibraryVersion()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string shaka::Packager::GetLibraryVersion < / td >
< td > (< / td >
< td class = "paramname" > < / 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" >
< dl class = "section return" > < dt > Returns< / dt > < dd > The version of the library. < / dd > < / dl >
2021-04-10 04:00:37 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d3/d48/packager_8cc_source.html#l00978" > 978< / a > of file < a class = "el" href = "../../d3/d48/packager_8cc_source.html" > packager.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "ae40969a98da3a27a0b1633927afb3ce2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ae40969a98da3a27a0b1633927afb3ce2" > ◆ < / a > < / span > Initialize()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > shaka::Packager::Initialize < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "../../d5/de3/structshaka_1_1PackagingParams.html" > PackagingParams< / a > &   < / td >
< td class = "paramname" > < em > packaging_params< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "../../d2/d7b/structshaka_1_1StreamDescriptor.html" > StreamDescriptor< / a > > &   < / td >
< td class = "paramname" > < em > stream_descriptors< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Initialize packaging pipeline. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramname" > packaging_params< / td > < td > contains the packaging parameters. < / td > < / tr >
< tr > < td class = "paramname" > stream_descriptors< / td > < td > a list of stream descriptors. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > OK on success, an appropriate error code on failure. < / dd > < / dl >
2021-04-10 04:00:37 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d3/d48/packager_8cc_source.html#l00811" > 811< / a > of file < a class = "el" href = "../../d3/d48/packager_8cc_source.html" > packager.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "a48275206bc7032eb69607081ac0ada08" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a48275206bc7032eb69607081ac0ada08" > ◆ < / a > < / span > Run()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "../../d2/d20/classshaka_1_1Status.html" > Status< / a > shaka::Packager::Run < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Run the pipeline to completion (or failed / been cancelled). Note that it blocks until completion. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > OK on success, an appropriate error code on failure. < / dd > < / dl >
2017-09-20 02:35:05 +00:00
2021-04-10 04:00:37 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d3/d48/packager_8cc_source.html#l00953" > 953< / a > of file < a class = "el" href = "../../d3/d48/packager_8cc_source.html" > packager.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > packager/< a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > < / li >
< li > packager/< a class = "el" href = "../../d3/d48/packager_8cc_source.html" > packager.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2021-04-10 04:00:37 +00:00
Generated on Fri Apr 9 2021 21:00:13 for Shaka Packager SDK by  < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "../../doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.9.1
2017-09-20 02:35:05 +00:00
< / small > < / address >
< / body >
< / html >
