<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libguac: guacamole/audio.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  <span id="projectnumber">1.3.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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.h</div> </div> </div><!--header--> <div class="contents"> <a href="audio_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <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> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <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> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <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> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef __GUAC_AUDIO_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define __GUAC_AUDIO_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="audio-fntypes_8h.html">audio-fntypes.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="audio-types_8h.html">audio-types.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="client-types_8h.html">client-types.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="stream-types_8h.html">stream-types.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html"> 35</a></span> <span class="keyword">struct </span><a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a51b8bfeae3709c1859710cbf1039e01b"> 41</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structguac__audio__encoder.html#a51b8bfeae3709c1859710cbf1039e01b">mimetype</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a43d161556d3d55031ea486cc8b4ce3f6"> 46</a></span>  <a class="code" href="audio-fntypes_8h.html#a0b14abed1928c4e00129c7b87e391816">guac_audio_encoder_begin_handler</a>* <a class="code" href="structguac__audio__encoder.html#a43d161556d3d55031ea486cc8b4ce3f6">begin_handler</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a1b74c3dd402b0a6afa5f5b9000d02c74"> 52</a></span>  <a class="code" href="audio-fntypes_8h.html#a57fe16e56c1c115b2321e50b9d9ce11a">guac_audio_encoder_write_handler</a>* <a class="code" href="structguac__audio__encoder.html#a1b74c3dd402b0a6afa5f5b9000d02c74">write_handler</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#aef4ad4f1c298ac8e11fa69f13347c5a0"> 57</a></span>  <a class="code" href="audio-fntypes_8h.html#a8736cc2b634df9c222cf09dcc6507162">guac_audio_encoder_flush_handler</a>* <a class="code" href="structguac__audio__encoder.html#aef4ad4f1c298ac8e11fa69f13347c5a0">flush_handler</a>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a6fbc4f8efe14c9a119fdfaaef78f7e92"> 62</a></span>  <a class="code" href="audio-fntypes_8h.html#aa29dc3999c06e82c20d7a5e5d1e1565d">guac_audio_encoder_end_handler</a>* <a class="code" href="structguac__audio__encoder.html#a6fbc4f8efe14c9a119fdfaaef78f7e92">end_handler</a>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#af2d0f6c14a6a30e4f91240865a680e5b"> 68</a></span>  <a class="code" href="audio-fntypes_8h.html#a9d1fac87cc2ee072112d9d65d43ae70e">guac_audio_encoder_join_handler</a>* <a class="code" href="structguac__audio__encoder.html#af2d0f6c14a6a30e4f91240865a680e5b">join_handler</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html"> 72</a></span> <span class="keyword">struct </span><a class="code" href="structguac__audio__stream.html">guac_audio_stream</a> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#af3b4811ba5a4f1a337d338777fe9049d"> 77</a></span>  <a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a>* <a class="code" href="structguac__audio__stream.html#af3b4811ba5a4f1a337d338777fe9049d">encoder</a>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a1771fa5ff88b8f5d4ca4cd5e77a1ffba"> 82</a></span>  <a class="code" href="structguac__client.html">guac_client</a>* <a class="code" href="structguac__audio__stream.html#a1771fa5ff88b8f5d4ca4cd5e77a1ffba">client</a>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a4d8f5cfc70ec54b97ba0c4eea596f894"> 87</a></span>  <a class="code" href="structguac__stream.html">guac_stream</a>* <a class="code" href="structguac__audio__stream.html#a4d8f5cfc70ec54b97ba0c4eea596f894">stream</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a6810293a6fa915e497d2dd1a643993d9"> 92</a></span>  <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a6810293a6fa915e497d2dd1a643993d9">rate</a>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#af9d1ad90194e24c2967e2f9f18de0ad6"> 98</a></span>  <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#af9d1ad90194e24c2967e2f9f18de0ad6">channels</a>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a1de1be8874fb844002b92ac1e3813866"> 104</a></span>  <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a1de1be8874fb844002b92ac1e3813866">bps</a>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a9ca03221b02d1206eb698f8ee936c4b7"> 109</a></span>  <span class="keywordtype">void</span>* <a class="code" href="structguac__audio__stream.html#a9ca03221b02d1206eb698f8ee936c4b7">data</a>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> };</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* <a class="code" href="audio_8h.html#afc1fc0133504e718edf4756fac5e9c30">guac_audio_stream_alloc</a>(<a class="code" href="structguac__client.html">guac_client</a>* client,</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a>* encoder, <span class="keywordtype">int</span> rate, <span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> bps);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keywordtype">void</span> <a class="code" href="audio_8h.html#a0bbd483b1bfe5eede15539a0aacfedad">guac_audio_stream_reset</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio,</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a>* encoder, <span class="keywordtype">int</span> rate, <span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> bps);</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="keywordtype">void</span> <a class="code" href="audio_8h.html#a2b8e2f05a19b137454832a5dbc6c3864">guac_audio_stream_add_user</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio, <a class="code" href="structguac__user.html">guac_user</a>* user);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="keywordtype">void</span> <a class="code" href="audio_8h.html#adcc872292b5ba6c39905610b2bccbf31">guac_audio_stream_free</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* stream);</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="keywordtype">void</span> <a class="code" href="audio_8h.html#a11bdfee60584106ba85d97a3f8273cc2">guac_audio_stream_write_pcm</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* stream,</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> length);</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="keywordtype">void</span> <a class="code" href="audio_8h.html#af75feccacea2b14ee946064cf623f143">guac_audio_stream_flush</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* stream);</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </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="structguac__audio__stream_html_a1de1be8874fb844002b92ac1e3813866"><div class="ttname"><a href="structguac__audio__stream.html#a1de1be8874fb844002b92ac1e3813866">guac_audio_stream::bps</a></div><div class="ttdeci">int bps</div><div class="ttdoc">The number of bits per sample per channel for PCM data.</div><div class="ttdef"><b>Definition:</b> audio.h:104</div></div> <div class="ttc" id="structguac__audio__encoder_html_aef4ad4f1c298ac8e11fa69f13347c5a0"><div class="ttname"><a href="structguac__audio__encoder.html#aef4ad4f1c298ac8e11fa69f13347c5a0">guac_audio_encoder::flush_handler</a></div><div class="ttdeci">guac_audio_encoder_flush_handler * flush_handler</div><div class="ttdoc">Handler which will be called when the audio stream is flushed.</div><div class="ttdef"><b>Definition:</b> audio.h:57</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="structguac__audio__stream_html_af3b4811ba5a4f1a337d338777fe9049d"><div class="ttname"><a href="structguac__audio__stream.html#af3b4811ba5a4f1a337d338777fe9049d">guac_audio_stream::encoder</a></div><div class="ttdeci">guac_audio_encoder * encoder</div><div class="ttdoc">Arbitrary codec encoder which will receive raw PCM data.</div><div class="ttdef"><b>Definition:</b> audio.h:77</div></div> <div class="ttc" id="structguac__audio__encoder_html_a43d161556d3d55031ea486cc8b4ce3f6"><div class="ttname"><a href="structguac__audio__encoder.html#a43d161556d3d55031ea486cc8b4ce3f6">guac_audio_encoder::begin_handler</a></div><div class="ttdeci">guac_audio_encoder_begin_handler * begin_handler</div><div class="ttdoc">Handler which will be called when the audio stream is first created.</div><div class="ttdef"><b>Definition:</b> audio.h:46</div></div> <div class="ttc" id="stream-types_8h_html"><div class="ttname"><a href="stream-types_8h.html">stream-types.h</a></div><div class="ttdoc">Type definitions related to Guacamole protocol streams.</div></div> <div class="ttc" id="audio_8h_html_a11bdfee60584106ba85d97a3f8273cc2"><div class="ttname"><a href="audio_8h.html#a11bdfee60584106ba85d97a3f8273cc2">guac_audio_stream_write_pcm</a></div><div class="ttdeci">void guac_audio_stream_write_pcm(guac_audio_stream *stream, const unsigned char *data, int length)</div><div class="ttdoc">Writes PCM data to the given audio stream.</div></div> <div class="ttc" id="client-types_8h_html"><div class="ttname"><a href="client-types_8h.html">client-types.h</a></div><div class="ttdoc">Type definitions related to the Guacamole client structure, guac_client.</div></div> <div class="ttc" id="audio-fntypes_8h_html"><div class="ttname"><a href="audio-fntypes_8h.html">audio-fntypes.h</a></div><div class="ttdoc">Function type definitions related to simple streaming audio.</div></div> <div class="ttc" id="structguac__audio__encoder_html_af2d0f6c14a6a30e4f91240865a680e5b"><div class="ttname"><a href="structguac__audio__encoder.html#af2d0f6c14a6a30e4f91240865a680e5b">guac_audio_encoder::join_handler</a></div><div class="ttdeci">guac_audio_encoder_join_handler * join_handler</div><div class="ttdoc">Handler which will be called when a new user joins the Guacamole connection associated with an audio ...</div><div class="ttdef"><b>Definition:</b> audio.h:68</div></div> <div class="ttc" id="audio_8h_html_a2b8e2f05a19b137454832a5dbc6c3864"><div class="ttname"><a href="audio_8h.html#a2b8e2f05a19b137454832a5dbc6c3864">guac_audio_stream_add_user</a></div><div class="ttdeci">void guac_audio_stream_add_user(guac_audio_stream *audio, guac_user *user)</div><div class="ttdoc">Notifies the given audio stream that a user has joined the connection.</div></div> <div class="ttc" id="structguac__audio__stream_html_a1771fa5ff88b8f5d4ca4cd5e77a1ffba"><div class="ttname"><a href="structguac__audio__stream.html#a1771fa5ff88b8f5d4ca4cd5e77a1ffba">guac_audio_stream::client</a></div><div class="ttdeci">guac_client * client</div><div class="ttdoc">The client associated with this audio stream.</div><div class="ttdef"><b>Definition:</b> audio.h:82</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:107</div></div> <div class="ttc" id="structguac__audio__encoder_html_a1b74c3dd402b0a6afa5f5b9000d02c74"><div class="ttname"><a href="structguac__audio__encoder.html#a1b74c3dd402b0a6afa5f5b9000d02c74">guac_audio_encoder::write_handler</a></div><div class="ttdeci">guac_audio_encoder_write_handler * write_handler</div><div class="ttdoc">Handler which will be called when PCM data is written to the audio stream for encoding.</div><div class="ttdef"><b>Definition:</b> audio.h:52</div></div> <div class="ttc" id="audio_8h_html_af75feccacea2b14ee946064cf623f143"><div class="ttname"><a href="audio_8h.html#af75feccacea2b14ee946064cf623f143">guac_audio_stream_flush</a></div><div class="ttdeci">void guac_audio_stream_flush(guac_audio_stream *stream)</div><div class="ttdoc">Flushes the underlying audio buffer, if any, ensuring that all audio previously written via guac_audi...</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="structguac__audio__stream_html_a4d8f5cfc70ec54b97ba0c4eea596f894"><div class="ttname"><a href="structguac__audio__stream.html#a4d8f5cfc70ec54b97ba0c4eea596f894">guac_audio_stream::stream</a></div><div class="ttdeci">guac_stream * stream</div><div class="ttdoc">The actual stream associated with this audio stream.</div><div class="ttdef"><b>Definition:</b> audio.h:87</div></div> <div class="ttc" id="audio_8h_html_adcc872292b5ba6c39905610b2bccbf31"><div class="ttname"><a href="audio_8h.html#adcc872292b5ba6c39905610b2bccbf31">guac_audio_stream_free</a></div><div class="ttdeci">void guac_audio_stream_free(guac_audio_stream *stream)</div><div class="ttdoc">Closes and frees the given audio stream.</div></div> <div class="ttc" id="structguac__audio__stream_html_a9ca03221b02d1206eb698f8ee936c4b7"><div class="ttname"><a href="structguac__audio__stream.html#a9ca03221b02d1206eb698f8ee936c4b7">guac_audio_stream::data</a></div><div class="ttdeci">void * data</div><div class="ttdoc">Encoder-specific state data.</div><div class="ttdef"><b>Definition:</b> audio.h:109</div></div> <div class="ttc" id="structguac__client_html"><div class="ttname"><a href="structguac__client.html">guac_client</a></div><div class="ttdoc">Guacamole proxy client.</div><div class="ttdef"><b>Definition:</b> client.h:46</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__encoder_html_a51b8bfeae3709c1859710cbf1039e01b"><div class="ttname"><a href="structguac__audio__encoder.html#a51b8bfeae3709c1859710cbf1039e01b">guac_audio_encoder::mimetype</a></div><div class="ttdeci">const char * mimetype</div><div class="ttdoc">The mimetype of the audio data encoded by this audio encoder.</div><div class="ttdef"><b>Definition:</b> audio.h:41</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_8h_html_afc1fc0133504e718edf4756fac5e9c30"><div class="ttname"><a href="audio_8h.html#afc1fc0133504e718edf4756fac5e9c30">guac_audio_stream_alloc</a></div><div class="ttdeci">guac_audio_stream * guac_audio_stream_alloc(guac_client *client, guac_audio_encoder *encoder, int rate, int channels, int bps)</div><div class="ttdoc">Allocates a new audio stream at the client level which encodes audio data using the given encoder.</div></div> <div class="ttc" id="audio_8h_html_a0bbd483b1bfe5eede15539a0aacfedad"><div class="ttname"><a href="audio_8h.html#a0bbd483b1bfe5eede15539a0aacfedad">guac_audio_stream_reset</a></div><div class="ttdeci">void guac_audio_stream_reset(guac_audio_stream *audio, guac_audio_encoder *encoder, int rate, int channels, int bps)</div><div class="ttdoc">Resets the given audio stream, switching to the given encoder, rate, channels, and bits per sample.</div></div> <div class="ttc" id="structguac__audio__stream_html_a6810293a6fa915e497d2dd1a643993d9"><div class="ttname"><a href="structguac__audio__stream.html#a6810293a6fa915e497d2dd1a643993d9">guac_audio_stream::rate</a></div><div class="ttdeci">int rate</div><div class="ttdoc">The number of samples per second of PCM data sent to this stream.</div><div class="ttdef"><b>Definition:</b> audio.h:92</div></div> <div class="ttc" id="structguac__audio__encoder_html"><div class="ttname"><a href="structguac__audio__encoder.html">guac_audio_encoder</a></div><div class="ttdoc">Arbitrary audio codec encoder.</div><div class="ttdef"><b>Definition:</b> audio.h:35</div></div> <div class="ttc" id="structguac__audio__encoder_html_a6fbc4f8efe14c9a119fdfaaef78f7e92"><div class="ttname"><a href="structguac__audio__encoder.html#a6fbc4f8efe14c9a119fdfaaef78f7e92">guac_audio_encoder::end_handler</a></div><div class="ttdeci">guac_audio_encoder_end_handler * end_handler</div><div class="ttdoc">Handler which will be called when the audio stream is closed.</div><div class="ttdef"><b>Definition:</b> audio.h:62</div></div> <div class="ttc" id="structguac__stream_html"><div class="ttname"><a href="structguac__stream.html">guac_stream</a></div><div class="ttdoc">Represents a single stream within the Guacamole protocol.</div><div class="ttdef"><b>Definition:</b> stream.h:32</div></div> <div class="ttc" id="structguac__audio__stream_html_af9d1ad90194e24c2967e2f9f18de0ad6"><div class="ttname"><a href="structguac__audio__stream.html#af9d1ad90194e24c2967e2f9f18de0ad6">guac_audio_stream::channels</a></div><div class="ttdeci">int channels</div><div class="ttdoc">The number of audio channels per sample of PCM data.</div><div class="ttdef"><b>Definition:</b> audio.h:98</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><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>