274 lines
15 KiB
HTML
274 lines
15 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>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"/>
|
|
<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">Shaka Packager 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</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="../../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>
|
|
<tr class="memitem:a5323e6dc242b1cdd6208cd6ea77dd0c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5323e6dc242b1cdd6208cd6ea77dd0c7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dd0/classshaka_1_1Packager.html#a5323e6dc242b1cdd6208cd6ea77dd0c7">Cancel</a> ()</td></tr>
|
|
<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>
|
|
<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">
|
|
<p>Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00113">113</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a59fec4e3f33138081e5222d3553ab948"></a>
|
|
<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">
|
|
<p>Default stream label function implementation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<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>
|
|
|
|
<p>Definition at line <a class="el" href="../../d3/d48/packager_8cc_source.html#l00893">893</a> of file <a class="el" href="../../d3/d48/packager_8cc_source.html">packager.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7bae5b5c202a716f5d890e70afae51b2"></a>
|
|
<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>
|
|
|
|
<p>Definition at line <a class="el" href="../../d3/d48/packager_8cc_source.html#l00889">889</a> of file <a class="el" href="../../d3/d48/packager_8cc_source.html">packager.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae40969a98da3a27a0b1633927afb3ce2"></a>
|
|
<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">
|
|
<p>Initialize packaging pipeline. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<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>
|
|
|
|
<p>Definition at line <a class="el" href="../../d3/d48/packager_8cc_source.html#l00743">743</a> of file <a class="el" href="../../d3/d48/packager_8cc_source.html">packager.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a48275206bc7032eb69607081ac0ada08"></a>
|
|
<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">
|
|
<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>
|
|
|
|
<p>Definition at line <a class="el" href="../../d3/d48/packager_8cc_source.html#l00862">862</a> of file <a class="el" href="../../d3/d48/packager_8cc_source.html">packager.cc</a>.</p>
|
|
|
|
</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>
|
|
Generated on Tue Oct 24 2017 15:50:12 for Shaka Packager 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>
|