Google Git
Sign in
apache / guacamole-website / 7c7a9ac6679809c00ed92c542587763e1814c11c / . / doc / 0.9.13-incubating / libguac / audio-fntypes_8h.html
blob: 920cf0b245c74fe5006ed5ecc3958de20a7f3206 [file] [log] [blame]
<!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.11"/>
<title>libguac: guacamole/audio-fntypes.h File 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">libguac
&#160;<span id="projectnumber">0.9.13-incubating</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</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)">
</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_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">audio-fntypes.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Function type definitions related to simple streaming audio.
<a href="#details">More...</a></p>
<p><a href="audio-fntypes_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a0b14abed1928c4e00129c7b87e391816"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio-fntypes_8h.html#a0b14abed1928c4e00129c7b87e391816">guac_audio_encoder_begin_handler</a>(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td></tr>
<tr class="memdesc:a0b14abed1928c4e00129c7b87e391816"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler which is called when the audio stream is opened. <a href="#a0b14abed1928c4e00129c7b87e391816">More...</a><br /></td></tr>
<tr class="separator:a0b14abed1928c4e00129c7b87e391816"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8736cc2b634df9c222cf09dcc6507162"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio-fntypes_8h.html#a8736cc2b634df9c222cf09dcc6507162">guac_audio_encoder_flush_handler</a>(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td></tr>
<tr class="memdesc:a8736cc2b634df9c222cf09dcc6507162"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler which is called when the audio stream needs to be flushed. <a href="#a8736cc2b634df9c222cf09dcc6507162">More...</a><br /></td></tr>
<tr class="separator:a8736cc2b634df9c222cf09dcc6507162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa29dc3999c06e82c20d7a5e5d1e1565d"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio-fntypes_8h.html#aa29dc3999c06e82c20d7a5e5d1e1565d">guac_audio_encoder_end_handler</a>(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td></tr>
<tr class="memdesc:aa29dc3999c06e82c20d7a5e5d1e1565d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler which is called when the audio stream is closed. <a href="#aa29dc3999c06e82c20d7a5e5d1e1565d">More...</a><br /></td></tr>
<tr class="separator:aa29dc3999c06e82c20d7a5e5d1e1565d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d1fac87cc2ee072112d9d65d43ae70e"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio-fntypes_8h.html#a9d1fac87cc2ee072112d9d65d43ae70e">guac_audio_encoder_join_handler</a>(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio, <a class="el" href="structguac__user.html">guac_user</a> *user)</td></tr>
<tr class="memdesc:a9d1fac87cc2ee072112d9d65d43ae70e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler which is called when a new user has joined the Guacamole connection associated with the audio stream. <a href="#a9d1fac87cc2ee072112d9d65d43ae70e">More...</a><br /></td></tr>
<tr class="separator:a9d1fac87cc2ee072112d9d65d43ae70e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57fe16e56c1c115b2321e50b9d9ce11a"><td class="memItemLeft" align="right" valign="top">typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio-fntypes_8h.html#a57fe16e56c1c115b2321e50b9d9ce11a">guac_audio_encoder_write_handler</a>(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio, const unsigned char *pcm_data, int length)</td></tr>
<tr class="memdesc:a57fe16e56c1c115b2321e50b9d9ce11a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler which is called when PCM data is written to the audio stream. <a href="#a57fe16e56c1c115b2321e50b9d9ce11a">More...</a><br /></td></tr>
<tr class="separator:a57fe16e56c1c115b2321e50b9d9ce11a"><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>Function type definitions related to simple streaming audio. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a0b14abed1928c4e00129c7b87e391816"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void guac_audio_encoder_begin_handler(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler which is called when the audio stream is opened. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>The audio stream being opened. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa29dc3999c06e82c20d7a5e5d1e1565d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void guac_audio_encoder_end_handler(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler which is called when the audio stream is closed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>The audio stream being closed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8736cc2b634df9c222cf09dcc6507162"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void guac_audio_encoder_flush_handler(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler which is called when the audio stream needs to be flushed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>The audio stream being flushed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9d1fac87cc2ee072112d9d65d43ae70e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void guac_audio_encoder_join_handler(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio, <a class="el" href="structguac__user.html">guac_user</a> *user)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler which is called when a new user has joined the Guacamole connection associated with the audio stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>The audio stream associated with the Guacamole connection being joined.</td></tr>
<tr><td class="paramname">user</td><td>The user that joined the connection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a57fe16e56c1c115b2321e50b9d9ce11a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void guac_audio_encoder_write_handler(<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio, const unsigned char *pcm_data, int length)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler which is called when PCM data is written to the audio stream. </p>
<p>The format of the PCM data is dictated by the properties of the audio stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>The audio stream to which data is being written.</td></tr>
<tr><td class="paramname">pcm_data</td><td>A buffer containing the raw PCM data to be written.</td></tr>
<tr><td class="paramname">length</td><td>The number of bytes within the buffer that should be written to the audio stream. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
<!-- Google Analytics -->
<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75289145-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>