302 lines
19 KiB
HTML
302 lines
19 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.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="#nested-classes">Classes</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<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 <<a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html">UtcTiming</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UTCTimings. For dynamic MPD only. <a href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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 </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"> </td><td class="mdescRight">MPD output file path. <br /></td></tr>
|
|
<tr class="separator:aa6ca18997bb307d3b5fe1c9ced161ff6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fe508f9c56a6424fd857d43a4a69e7c"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </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"> </td></tr>
|
|
<tr class="memitem:aee1510b64b9acbc17b8bfccac2e132a3"><td class="memItemLeft" align="right" valign="top">double </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"> </td></tr>
|
|
<tr class="memitem:a4a5dafe570fd7e35749ce12d83ca9559"><td class="memItemLeft" align="right" valign="top">double </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"> </td></tr>
|
|
<tr class="memitem:aa239121f028639193d109b3dfa7c3c24"><td class="memItemLeft" align="right" valign="top"><a id="aa239121f028639193d109b3dfa7c3c24"></a>
|
|
double </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"> </td></tr>
|
|
<tr class="memitem:a95e4824708c8de4b882b86772f680032"><td class="memItemLeft" align="right" valign="top">double </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"> </td></tr>
|
|
<tr class="memitem:a84378ed480ed2e9b8915afd9c349b458"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#a84378ed480ed2e9b8915afd9c349b458">preserved_segments_outside_live_window</a> = 0</td></tr>
|
|
<tr class="separator:a84378ed480ed2e9b8915afd9c349b458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb0cdbb3c3580e1f3a107528c07c8d4b"><td class="memItemLeft" align="right" valign="top"><a id="adb0cdbb3c3580e1f3a107528c07c8d4b"></a>
|
|
std::vector< <a class="el" href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html">UtcTiming</a> > </td><td class="memItemRight" valign="bottom"><b>utc_timings</b></td></tr>
|
|
<tr class="separator:adb0cdbb3c3580e1f3a107528c07c8d4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74df80bd74635090e97837f3a5941d73"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
|
|
<tr class="memitem:ab5a09b17ee41a0960e813bd0c72bf4f6"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
|
|
<tr class="memitem:aa1b2ec6746586d4981655cee62669ba2"><td class="memItemLeft" align="right" valign="top"><a id="aa1b2ec6746586d4981655cee62669ba2"></a>
|
|
bool </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"> </td><td class="mdescRight">Try to generate DASH-IF IOP compliant MPD. <br /></td></tr>
|
|
<tr class="separator:aa1b2ec6746586d4981655cee62669ba2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4424dc23f81ff4000584db2866f24c9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/ddc/structshaka_1_1MpdParams.html#af4424dc23f81ff4000584db2866f24c9">allow_approximate_segment_timeline</a> = false</td></tr>
|
|
<tr class="separator:af4424dc23f81ff4000584db2866f24c9"><td class="memSeparator" colspan="2"> </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 </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"> </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="af4424dc23f81ff4000584db2866f24c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4424dc23f81ff4000584db2866f24c9">◆ </a></span>allow_approximate_segment_timeline</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::MpdParams::allow_approximate_segment_timeline = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For live profile only. If enabled, segments with close duration (i.e. with difference less than one sample) are considered to have the same duration. This enables MPD generator to generate less SegmentTimeline entries. If all segments are of the same duration except the last one, we will do further optimization to use SegmentTemplate instead and omit SegmentTimeline completely. Ignored if $Time$ is used in segment template, since $Time$ requires accurate Segment Timeline. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d3/d07/mpd__params_8h_source.html#l00071">71</a> of file <a class="el" href="../../d3/d07/mpd__params_8h_source.html">mpd_params.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9fe508f9c56a6424fd857d43a4a69e7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fe508f9c56a6424fd857d43a4a69e7c">◆ </a></span>base_urls</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<std::string> shaka::MpdParams::base_urls</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>BaseURLs for the MPD. The values will be added as <BaseURL> element(s) under the <MPD> 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">◆ </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 <Role ... value="main" /> 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#l00056">56</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">◆ </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#l00059">59</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">◆ </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#l00035">35</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">◆ </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">◆ </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#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="a84378ed480ed2e9b8915afd9c349b458"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84378ed480ed2e9b8915afd9c349b458">◆ </a></span>preserved_segments_outside_live_window</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t shaka::MpdParams::preserved_segments_outside_live_window = 0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Segments outside the live window (defined by 'time_shift_buffer_depth' above) are automatically removed except for the most recent X segments defined by this parameter. This is needed to accommodate latencies in various stages of content serving pipeline, so that the segments stay accessible as they may still be accessed by the player. The segments are not removed if the value is zero. </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="a95e4824708c8de4b882b86772f680032"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95e4824708c8de4b882b86772f680032">◆ </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#l00039">39</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 Thu Jun 28 2018 17:32:58 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|