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/df/ddc/structshaka_1_1MpdParams.html

254 lines
15 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::MpdParams 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/searchdata.js"></script>
<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;">
<td id="projectalign" 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="../../df/ddc/structshaka_1_1MpdParams.html">MpdParams</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="../../db/d6b/structshaka_1_1MpdParams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::MpdParams Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>DASH MPD related parameters.
<a href="../../df/ddc/structshaka_1_1MpdParams.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.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:aa6ca18997bb307d3b5fe1c9ced161ff6"><td class="memItemLeft" align="right" valign="top"><a id="aa6ca18997bb307d3b5fe1c9ced161ff6"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#aa6ca18997bb307d3b5fe1c9ced161ff6">mpd_output</a></td></tr>
<tr class="memdesc:aa6ca18997bb307d3b5fe1c9ced161ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">MPD output file path. <br /></td></tr>
<tr class="separator:aa6ca18997bb307d3b5fe1c9ced161ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fe508f9c56a6424fd857d43a4a69e7c"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a9fe508f9c56a6424fd857d43a4a69e7c">base_urls</a></td></tr>
<tr class="separator:a9fe508f9c56a6424fd857d43a4a69e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee1510b64b9acbc17b8bfccac2e132a3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#aee1510b64b9acbc17b8bfccac2e132a3">min_buffer_time</a> = 2.0</td></tr>
<tr class="separator:aee1510b64b9acbc17b8bfccac2e132a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5a09b17ee41a0960e813bd0c72bf4f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#ab5a09b17ee41a0960e813bd0c72bf4f6">generate_static_live_mpd</a> = false</td></tr>
<tr class="separator:ab5a09b17ee41a0960e813bd0c72bf4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95e4824708c8de4b882b86772f680032"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a95e4824708c8de4b882b86772f680032">time_shift_buffer_depth</a> = 0</td></tr>
<tr class="separator:a95e4824708c8de4b882b86772f680032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa239121f028639193d109b3dfa7c3c24"><td class="memItemLeft" align="right" valign="top"><a id="aa239121f028639193d109b3dfa7c3c24"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>suggested_presentation_delay</b> = <a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0">kSuggestedPresentationDelayNotSet</a></td></tr>
<tr class="separator:aa239121f028639193d109b3dfa7c3c24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a5dafe570fd7e35749ce12d83ca9559"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a4a5dafe570fd7e35749ce12d83ca9559">minimum_update_period</a> = 0</td></tr>
<tr class="separator:a4a5dafe570fd7e35749ce12d83ca9559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74df80bd74635090e97837f3a5941d73"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a74df80bd74635090e97837f3a5941d73">default_language</a></td></tr>
<tr class="separator:a74df80bd74635090e97837f3a5941d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b2ec6746586d4981655cee62669ba2"><td class="memItemLeft" align="right" valign="top"><a id="aa1b2ec6746586d4981655cee62669ba2"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#aa1b2ec6746586d4981655cee62669ba2">generate_dash_if_iop_compliant_mpd</a> = true</td></tr>
<tr class="memdesc:aa1b2ec6746586d4981655cee62669ba2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to generate DASH-IF IOP compliant MPD. <br /></td></tr>
<tr class="separator:aa1b2ec6746586d4981655cee62669ba2"><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:a13705544aac44c5d2065b8a842744bf0"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0">kSuggestedPresentationDelayNotSet</a> = 0</td></tr>
<tr class="separator:a13705544aac44c5d2065b8a842744bf0"><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>DASH MPD related parameters. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00016">16</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a9fe508f9c56a6424fd857d43a4a69e7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fe508f9c56a6424fd857d43a4a69e7c">&#9670;&nbsp;</a></span>base_urls</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::string&gt; shaka::MpdParams::base_urls</td>
</tr>
</table>
</div><div class="memdoc">
<p>BaseURLs for the MPD. The values will be added as &lt;BaseURL&gt; element(s) under the &lt;MPD&gt; element. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00021">21</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="a74df80bd74635090e97837f3a5941d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74df80bd74635090e97837f3a5941d73">&#9670;&nbsp;</a></span>default_language</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::MpdParams::default_language</td>
</tr>
</table>
</div><div class="memdoc">
<p>The tracks tagged with this language will have &lt;Role ... value="main" /&gt; in the manifest. This allows the player to choose the correct default language for the content. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00046">46</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="ab5a09b17ee41a0960e813bd0c72bf4f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5a09b17ee41a0960e813bd0c72bf4f6">&#9670;&nbsp;</a></span>generate_static_live_mpd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::MpdParams::generate_static_live_mpd = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate static MPD for live profile. Note that this flag has no effect for on-demand profile, in which case static MPD is always used. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00030">30</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="a13705544aac44c5d2065b8a842744bf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13705544aac44c5d2065b8a842744bf0">&#9670;&nbsp;</a></span>kSuggestedPresentationDelayNotSet</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr double shaka::MpdParams::kSuggestedPresentationDelayNotSet = 0</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>Set MPD attribute. For 'dynamic' media presentations, it specifies a delay, in seconds, to be added to the media presentation time. The attribute is not set if the value is 0; the client is expected to choose a suitable value in this case. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00038">38</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="aee1510b64b9acbc17b8bfccac2e132a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee1510b64b9acbc17b8bfccac2e132a3">&#9670;&nbsp;</a></span>min_buffer_time</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::MpdParams::min_buffer_time = 2.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set MPD attribute, which specifies, in seconds, a common duration used in the definition of the MPD representation data rate. A client can be assured of having enough data for continous playout providing playout begins at min_buffer_time after the first bit is received. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00027">27</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="a4a5dafe570fd7e35749ce12d83ca9559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a5dafe570fd7e35749ce12d83ca9559">&#9670;&nbsp;</a></span>minimum_update_period</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::MpdParams::minimum_update_period = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set MPD attribute, which indicates to the player how often to refresh the MPD in seconds. For dynamic MPD only. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00042">42</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<a id="a95e4824708c8de4b882b86772f680032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95e4824708c8de4b882b86772f680032">&#9670;&nbsp;</a></span>time_shift_buffer_depth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::MpdParams::time_shift_buffer_depth = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set MPD attribute, which is the guaranteed duration of the time shifting buffer for 'dynamic' media presentations, in seconds. </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00033">33</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>packager/mpd/public/<a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 10 2018 15:36:45 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink