shaka-packager/docs/d0/da8/structshaka_1_1HlsParams.html

182 lines
10 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::HlsParams 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="../../d0/da8/structshaka_1_1HlsParams.html">HlsParams</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d7/d6c/structshaka_1_1HlsParams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::HlsParams Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>HLS related parameters.
<a href="../../d0/da8/structshaka_1_1HlsParams.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_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:a9bfeae8a0c112ca82830dd3f228438e6"><td class="memItemLeft" align="right" valign="top"><a id="a9bfeae8a0c112ca82830dd3f228438e6"></a>
<a class="el" href="../../d8/daf/namespaceshaka.html#ab63a3c00cdbf61cfb6dd7a2497b26f8d">HlsPlaylistType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#a9bfeae8a0c112ca82830dd3f228438e6">playlist_type</a> = HlsPlaylistType::kVod</td></tr>
<tr class="memdesc:a9bfeae8a0c112ca82830dd3f228438e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">HLS playlist type. See HLS specification for details. <br /></td></tr>
<tr class="separator:a9bfeae8a0c112ca82830dd3f228438e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3706891d39f8da72ed59d8fb13f2e30"><td class="memItemLeft" align="right" valign="top"><a id="ae3706891d39f8da72ed59d8fb13f2e30"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#ae3706891d39f8da72ed59d8fb13f2e30">master_playlist_output</a></td></tr>
<tr class="memdesc:ae3706891d39f8da72ed59d8fb13f2e30"><td class="mdescLeft">&#160;</td><td class="mdescRight">HLS master playlist output path. <br /></td></tr>
<tr class="separator:ae3706891d39f8da72ed59d8fb13f2e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a546dcdf68c8a0a5e188f84b5c9fca9dd"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#a546dcdf68c8a0a5e188f84b5c9fca9dd">base_url</a></td></tr>
<tr class="separator:a546dcdf68c8a0a5e188f84b5c9fca9dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc19a9eebbfe20c3f9fe03dd452e4b1b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#adc19a9eebbfe20c3f9fe03dd452e4b1b">time_shift_buffer_depth</a> = 0</td></tr>
<tr class="separator:adc19a9eebbfe20c3f9fe03dd452e4b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68414aff0f65059c2d05c8d168aadf5f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#a68414aff0f65059c2d05c8d168aadf5f">key_uri</a></td></tr>
<tr class="separator:a68414aff0f65059c2d05c8d168aadf5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeea3a7ebfe7b2d1e29b3e4445bfd113"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/da8/structshaka_1_1HlsParams.html#abeea3a7ebfe7b2d1e29b3e4445bfd113">default_language</a></td></tr>
<tr class="separator:abeea3a7ebfe7b2d1e29b3e4445bfd113"><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>HLS related parameters. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/hls__params_8h_source.html#l00023">23</a> of file <a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_params.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a546dcdf68c8a0a5e188f84b5c9fca9dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a546dcdf68c8a0a5e188f84b5c9fca9dd">&#9670;&nbsp;</a></span>base_url</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::HlsParams::base_url</td>
</tr>
</table>
</div><div class="memdoc">
<p>The base URL for the Media Playlists and media files listed in the playlists. This is the prefix for the files. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/hls__params_8h_source.html#l00030">30</a> of file <a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_params.h</a>.</p>
</div>
</div>
<a id="abeea3a7ebfe7b2d1e29b3e4445bfd113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeea3a7ebfe7b2d1e29b3e4445bfd113">&#9670;&nbsp;</a></span>default_language</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::HlsParams::default_language</td>
</tr>
</table>
</div><div class="memdoc">
<p>The renditions tagged with this language will have 'DEFAULT' set to 'YES' in 'EXT-X-MEDIA' tag. This allows the player to choose the correct default language for the content. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/hls__params_8h_source.html#l00041">41</a> of file <a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_params.h</a>.</p>
</div>
</div>
<a id="a68414aff0f65059c2d05c8d168aadf5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68414aff0f65059c2d05c8d168aadf5f">&#9670;&nbsp;</a></span>key_uri</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::HlsParams::key_uri</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines the key uri for "identity" and "com.apple.streamingkeydelivery" key formats. Ignored if the playlist is not encrypted or not using the above key formats. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/hls__params_8h_source.html#l00037">37</a> of file <a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_params.h</a>.</p>
</div>
</div>
<a id="adc19a9eebbfe20c3f9fe03dd452e4b1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc19a9eebbfe20c3f9fe03dd452e4b1b">&#9670;&nbsp;</a></span>time_shift_buffer_depth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double shaka::HlsParams::time_shift_buffer_depth = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines the live window, or the guaranteed duration of the time shifting buffer for 'live' playlists. </p>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/hls__params_8h_source.html#l00033">33</a> of file <a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_params.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>packager/hls/public/<a class="el" href="../../d6/d47/hls__params_8h_source.html">hls_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:44 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>