shaka-packager/docs/d3/d07/mpd__params_8h_source.html

138 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/mpd/public/mpd_params.h Source File</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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_b885194e7131202a9b4650a8967e838c.html">mpd</a></li><li class="navelem"><a class="el" href="../../dir_933242dc2ed3ec7a82c146e98110781e.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mpd_params.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2017 Google Inc. All rights reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Use of this source code is governed by a BSD-style</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// license that can be found in the LICENSE file or at</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef PACKAGER_MPD_PUBLIC_MPD_PARAMS_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_MPD_PUBLIC_MPD_PARAMS_H_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html"> 16</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html">MpdParams</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#aa6ca18997bb307d3b5fe1c9ced161ff6"> 18</a></span>&#160; std::string <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#aa6ca18997bb307d3b5fe1c9ced161ff6">mpd_output</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a9fe508f9c56a6424fd857d43a4a69e7c"> 21</a></span>&#160; std::vector&lt;std::string&gt; <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a9fe508f9c56a6424fd857d43a4a69e7c">base_urls</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#aee1510b64b9acbc17b8bfccac2e132a3"> 27</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#aee1510b64b9acbc17b8bfccac2e132a3">min_buffer_time</a> = 2.0;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a4a5dafe570fd7e35749ce12d83ca9559"> 30</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a4a5dafe570fd7e35749ce12d83ca9559">minimum_update_period</a> = 0;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0"> 35</a></span>&#160; <span class="keyword">static</span> constexpr <span class="keywordtype">double</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0">kSuggestedPresentationDelayNotSet</a> = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">double</span> suggested_presentation_delay = <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0">kSuggestedPresentationDelayNotSet</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a95e4824708c8de4b882b86772f680032"> 39</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a95e4824708c8de4b882b86772f680032">time_shift_buffer_depth</a> = 0;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a84378ed480ed2e9b8915afd9c349b458"> 46</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a84378ed480ed2e9b8915afd9c349b458">preserved_segments_outside_live_window</a> = 0;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html"> 48</a></span>&#160; <span class="keyword">struct </span><a class="code" href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html">UtcTiming</a> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; std::string scheme_id_uri;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::string value;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; };</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::vector&lt;UtcTiming&gt; utc_timings;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a74df80bd74635090e97837f3a5941d73"> 58</a></span>&#160; std::string <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a74df80bd74635090e97837f3a5941d73">default_language</a>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#acafb3925f5d32826a241d00f2bf09509"> 61</a></span>&#160; std::string <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#acafb3925f5d32826a241d00f2bf09509">default_text_language</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#ab5a09b17ee41a0960e813bd0c72bf4f6"> 64</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#ab5a09b17ee41a0960e813bd0c72bf4f6">generate_static_live_mpd</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#aa1b2ec6746586d4981655cee62669ba2"> 66</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#aa1b2ec6746586d4981655cee62669ba2">generate_dash_if_iop_compliant_mpd</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#af4424dc23f81ff4000584db2866f24c9"> 76</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#af4424dc23f81ff4000584db2866f24c9">allow_approximate_segment_timeline</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a88b8d28e263b2dcb36909869d3c2ceca"> 82</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a88b8d28e263b2dcb36909869d3c2ceca">target_segment_duration</a> = 0;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a6462a0b4d325e183c4f20ead905c5f49"> 85</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a6462a0b4d325e183c4f20ead905c5f49">allow_codec_switching</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="../../df/ddc/structshaka_1_1MpdParams.html#a0b9e838af6d1a602e7eaee30a0a9c979"> 89</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../df/ddc/structshaka_1_1MpdParams.html#a0b9e838af6d1a602e7eaee30a0a9c979">include_mspr_pro</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;};</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// PACKAGER_MPD_PUBLIC_MPD_PARAMS_H_</span></div>
<div class="ttc" id="anamespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking.</div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_1_1UtcTiming_html"><div class="ttname"><a href="../../d3/d6e/structshaka_1_1MpdParams_1_1UtcTiming.html">shaka::MpdParams::UtcTiming</a></div><div class="ttdoc">UTCTimings. For dynamic MPD only.</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00048">mpd_params.h:48</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html">shaka::MpdParams</a></div><div class="ttdoc">DASH MPD related parameters.</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00016">mpd_params.h:16</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a0b9e838af6d1a602e7eaee30a0a9c979"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a0b9e838af6d1a602e7eaee30a0a9c979">shaka::MpdParams::include_mspr_pro</a></div><div class="ttdeci">bool include_mspr_pro</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00089">mpd_params.h:89</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a13705544aac44c5d2065b8a842744bf0"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a13705544aac44c5d2065b8a842744bf0">shaka::MpdParams::kSuggestedPresentationDelayNotSet</a></div><div class="ttdeci">static constexpr double kSuggestedPresentationDelayNotSet</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00035">mpd_params.h:35</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a4a5dafe570fd7e35749ce12d83ca9559"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a4a5dafe570fd7e35749ce12d83ca9559">shaka::MpdParams::minimum_update_period</a></div><div class="ttdeci">double minimum_update_period</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00030">mpd_params.h:30</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a6462a0b4d325e183c4f20ead905c5f49"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a6462a0b4d325e183c4f20ead905c5f49">shaka::MpdParams::allow_codec_switching</a></div><div class="ttdeci">bool allow_codec_switching</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00085">mpd_params.h:85</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a74df80bd74635090e97837f3a5941d73"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a74df80bd74635090e97837f3a5941d73">shaka::MpdParams::default_language</a></div><div class="ttdeci">std::string default_language</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00058">mpd_params.h:58</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a84378ed480ed2e9b8915afd9c349b458"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a84378ed480ed2e9b8915afd9c349b458">shaka::MpdParams::preserved_segments_outside_live_window</a></div><div class="ttdeci">size_t preserved_segments_outside_live_window</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00046">mpd_params.h:46</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a88b8d28e263b2dcb36909869d3c2ceca"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a88b8d28e263b2dcb36909869d3c2ceca">shaka::MpdParams::target_segment_duration</a></div><div class="ttdeci">double target_segment_duration</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00082">mpd_params.h:82</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a95e4824708c8de4b882b86772f680032"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a95e4824708c8de4b882b86772f680032">shaka::MpdParams::time_shift_buffer_depth</a></div><div class="ttdeci">double time_shift_buffer_depth</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00039">mpd_params.h:39</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_a9fe508f9c56a6424fd857d43a4a69e7c"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#a9fe508f9c56a6424fd857d43a4a69e7c">shaka::MpdParams::base_urls</a></div><div class="ttdeci">std::vector&lt; std::string &gt; base_urls</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00021">mpd_params.h:21</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_aa1b2ec6746586d4981655cee62669ba2"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#aa1b2ec6746586d4981655cee62669ba2">shaka::MpdParams::generate_dash_if_iop_compliant_mpd</a></div><div class="ttdeci">bool generate_dash_if_iop_compliant_mpd</div><div class="ttdoc">Try to generate DASH-IF IOP compliant MPD.</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00066">mpd_params.h:66</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_aa6ca18997bb307d3b5fe1c9ced161ff6"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#aa6ca18997bb307d3b5fe1c9ced161ff6">shaka::MpdParams::mpd_output</a></div><div class="ttdeci">std::string mpd_output</div><div class="ttdoc">MPD output file path.</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00018">mpd_params.h:18</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_ab5a09b17ee41a0960e813bd0c72bf4f6"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#ab5a09b17ee41a0960e813bd0c72bf4f6">shaka::MpdParams::generate_static_live_mpd</a></div><div class="ttdeci">bool generate_static_live_mpd</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00064">mpd_params.h:64</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_acafb3925f5d32826a241d00f2bf09509"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#acafb3925f5d32826a241d00f2bf09509">shaka::MpdParams::default_text_language</a></div><div class="ttdeci">std::string default_text_language</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00061">mpd_params.h:61</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_aee1510b64b9acbc17b8bfccac2e132a3"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#aee1510b64b9acbc17b8bfccac2e132a3">shaka::MpdParams::min_buffer_time</a></div><div class="ttdeci">double min_buffer_time</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00027">mpd_params.h:27</a></div></div>
<div class="ttc" id="astructshaka_1_1MpdParams_html_af4424dc23f81ff4000584db2866f24c9"><div class="ttname"><a href="../../df/ddc/structshaka_1_1MpdParams.html#af4424dc23f81ff4000584db2866f24c9">shaka::MpdParams::allow_approximate_segment_timeline</a></div><div class="ttdeci">bool allow_approximate_segment_timeline</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d07/mpd__params_8h_source.html#l00076">mpd_params.h:76</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 9 2021 21:00:12 for Shaka Packager SDK by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>