Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d0/d27/structshaka_1_1media_1_1Mux...

300 lines
19 KiB
HTML
Raw Blame 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::MuxerOptions 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="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html">MuxerOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d8/d16/structshaka_1_1media_1_1MuxerOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::MuxerOptions Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This structure contains the list of configuration options for <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a>.
<a href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.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:a15e22454ac119d191ef0adbc8b4965ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a15e22454ac119d191ef0adbc8b4965ab">single_segment</a></td></tr>
<tr class="separator:a15e22454ac119d191ef0adbc8b4965ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e98ad5fc7bbc2df0cb95df3f1db9687"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a4e98ad5fc7bbc2df0cb95df3f1db9687">segment_duration</a></td></tr>
<tr class="separator:a4e98ad5fc7bbc2df0cb95df3f1db9687"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dbe637b21f1f22f248437b59ad62a38"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a0dbe637b21f1f22f248437b59ad62a38">fragment_duration</a></td></tr>
<tr class="separator:a0dbe637b21f1f22f248437b59ad62a38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f1336e9be8b12733fe28da083eaf93f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a1f1336e9be8b12733fe28da083eaf93f">segment_sap_aligned</a></td></tr>
<tr class="separator:a1f1336e9be8b12733fe28da083eaf93f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb335182d4bd226c1f044cc83705f4fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#acb335182d4bd226c1f044cc83705f4fc">fragment_sap_aligned</a></td></tr>
<tr class="separator:acb335182d4bd226c1f044cc83705f4fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2db773300dadf681c40bef0b3eca3ece"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a2db773300dadf681c40bef0b3eca3ece">num_subsegments_per_sidx</a></td></tr>
<tr class="separator:a2db773300dadf681c40bef0b3eca3ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d3d8c1923a2e0f684c2591cd7f4a890"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a4d3d8c1923a2e0f684c2591cd7f4a890">mp4_use_decoding_timestamp_in_timeline</a></td></tr>
<tr class="separator:a4d3d8c1923a2e0f684c2591cd7f4a890"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5397ee8759a663aea68261600e528d82"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a5397ee8759a663aea68261600e528d82">output_file_name</a></td></tr>
<tr class="separator:a5397ee8759a663aea68261600e528d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab98cfd28046fc5c52ab2a45dba1a339a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#ab98cfd28046fc5c52ab2a45dba1a339a">segment_template</a></td></tr>
<tr class="separator:ab98cfd28046fc5c52ab2a45dba1a339a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872d1150a71d9f0fb5db0ab81334d614"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a872d1150a71d9f0fb5db0ab81334d614"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a872d1150a71d9f0fb5db0ab81334d614">temp_dir</a></td></tr>
<tr class="memdesc:a872d1150a71d9f0fb5db0ab81334d614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify temporary directory for intermediate files. <br/></td></tr>
<tr class="separator:a872d1150a71d9f0fb5db0ab81334d614"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a930587b1f3a3e38cf1e7974f01d8ce1e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d27/structshaka_1_1media_1_1MuxerOptions.html#a930587b1f3a3e38cf1e7974f01d8ce1e">bandwidth</a></td></tr>
<tr class="separator:a930587b1f3a3e38cf1e7974f01d8ce1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f92646ce6eb6f9e606ae6559da3414e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f92646ce6eb6f9e606ae6559da3414e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>webm_subsample_encryption</b></td></tr>
<tr class="separator:a1f92646ce6eb6f9e606ae6559da3414e"><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 contains the list of configuration options for <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a>. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00018">18</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a930587b1f3a3e38cf1e7974f01d8ce1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::media::MuxerOptions::bandwidth</td>
</tr>
</table>
</div><div class="memdoc">
<p>User-specified bit rate for the media stream. If zero, the muxer will attempt to estimate. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00075">75</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0dbe637b21f1f22f248437b59ad62a38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::media::MuxerOptions::fragment_duration</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fragment duration in seconds. Should not be larger than the segment duration. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00034">34</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="acb335182d4bd226c1f044cc83705f4fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::MuxerOptions::fragment_sap_aligned</td>
</tr>
</table>
</div><div class="memdoc">
<p>Force fragments to begin with stream access points. Fragment duration may not be exactly what specified by segment_duration. Setting to true implies that segment_sap_aligned is true as well. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00043">43</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4d3d8c1923a2e0f684c2591cd7f4a890"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::MuxerOptions::mp4_use_decoding_timestamp_in_timeline</td>
</tr>
</table>
</div><div class="memdoc">
<p>For ISO BMFF only. Set the flag use_decoding_timestamp_in_timeline, which if set to true, use decoding timestamp instead of presentation timestamp in media timeline, which is needed to workaround a Chromium bug that decoding timestamp is used in buffered range, <a href="https://crbug.com/398130">https://crbug.com/398130</a>. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00057">57</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2db773300dadf681c40bef0b3eca3ece"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int shaka::media::MuxerOptions::num_subsegments_per_sidx</td>
</tr>
</table>
</div><div class="memdoc">
<p>For ISO BMFF only. Set the number of subsegments in each SIDX box. If 0, a single SIDX box is used per segment. If -1, no SIDX box is used. Otherwise, the <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> will pack N subsegments in the root SIDX of the segment, with segment_duration/N/fragment_duration fragments per subsegment. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00050">50</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5397ee8759a663aea68261600e528d82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::media::MuxerOptions::output_file_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Output file name. If segment_template is not specified, the <a class="el" href="../../df/d46/classshaka_1_1media_1_1Muxer.html">Muxer</a> generates this single output file with all segments concatenated; Otherwise, it specifies the init segment name. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00062">62</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4e98ad5fc7bbc2df0cb95df3f1db9687"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::media::MuxerOptions::segment_duration</td>
</tr>
</table>
</div><div class="memdoc">
<p>Segment duration in seconds. If single_segment is specified, this parameter sets the duration of a subsegment; otherwise, this parameter sets the duration of a segment. A segment can contain one or many fragments. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00030">30</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1f1336e9be8b12733fe28da083eaf93f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::MuxerOptions::segment_sap_aligned</td>
</tr>
</table>
</div><div class="memdoc">
<p>Force segments to begin with stream access points. Segment duration may not be exactly what specified by segment_duration. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00038">38</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab98cfd28046fc5c52ab2a45dba1a339a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::media::MuxerOptions::segment_template</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify output segment name pattern for generated segments. It can furthermore be configured by using a subset of the SegmentTemplate identifiers: $RepresentationID$, $Number$, $Bandwidth$ and $Time. Optional. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00068">68</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<a class="anchor" id="a15e22454ac119d191ef0adbc8b4965ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::MuxerOptions::single_segment</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a single segment for each media presentation. This option should be set for on demand profile. </p>
<p>Definition at line <a class="el" href="../../d0/d0e/muxer__options_8h_source.html#l00024">24</a> of file <a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>media/base/<a class="el" href="../../d0/d0e/muxer__options_8h_source.html">muxer_options.h</a></li>
<li>media/base/<a class="el" href="../../db/d7e/muxer__options_8cc_source.html">muxer_options.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 10 2017 01:58:41 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>
Reference in New Issue View Git Blame Copy Permalink