shaka-packager/docs/d9/da8/structshaka_1_1BufferCallba...

136 lines
8.1 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::BufferCallbackParams 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="../../d9/da8/structshaka_1_1BufferCallbackParams.html">BufferCallbackParams</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d2/d82/structshaka_1_1BufferCallbackParams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::BufferCallbackParams Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Buffer callback params.
<a href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html">buffer_callback_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:a6e6e97682ba2be686a2d1e9b62d26e13"><td class="memItemLeft" align="right" valign="top">std::function&lt; int64_t(const std::string &amp;name, void *buffer, uint64_t size)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#a6e6e97682ba2be686a2d1e9b62d26e13">read_func</a></td></tr>
<tr class="separator:a6e6e97682ba2be686a2d1e9b62d26e13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad966040c5a75389ac6376c6378a0f307"><td class="memItemLeft" align="right" valign="top">std::function&lt; int64_t(const std::string &amp;name, const void *buffer, uint64_t size)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#ad966040c5a75389ac6376c6378a0f307">write_func</a></td></tr>
<tr class="separator:ad966040c5a75389ac6376c6378a0f307"><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>Buffer callback params. </p>
<p class="definition">Definition at line <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html#l00015">15</a> of file <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html">buffer_callback_params.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a6e6e97682ba2be686a2d1e9b62d26e13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e6e97682ba2be686a2d1e9b62d26e13">&#9670;&nbsp;</a></span>read_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::function&lt;int64_t(const std::string&amp; name, void* buffer, uint64_t size)&gt; shaka::BufferCallbackParams::read_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>If this function is specified, packager treats <em><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#ae86324b838baa66dbab9a3d35352e200" title="Input/source media file path or network stream URL. Required. ">StreamDescriptor.input</a></em> as a label and call this function with <em>name</em> set to <em><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#ae86324b838baa66dbab9a3d35352e200" title="Input/source media file path or network stream URL. Required. ">StreamDescriptor.input</a></em>. </p>
<p class="definition">Definition at line <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html#l00020">20</a> of file <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html">buffer_callback_params.h</a>.</p>
</div>
</div>
<a id="ad966040c5a75389ac6376c6378a0f307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad966040c5a75389ac6376c6378a0f307">&#9670;&nbsp;</a></span>write_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::function&lt; int64_t(const std::string&amp; name, const void* buffer, uint64_t size)&gt; shaka::BufferCallbackParams::write_func</td>
</tr>
</table>
</div><div class="memdoc">
<p>If this function is specified, packager treats the output files specified in <a class="el" href="../../d5/de3/structshaka_1_1PackagingParams.html" title="Packaging parameters. ">PackagingParams</a> and StreamDescriptors as labels and calls this function with <em>name</em> set. This applies to <em>PackagingParams.MpdParams.mpd_output</em>, <em>PackagingParams.HlsParams.master_playlist_output</em>, <em><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#a08ce812991297de47354b99cdaec5415">StreamDescriptor.output</a></em>, <em><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#af3e55c8970e8a7604ca79a98f4642872" title="Specifies segment template. Can be empty. ">StreamDescriptor.segment_template</a></em>, <em><a class="el" href="../../d2/d7b/structshaka_1_1StreamDescriptor.html#aa0d36cf55c46def14bc2fa6c293859ef">StreamDescriptor.hls_playlist_name</a></em>. </p>
<p class="definition">Definition at line <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html#l00030">30</a> of file <a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html">buffer_callback_params.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>packager/file/public/<a class="el" href="../../dc/da3/buffer__callback__params_8h_source.html">buffer_callback_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>