blob: 44ef7f0dfcbf78ad898bc17f9adc64cab25936db [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.6"/>
<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/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">libguac
&#160;<span id="projectnumber">0.9.5</span>
</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&#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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</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="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>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2013 Glyptodon LLC</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef __GUAC_AUDIO_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __GUAC_AUDIO_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="audio-fntypes_8h.html">audio-fntypes.h</a>&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</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="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="client-types_8h.html">client-types.h</a>&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="stream-types_8h.html">stream-types.h</a>&quot;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html"> 38</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a51b8bfeae3709c1859710cbf1039e01b"> 44</a></span>&#160; <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="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a43d161556d3d55031ea486cc8b4ce3f6"> 49</a></span>&#160; <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="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a1b74c3dd402b0a6afa5f5b9000d02c74"> 54</a></span>&#160; <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="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structguac__audio__encoder.html#a6fbc4f8efe14c9a119fdfaaef78f7e92"> 59</a></span>&#160; <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="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html"> 63</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structguac__audio__stream.html">guac_audio_stream</a> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a7cfb92e31f72f1748aa0b3611ffdb0c8"> 68</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* <a class="code" href="structguac__audio__stream.html#a7cfb92e31f72f1748aa0b3611ffdb0c8">pcm_data</a>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#aa9580dff19ff2fd8bf3ac1069fdd8ca6"> 73</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#aa9580dff19ff2fd8bf3ac1069fdd8ca6">used</a>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#ae5d8ebcf53b63fc827654fe4c970ff2d"> 78</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#ae5d8ebcf53b63fc827654fe4c970ff2d">length</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a4b58881fe297d3ccac941225e4ff2dd0"> 83</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* <a class="code" href="structguac__audio__stream.html#a4b58881fe297d3ccac941225e4ff2dd0">encoded_data</a>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#ab0648dbc9e47b1d93939087acd0b5394"> 88</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#ab0648dbc9e47b1d93939087acd0b5394">encoded_data_used</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a91977a758f703f5b2a8e635f455a3407"> 93</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a91977a758f703f5b2a8e635f455a3407">encoded_data_length</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#af3b4811ba5a4f1a337d338777fe9049d"> 99</a></span>&#160; <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="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a1771fa5ff88b8f5d4ca4cd5e77a1ffba"> 104</a></span>&#160; <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="l00105"></a><span class="lineno"> 105</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a4d8f5cfc70ec54b97ba0c4eea596f894"> 109</a></span>&#160; <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="l00110"></a><span class="lineno"> 110</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a6810293a6fa915e497d2dd1a643993d9"> 114</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a6810293a6fa915e497d2dd1a643993d9">rate</a>;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#af9d1ad90194e24c2967e2f9f18de0ad6"> 120</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#af9d1ad90194e24c2967e2f9f18de0ad6">channels</a>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a1de1be8874fb844002b92ac1e3813866"> 126</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a1de1be8874fb844002b92ac1e3813866">bps</a>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a3db3ad0af5385d4ea20daece3e4e6d05"> 131</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structguac__audio__stream.html#a3db3ad0af5385d4ea20daece3e4e6d05">pcm_bytes_written</a>;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="structguac__audio__stream.html#a9ca03221b02d1206eb698f8ee936c4b7"> 136</a></span>&#160; <span class="keywordtype">void</span>* <a class="code" href="structguac__audio__stream.html#a9ca03221b02d1206eb698f8ee936c4b7">data</a>;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;};</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* <a class="code" href="audio_8h.html#a097b06b494f3f919efd24cb7f7455c2a">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>&#160; <a class="code" href="structguac__audio__encoder.html">guac_audio_encoder</a>* encoder);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<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="l00163"></a><span class="lineno"> 163</span>&#160;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="keywordtype">void</span> <a class="code" href="audio_8h.html#a84459a128f62ec7be47a73fb0020dd36">guac_audio_stream_begin</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* stream, <span class="keywordtype">int</span> rate, <span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> bps);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="keywordtype">void</span> <a class="code" href="audio_8h.html#a84443c0608f328d4e3ab691c18b23f98">guac_audio_stream_end</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* stream);</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;<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="l00196"></a><span class="lineno"> 196</span>&#160; <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="l00197"></a><span class="lineno"> 197</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<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="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="keywordtype">void</span> <a class="code" href="audio_8h.html#ab118f5ff66054e8290b2e1ebf780e0c3">guac_audio_stream_write_encoded</a>(<a class="code" href="structguac__audio__stream.html">guac_audio_stream</a>* audio,</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <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="l00217"></a><span class="lineno"> 217</span>&#160;</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="audio_8h_html_ab118f5ff66054e8290b2e1ebf780e0c3"><div class="ttname"><a href="audio_8h.html#ab118f5ff66054e8290b2e1ebf780e0c3">guac_audio_stream_write_encoded</a></div><div class="ttdeci">void guac_audio_stream_write_encoded(guac_audio_stream *audio, const unsigned char *data, int length)</div><div class="ttdoc">Appends arbitrarily-encoded data to the encoded_data buffer within the given audio stream...</div></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:42</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:126</div></div>
<div class="ttc" id="structguac__audio__stream_html_ab0648dbc9e47b1d93939087acd0b5394"><div class="ttname"><a href="structguac__audio__stream.html#ab0648dbc9e47b1d93939087acd0b5394">guac_audio_stream::encoded_data_used</a></div><div class="ttdeci">int encoded_data_used</div><div class="ttdoc">Number of bytes in the encoded data buffer. </div><div class="ttdef"><b>Definition:</b> audio.h:88</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. </div><div class="ttdef"><b>Definition:</b> audio.h:99</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 opened. </div><div class="ttdef"><b>Definition:</b> audio.h:49</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="structguac__audio__stream_html_aa9580dff19ff2fd8bf3ac1069fdd8ca6"><div class="ttname"><a href="structguac__audio__stream.html#aa9580dff19ff2fd8bf3ac1069fdd8ca6">guac_audio_stream::used</a></div><div class="ttdeci">int used</div><div class="ttdoc">Number of bytes in buffer. </div><div class="ttdef"><b>Definition:</b> audio.h:73</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__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:104</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 the audio stream is flushed. </div><div class="ttdef"><b>Definition:</b> audio-fntypes.h:47</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 the audio stream is flushed. </div><div class="ttdef"><b>Definition:</b> audio.h:54</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 given audio stream. </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:109</div></div>
<div class="ttc" id="audio_8h_html_a84443c0608f328d4e3ab691c18b23f98"><div class="ttname"><a href="audio_8h.html#a84443c0608f328d4e3ab691c18b23f98">guac_audio_stream_end</a></div><div class="ttdeci">void guac_audio_stream_end(guac_audio_stream *stream)</div><div class="ttdoc">Ends the current audio packet, writing the finished packet as an audio instruction. </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">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:136</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:85</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:44</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:63</div></div>
<div class="ttc" id="structguac__audio__stream_html_a4b58881fe297d3ccac941225e4ff2dd0"><div class="ttname"><a href="structguac__audio__stream.html#a4b58881fe297d3ccac941225e4ff2dd0">guac_audio_stream::encoded_data</a></div><div class="ttdeci">unsigned char * encoded_data</div><div class="ttdoc">Encoded audio data buffer, as written by the encoder. </div><div class="ttdef"><b>Definition:</b> audio.h:83</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:114</div></div>
<div class="ttc" id="structguac__audio__stream_html_a91977a758f703f5b2a8e635f455a3407"><div class="ttname"><a href="structguac__audio__stream.html#a91977a758f703f5b2a8e635f455a3407">guac_audio_stream::encoded_data_length</a></div><div class="ttdeci">int encoded_data_length</div><div class="ttdoc">Maximum number of bytes in the encoded data buffer. </div><div class="ttdef"><b>Definition:</b> audio.h:93</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:38</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:59</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:35</div></div>
<div class="ttc" id="structguac__audio__stream_html_ae5d8ebcf53b63fc827654fe4c970ff2d"><div class="ttname"><a href="structguac__audio__stream.html#ae5d8ebcf53b63fc827654fe4c970ff2d">guac_audio_stream::length</a></div><div class="ttdeci">int length</div><div class="ttdoc">Maximum number of bytes in buffer. </div><div class="ttdef"><b>Definition:</b> audio.h:78</div></div>
<div class="ttc" id="audio_8h_html_a84459a128f62ec7be47a73fb0020dd36"><div class="ttname"><a href="audio_8h.html#a84459a128f62ec7be47a73fb0020dd36">guac_audio_stream_begin</a></div><div class="ttdeci">void guac_audio_stream_begin(guac_audio_stream *stream, int rate, int channels, int bps)</div><div class="ttdoc">Begins a new audio packet within the given audio stream. </div></div>
<div class="ttc" id="structguac__audio__stream_html_a7cfb92e31f72f1748aa0b3611ffdb0c8"><div class="ttname"><a href="structguac__audio__stream.html#a7cfb92e31f72f1748aa0b3611ffdb0c8">guac_audio_stream::pcm_data</a></div><div class="ttdeci">unsigned char * pcm_data</div><div class="ttdoc">PCM data buffer, 16-bit samples, 2-channel, 44100 Hz. </div><div class="ttdef"><b>Definition:</b> audio.h:68</div></div>
<div class="ttc" id="audio_8h_html_a097b06b494f3f919efd24cb7f7455c2a"><div class="ttname"><a href="audio_8h.html#a097b06b494f3f919efd24cb7f7455c2a">guac_audio_stream_alloc</a></div><div class="ttdeci">guac_audio_stream * guac_audio_stream_alloc(guac_client *client, guac_audio_encoder *encoder)</div><div class="ttdoc">Allocates a new audio stream which encodes audio data using the given encoder. </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:120</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:37</div></div>
<div class="ttc" id="structguac__audio__stream_html_a3db3ad0af5385d4ea20daece3e4e6d05"><div class="ttname"><a href="structguac__audio__stream.html#a3db3ad0af5385d4ea20daece3e4e6d05">guac_audio_stream::pcm_bytes_written</a></div><div class="ttdeci">int pcm_bytes_written</div><div class="ttdoc">The number of PCM bytes written since the audio chunk began. </div><div class="ttdef"><b>Definition:</b> audio.h:131</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Feb 16 2015 17:43:59 for libguac by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</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>
<!-- End Google Analytics -->
</body>
</html>