blob: 5263a9e2357ec076bd4450f4c76d0ba79ff46fc7 [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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libguac: guacamole/audio-fntypes.h Source File</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">libguac
&#160;<span id="projectnumber">1.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">audio-fntypes.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="audio-fntypes_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef GUAC_AUDIO_FNTYPES_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define GUAC_AUDIO_FNTYPES_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="audio-types_8h.html">audio-types.h</a>&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="user-types_8h.html">user-types.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="audio-fntypes_8h.html#a0b14abed1928c4e00129c7b87e391816"> 38</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="audio-fntypes_8h.html#a0b14abed1928c4e00129c7b87e391816">guac_audio_encoder_begin_handler</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="audio-fntypes_8h.html#a8736cc2b634df9c222cf09dcc6507162"> 46</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="audio-fntypes_8h.html#a8736cc2b634df9c222cf09dcc6507162">guac_audio_encoder_flush_handler</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="audio-fntypes_8h.html#aa29dc3999c06e82c20d7a5e5d1e1565d"> 54</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="audio-fntypes_8h.html#aa29dc3999c06e82c20d7a5e5d1e1565d">guac_audio_encoder_end_handler</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="audio-fntypes_8h.html#a9d1fac87cc2ee072112d9d65d43ae70e"> 67</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="audio-fntypes_8h.html#a9d1fac87cc2ee072112d9d65d43ae70e">guac_audio_encoder_join_handler</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="structguac__user.html">guac_user</a>* user);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="audio-fntypes_8h.html#a57fe16e56c1c115b2321e50b9d9ce11a"> 84</a></span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="audio-fntypes_8h.html#a57fe16e56c1c115b2321e50b9d9ce11a">guac_audio_encoder_write_handler</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio,</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pcm_data, <span class="keywordtype">int</span> length);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="ttc" id="audio-fntypes_8h_html_aa29dc3999c06e82c20d7a5e5d1e1565d"><div class="ttname"><a href="audio-fntypes_8h.html#aa29dc3999c06e82c20d7a5e5d1e1565d">guac_audio_encoder_end_handler</a></div><div class="ttdeci">void guac_audio_encoder_end_handler(guac_audio_stream *audio)</div><div class="ttdoc">Handler which is called when the audio stream is closed. </div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:54</div></div>
<div class="ttc" id="audio-fntypes_8h_html_a8736cc2b634df9c222cf09dcc6507162"><div class="ttname"><a href="audio-fntypes_8h.html#a8736cc2b634df9c222cf09dcc6507162">guac_audio_encoder_flush_handler</a></div><div class="ttdeci">void guac_audio_encoder_flush_handler(guac_audio_stream *audio)</div><div class="ttdoc">Handler which is called when the audio stream needs to be flushed. </div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:46</div></div>
<div class="ttc" id="audio-fntypes_8h_html_a57fe16e56c1c115b2321e50b9d9ce11a"><div class="ttname"><a href="audio-fntypes_8h.html#a57fe16e56c1c115b2321e50b9d9ce11a">guac_audio_encoder_write_handler</a></div><div class="ttdeci">void guac_audio_encoder_write_handler(guac_audio_stream *audio, const unsigned char *pcm_data, int length)</div><div class="ttdoc">Handler which is called when PCM data is written to the audio stream. </div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:84</div></div>
<div class="ttc" id="structguac__user_html"><div class="ttname"><a href="structguac__user.html">guac_user</a></div><div class="ttdoc">Representation of a physical connection within a larger logical connection which may be shared...</div><div class="ttdef"><b>Definition:</b> user.h:101</div></div>
<div class="ttc" id="audio-fntypes_8h_html_a9d1fac87cc2ee072112d9d65d43ae70e"><div class="ttname"><a href="audio-fntypes_8h.html#a9d1fac87cc2ee072112d9d65d43ae70e">guac_audio_encoder_join_handler</a></div><div class="ttdeci">void guac_audio_encoder_join_handler(guac_audio_stream *audio, guac_user *user)</div><div class="ttdoc">Handler which is called when a new user has joined the Guacamole connection associated with the audio...</div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:67</div></div>
<div class="ttc" id="audio-types_8h_html"><div class="ttname"><a href="audio-types_8h.html">audio-types.h</a></div><div class="ttdoc">Type definitions related to simple streaming audio. </div></div>
<div class="ttc" id="structguac__audio__stream_html"><div class="ttname"><a href="structguac__audio__stream.html">guac_audio_stream</a></div><div class="ttdoc">Basic audio stream. </div><div class="ttdef"><b>Definition:</b> audio.h:72</div></div>
<div class="ttc" id="audio-fntypes_8h_html_a0b14abed1928c4e00129c7b87e391816"><div class="ttname"><a href="audio-fntypes_8h.html#a0b14abed1928c4e00129c7b87e391816">guac_audio_encoder_begin_handler</a></div><div class="ttdeci">void guac_audio_encoder_begin_handler(guac_audio_stream *audio)</div><div class="ttdoc">Handler which is called when the audio stream is opened. </div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:38</div></div>
<div class="ttc" id="user-types_8h_html"><div class="ttname"><a href="user-types_8h.html">user-types.h</a></div><div class="ttdoc">Type definitions related to the guac_user object. </div></div>
</div><!-- fragment --></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.14
</small></address>
</body>
</html>