shaka-packager/docs/d6/d47/hls__params_8h_source.html

132 lines
16 KiB
HTML
Raw Normal View History

<!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"/>
2021-06-22 00:16:40 +00:00
<meta name="generator" content="Doxygen 1.8.17"/>
2018-02-10 23:37:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/hls/public/hls_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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
2018-02-10 23:37:42 +00:00
<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 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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_b7f276137d53b05d7f6b34219adc0a31.html">hls</a></li><li class="navelem"><a class="el" href="../../dir_ffb529e2a1792bf603304ea6ff9bf092.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hls_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_HLS_PUBLIC_HLS_PARAMS_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_HLS_PUBLIC_HLS_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; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d"> 16</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; kVod,</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; kEvent,</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; kLive,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;};</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html"> 23</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#a9bfeae8a0c112ca82830dd3f228438e6"> 25</a></span>&#160; <a class="code" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#a9bfeae8a0c112ca82830dd3f228438e6">playlist_type</a> = HlsPlaylistType::kVod;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#ae3706891d39f8da72ed59d8fb13f2e30"> 27</a></span>&#160; std::string <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#ae3706891d39f8da72ed59d8fb13f2e30">master_playlist_output</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#a546dcdf68c8a0a5e188f84b5c9fca9dd"> 30</a></span>&#160; std::string <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#a546dcdf68c8a0a5e188f84b5c9fca9dd">base_url</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#adc19a9eebbfe20c3f9fe03dd452e4b1b"> 33</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#adc19a9eebbfe20c3f9fe03dd452e4b1b">time_shift_buffer_depth</a> = 0;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#aa471aaa93cb7c95996902648e376c2e6"> 40</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#aa471aaa93cb7c95996902648e376c2e6">preserved_segments_outside_live_window</a> = 0;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#a68414aff0f65059c2d05c8d168aadf5f"> 44</a></span>&#160; std::string <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#a68414aff0f65059c2d05c8d168aadf5f">key_uri</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#abeea3a7ebfe7b2d1e29b3e4445bfd113"> 50</a></span>&#160; std::string <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#abeea3a7ebfe7b2d1e29b3e4445bfd113">default_language</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#a77961998aa8083ec8f9e58f02521566b"> 53</a></span>&#160; std::string <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#a77961998aa8083ec8f9e58f02521566b">default_text_language</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Indicates that all media samples in the media segments can be decoded</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// without information from other segments.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">bool</span> is_independent_segments;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#aaa9c66720a8fb0e7ee3ef362825919a6"> 61</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#aaa9c66720a8fb0e7ee3ef362825919a6">target_segment_duration</a> = 0;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="../../d0/da8/structshaka_1_1HlsParams.html#a21e605e6e09e2592edba4dab8a0f5d4d"> 64</a></span>&#160; uint32_t <a class="code" href="../../d0/da8/structshaka_1_1HlsParams.html#a21e605e6e09e2592edba4dab8a0f5d4d">media_sequence_number</a> = 0;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;};</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
2021-06-22 00:16:40 +00:00
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif // PACKAGER_HLS_PUBLIC_HLS_PARAMS_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructshaka_1_1HlsParams_html_a77961998aa8083ec8f9e58f02521566b"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#a77961998aa8083ec8f9e58f02521566b">shaka::HlsParams::default_text_language</a></div><div class="ttdeci">std::string default_text_language</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00053">hls_params.h:53</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="astructshaka_1_1HlsParams_html"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html">shaka::HlsParams</a></div><div class="ttdoc">HLS related parameters.</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00023">hls_params.h:23</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_abeea3a7ebfe7b2d1e29b3e4445bfd113"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#abeea3a7ebfe7b2d1e29b3e4445bfd113">shaka::HlsParams::default_language</a></div><div class="ttdeci">std::string default_language</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00050">hls_params.h:50</a></div></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_1HlsParams_html_adc19a9eebbfe20c3f9fe03dd452e4b1b"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#adc19a9eebbfe20c3f9fe03dd452e4b1b">shaka::HlsParams::time_shift_buffer_depth</a></div><div class="ttdeci">double time_shift_buffer_depth</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00033">hls_params.h:33</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_a9bfeae8a0c112ca82830dd3f228438e6"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#a9bfeae8a0c112ca82830dd3f228438e6">shaka::HlsParams::playlist_type</a></div><div class="ttdeci">HlsPlaylistType playlist_type</div><div class="ttdoc">HLS playlist type. See HLS specification for details.</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00025">hls_params.h:25</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_aa471aaa93cb7c95996902648e376c2e6"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#aa471aaa93cb7c95996902648e376c2e6">shaka::HlsParams::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="../../d6/d47/hls__params_8h_source.html#l00040">hls_params.h:40</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="astructshaka_1_1HlsParams_html_a68414aff0f65059c2d05c8d168aadf5f"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#a68414aff0f65059c2d05c8d168aadf5f">shaka::HlsParams::key_uri</a></div><div class="ttdeci">std::string key_uri</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00044">hls_params.h:44</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_aaa9c66720a8fb0e7ee3ef362825919a6"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#aaa9c66720a8fb0e7ee3ef362825919a6">shaka::HlsParams::target_segment_duration</a></div><div class="ttdeci">double target_segment_duration</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00061">hls_params.h:61</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_ae3706891d39f8da72ed59d8fb13f2e30"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#ae3706891d39f8da72ed59d8fb13f2e30">shaka::HlsParams::master_playlist_output</a></div><div class="ttdeci">std::string master_playlist_output</div><div class="ttdoc">HLS master playlist output path.</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00027">hls_params.h:27</a></div></div>
2021-06-22 00:16:40 +00:00
<div class="ttc" id="astructshaka_1_1HlsParams_html_a546dcdf68c8a0a5e188f84b5c9fca9dd"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#a546dcdf68c8a0a5e188f84b5c9fca9dd">shaka::HlsParams::base_url</a></div><div class="ttdeci">std::string base_url</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00030">hls_params.h:30</a></div></div>
<div class="ttc" id="anamespaceshaka_html_ab63a3c00cdbf61cfb6dd7a2497b26f8d"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">shaka::HlsPlaylistType</a></div><div class="ttdeci">HlsPlaylistType</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00016">hls_params.h:16</a></div></div>
<div class="ttc" id="astructshaka_1_1HlsParams_html_a21e605e6e09e2592edba4dab8a0f5d4d"><div class="ttname"><a href="../../d0/da8/structshaka_1_1HlsParams.html#a21e605e6e09e2592edba4dab8a0f5d4d">shaka::HlsParams::media_sequence_number</a></div><div class="ttdeci">uint32_t media_sequence_number</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d47/hls__params_8h_source.html#l00064">hls_params.h:64</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2021-06-22 00:16:40 +00:00
Generated on Tue Jun 22 2021 00:16:03 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.17
</small></address>
</body>
</html>