2017-09-20 02:35:05 +00:00
<!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.6" / >
< 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/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / 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 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.6 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "../../index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "../../namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li class = "current" > < a href = "../../annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "../../files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "../../search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "../../annotated.html" > < span > Class  List< / span > < / a > < / li >
< li > < a href = "../../classes.html" > < span > Class  Index< / span > < / a > < / li >
< li > < a href = "../../hierarchy.html" > < span > Class  Hierarchy< / span > < / a > < / li >
< li > < a href = "../../functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Classes< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Friends< / a > < / 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 > |
< 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 < < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > > < / 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 class = "anchor" id = "ae86324b838baa66dbab9a3d35352e200" > < / a >
std::string  < / 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" >   < / 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" >   < / td > < / tr >
< tr class = "memitem:a386c5e3717b5f982f72698abba09df2c" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:a08ce812991297de47354b99cdaec5415" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:af3e55c8970e8a7604ca79a98f4642872" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "af3e55c8970e8a7604ca79a98f4642872" > < / a >
std::string  < / 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" >   < / td > < td class = "mdescRight" > Specifies segment template. Can be empty. < br / > < / td > < / tr >
< tr class = "separator:af3e55c8970e8a7604ca79a98f4642872" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a025d9a9a1612654da2b0c99fe81378db" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:abbaf07b1faa84803478f89bc6dd8cb4a" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / 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" >   < / td > < / tr >
< tr class = "memitem:a5cc00f367691729460e0b75b8ec6c512" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / 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" >   < / td > < / tr >
< tr class = "memitem:a9bcce2ca86a33f41803f7a6417a2758c" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / 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" >   < / td > < / tr >
< tr class = "memitem:af2e3479d90070a03a801ecc5a3d35d7e" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:a92efcc01f52430f3d3ec030beb8c65c7" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:a25764b4ffa8cb0da3b88cc251928ad96" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / td > < / tr >
< tr class = "memitem:aa0d36cf55c46def14bc2fa6c293859ef" > < td class = "memItemLeft" align = "right" valign = "top" > std::string  < / 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" >   < / 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00067" > 67< / 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 class = "anchor" id = "a9bcce2ca86a33f41803f7a6417a2758c" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00094" > 94< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a25764b4ffa8cb0da3b88cc251928ad96" > < / a >
< 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 > 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 class = "anchor" id = "a92efcc01f52430f3d3ec030beb8c65c7" > < / a >
< 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 > 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 class = "anchor" id = "aa0d36cf55c46def14bc2fa6c293859ef" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00107" > 107< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "af2e3479d90070a03a801ecc5a3d35d7e" > < / a >
< 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 > 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 >
< a class = "anchor" id = "a08ce812991297de47354b99cdaec5415" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00077" > 77< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a025d9a9a1612654da2b0c99fe81378db" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00083" > 83< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "abbaf07b1faa84803478f89bc6dd8cb4a" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00086" > 86< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a386c5e3717b5f982f72698abba09df2c" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00073" > 73< / a > of file < a class = "el" href = "../../dd/db5/packager_8h_source.html" > packager.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a5cc00f367691729460e0b75b8ec6c512" > < / a >
< 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 > Definition at line < a class = "el" href = "../../dd/db5/packager_8h_source.html#l00090" > 90< / 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 >
2017-09-20 03:22:56 +00:00
Generated on Tue Sep 19 2017 20:22:06 for Shaka Packager SDK by   < a href = "http://www.doxygen.org/index.html" >
2017-09-20 02:35:05 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
