shaka-packager/docs/d2/d7b/structshaka_1_1StreamDescri...

334 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::StreamDescriptor 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="../../d2/d7b/structshaka_1_1StreamDescriptor.html">StreamDescriptor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d6/df8/structshaka_1_1StreamDescriptor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::StreamDescriptor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Defines a single input/output stream.
<a href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../dd/db5/packager_8h_source.html">packager.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:ae86324b838baa66dbab9a3d35352e200"><td class="memItemLeft" align="right" valign="top"><a id="ae86324b838baa66dbab9a3d35352e200"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#ae86324b838baa66dbab9a3d35352e200">input</a></td></tr>
<tr class="memdesc:ae86324b838baa66dbab9a3d35352e200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input/source media file path or network stream URL. Required. <br /></td></tr>
<tr class="separator:ae86324b838baa66dbab9a3d35352e200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386c5e3717b5f982f72698abba09df2c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a386c5e3717b5f982f72698abba09df2c">stream_selector</a></td></tr>
<tr class="separator:a386c5e3717b5f982f72698abba09df2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ce812991297de47354b99cdaec5415"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a08ce812991297de47354b99cdaec5415">output</a></td></tr>
<tr class="separator:a08ce812991297de47354b99cdaec5415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3e55c8970e8a7604ca79a98f4642872"><td class="memItemLeft" align="right" valign="top"><a id="af3e55c8970e8a7604ca79a98f4642872"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#af3e55c8970e8a7604ca79a98f4642872">segment_template</a></td></tr>
<tr class="memdesc:af3e55c8970e8a7604ca79a98f4642872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies segment template. Can be empty. <br /></td></tr>
<tr class="separator:af3e55c8970e8a7604ca79a98f4642872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a025d9a9a1612654da2b0c99fe81378db"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a025d9a9a1612654da2b0c99fe81378db">output_format</a></td></tr>
<tr class="separator:a025d9a9a1612654da2b0c99fe81378db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbaf07b1faa84803478f89bc6dd8cb4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#abbaf07b1faa84803478f89bc6dd8cb4a">skip_encryption</a> = false</td></tr>
<tr class="separator:abbaf07b1faa84803478f89bc6dd8cb4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2a517450433cf69bbc87cef17d05cf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a8f2a517450433cf69bbc87cef17d05cf">drm_label</a></td></tr>
<tr class="separator:a8f2a517450433cf69bbc87cef17d05cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc00f367691729460e0b75b8ec6c512"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a5cc00f367691729460e0b75b8ec6c512">trick_play_factor</a> = 0</td></tr>
<tr class="separator:a5cc00f367691729460e0b75b8ec6c512"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bcce2ca86a33f41803f7a6417a2758c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a9bcce2ca86a33f41803f7a6417a2758c">bandwidth</a> = 0</td></tr>
<tr class="separator:a9bcce2ca86a33f41803f7a6417a2758c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2e3479d90070a03a801ecc5a3d35d7e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#af2e3479d90070a03a801ecc5a3d35d7e">language</a></td></tr>
<tr class="separator:af2e3479d90070a03a801ecc5a3d35d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92efcc01f52430f3d3ec030beb8c65c7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a92efcc01f52430f3d3ec030beb8c65c7">hls_name</a></td></tr>
<tr class="separator:a92efcc01f52430f3d3ec030beb8c65c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25764b4ffa8cb0da3b88cc251928ad96"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a25764b4ffa8cb0da3b88cc251928ad96">hls_group_id</a></td></tr>
<tr class="separator:a25764b4ffa8cb0da3b88cc251928ad96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0d36cf55c46def14bc2fa6c293859ef"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#aa0d36cf55c46def14bc2fa6c293859ef">hls_playlist_name</a></td></tr>
<tr class="separator:aa0d36cf55c46def14bc2fa6c293859ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05f0489a76ea049bc8c9f144b4189591"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a05f0489a76ea049bc8c9f144b4189591">hls_iframe_playlist_name</a></td></tr>
<tr class="separator:a05f0489a76ea049bc8c9f144b4189591"><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>Defines a single input/output stream. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00069">69</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a9bcce2ca86a33f41803f7a6417a2758c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bcce2ca86a33f41803f7a6417a2758c">&#9670;&nbsp;</a></span>bandwidth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::StreamDescriptor::bandwidth = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional user-specified content bit rate for the stream, in bits/sec. If specified, this value is propagated to the <code>$Bandwidth$</code> template parameter for segment names. If not specified, its value may be estimated. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00101">101</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a8f2a517450433cf69bbc87cef17d05cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f2a517450433cf69bbc87cef17d05cf">&#9670;&nbsp;</a></span>drm_label</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::drm_label</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies a custom DRM stream label, which can be a DRM label defined by the DRM system. Typically values include AUDIO, SD, HD, UHD1, UHD2. If not provided, the DRM stream label is derived from stream type (video, audio), resolutions etc. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00093">93</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a25764b4ffa8cb0da3b88cc251928ad96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25764b4ffa8cb0da3b88cc251928ad96">&#9670;&nbsp;</a></span>hls_group_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::hls_group_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Required for audio when outputting HLS. It defines the group ID for the output stream. This is used as the GROUP-ID attribute for EXT-X-MEDIA. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00111">111</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a05f0489a76ea049bc8c9f144b4189591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05f0489a76ea049bc8c9f144b4189591">&#9670;&nbsp;</a></span>hls_iframe_playlist_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::hls_iframe_playlist_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional for HLS output. It defines the name of the I-Frames only playlist for the stream. For Video only. Usually ends with <code>.m3u8</code>. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00117">117</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a92efcc01f52430f3d3ec030beb8c65c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92efcc01f52430f3d3ec030beb8c65c7">&#9670;&nbsp;</a></span>hls_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::hls_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Required for audio when outputting HLS. It defines the name of the output stream, which is not necessarily the same as output. This is used as the <code>NAME</code> attribute for EXT-X-MEDIA. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00108">108</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="aa0d36cf55c46def14bc2fa6c293859ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0d36cf55c46def14bc2fa6c293859ef">&#9670;&nbsp;</a></span>hls_playlist_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::hls_playlist_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Required for HLS output. It defines the name of the playlist for the stream. Usually ends with <code>.m3u8</code>. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00114">114</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="af2e3479d90070a03a801ecc5a3d35d7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2e3479d90070a03a801ecc5a3d35d7e">&#9670;&nbsp;</a></span>language</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::language</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional value which contains a user-specified language tag. If specified, this value overrides any language metadata in the input stream. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00104">104</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a08ce812991297de47354b99cdaec5415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ce812991297de47354b99cdaec5415">&#9670;&nbsp;</a></span>output</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::output</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies output file path or init segment path (if segment template is specified). Can be empty for self initialization media segments. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00079">79</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a025d9a9a1612654da2b0c99fe81378db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a025d9a9a1612654da2b0c99fe81378db">&#9670;&nbsp;</a></span>output_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::output_format</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional value which specifies output container format, e.g. "mp4". If not specified, will detect from output / segment template name. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00085">85</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="abbaf07b1faa84803478f89bc6dd8cb4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbaf07b1faa84803478f89bc6dd8cb4a">&#9670;&nbsp;</a></span>skip_encryption</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::StreamDescriptor::skip_encryption = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>If set to true, the stream will not be encrypted. This is useful, e.g. to encrypt only video streams. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00088">88</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a386c5e3717b5f982f72698abba09df2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a386c5e3717b5f982f72698abba09df2c">&#9670;&nbsp;</a></span>stream_selector</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string shaka::StreamDescriptor::stream_selector</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stream selector, can be <code>audio</code>, <code>video</code>, <code>text</code> or a zero based stream index. Required. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00075">75</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<a id="a5cc00f367691729460e0b75b8ec6c512"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cc00f367691729460e0b75b8ec6c512">&#9670;&nbsp;</a></span>trick_play_factor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t shaka::StreamDescriptor::trick_play_factor = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>If set to a non-zero value, will generate a trick play / trick mode stream with frames sampled from the key frames in the original stream. <code>trick_play_factor</code> defines the sampling rate. </p>
<p class="definition">Definition at line <a class="el" href="../../dd/db5/packager_8h_source.html#l00097">97</a> of file <a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>packager/<a class="el" href="../../dd/db5/packager_8h_source.html">packager.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jun 7 2018 16:03:53 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>