| <!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.9.1"/> |
| <title>libguac: guacamole/audio.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 style="padding-left: 0.5em;"> |
| <div id="projectname">libguac |
|  <span id="projectnumber">0.9.7</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.9.1 --> |
| <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 Page</span></a></li> |
| <li><a href="annotated.html"><span>Data 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 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="#nested-classes">Data Structures</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">audio.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Provides functions and structures used for providing simple streaming audio. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="audio_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="nested-classes"></a> |
| Data Structures</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__audio__encoder.html">guac_audio_encoder</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Arbitrary audio codec encoder. <a href="structguac__audio__encoder.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic audio stream. <a href="structguac__audio__stream.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a097b06b494f3f919efd24cb7f7455c2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a097b06b494f3f919efd24cb7f7455c2a">guac_audio_stream_alloc</a> (<a class="el" href="structguac__client.html">guac_client</a> *client, <a class="el" href="structguac__audio__encoder.html">guac_audio_encoder</a> *encoder)</td></tr> |
| <tr class="memdesc:a097b06b494f3f919efd24cb7f7455c2a"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new audio stream which encodes audio data using the given encoder. <a href="#a097b06b494f3f919efd24cb7f7455c2a">More...</a><br /></td></tr> |
| <tr class="separator:a097b06b494f3f919efd24cb7f7455c2a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adcc872292b5ba6c39905610b2bccbf31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#adcc872292b5ba6c39905610b2bccbf31">guac_audio_stream_free</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *stream)</td></tr> |
| <tr class="memdesc:adcc872292b5ba6c39905610b2bccbf31"><td class="mdescLeft"> </td><td class="mdescRight">Frees the given audio stream. <a href="#adcc872292b5ba6c39905610b2bccbf31">More...</a><br /></td></tr> |
| <tr class="separator:adcc872292b5ba6c39905610b2bccbf31"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84459a128f62ec7be47a73fb0020dd36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a84459a128f62ec7be47a73fb0020dd36">guac_audio_stream_begin</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *stream, int rate, int channels, int bps)</td></tr> |
| <tr class="memdesc:a84459a128f62ec7be47a73fb0020dd36"><td class="mdescLeft"> </td><td class="mdescRight">Begins a new audio packet within the given audio stream. <a href="#a84459a128f62ec7be47a73fb0020dd36">More...</a><br /></td></tr> |
| <tr class="separator:a84459a128f62ec7be47a73fb0020dd36"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84443c0608f328d4e3ab691c18b23f98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a84443c0608f328d4e3ab691c18b23f98">guac_audio_stream_end</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *stream)</td></tr> |
| <tr class="memdesc:a84443c0608f328d4e3ab691c18b23f98"><td class="mdescLeft"> </td><td class="mdescRight">Ends the current audio packet, writing the finished packet as an audio instruction. <a href="#a84443c0608f328d4e3ab691c18b23f98">More...</a><br /></td></tr> |
| <tr class="separator:a84443c0608f328d4e3ab691c18b23f98"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11bdfee60584106ba85d97a3f8273cc2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a11bdfee60584106ba85d97a3f8273cc2">guac_audio_stream_write_pcm</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *stream, const unsigned char *data, int length)</td></tr> |
| <tr class="memdesc:a11bdfee60584106ba85d97a3f8273cc2"><td class="mdescLeft"> </td><td class="mdescRight">Writes PCM data to the given audio stream. <a href="#a11bdfee60584106ba85d97a3f8273cc2">More...</a><br /></td></tr> |
| <tr class="separator:a11bdfee60584106ba85d97a3f8273cc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af75feccacea2b14ee946064cf623f143"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#af75feccacea2b14ee946064cf623f143">guac_audio_stream_flush</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *stream)</td></tr> |
| <tr class="memdesc:af75feccacea2b14ee946064cf623f143"><td class="mdescLeft"> </td><td class="mdescRight">Flushes the given audio stream. <a href="#af75feccacea2b14ee946064cf623f143">More...</a><br /></td></tr> |
| <tr class="separator:af75feccacea2b14ee946064cf623f143"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab118f5ff66054e8290b2e1ebf780e0c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#ab118f5ff66054e8290b2e1ebf780e0c3">guac_audio_stream_write_encoded</a> (<a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> *audio, const unsigned char *data, int length)</td></tr> |
| <tr class="memdesc:ab118f5ff66054e8290b2e1ebf780e0c3"><td class="mdescLeft"> </td><td class="mdescRight">Appends arbitrarily-encoded data to the encoded_data buffer within the given audio stream. <a href="#ab118f5ff66054e8290b2e1ebf780e0c3">More...</a><br /></td></tr> |
| <tr class="separator:ab118f5ff66054e8290b2e1ebf780e0c3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Provides functions and structures used for providing simple streaming audio. </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a097b06b494f3f919efd24cb7f7455c2a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a>* guac_audio_stream_alloc </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__client.html">guac_client</a> * </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structguac__audio__encoder.html">guac_audio_encoder</a> * </td> |
| <td class="paramname"><em>encoder</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocates a new audio stream which encodes audio data using the given encoder. </p> |
| <p>If NULL is specified for the encoder, an appropriate encoder will be selected based on the encoders built into libguac and the level of client support.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>The <a class="el" href="structguac__client.html" title="Guacamole proxy client. ">guac_client</a> for which this audio stream is being allocated. </td></tr> |
| <tr><td class="paramname">encoder</td><td>The <a class="el" href="structguac__audio__encoder.html" title="Arbitrary audio codec encoder. ">guac_audio_encoder</a> to use when encoding audio, or NULL if libguac should select an appropriate built-in encoder on its own. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The newly allocated <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a>, or NULL if no audio stream could be allocated due to lack of client support. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a84459a128f62ec7be47a73fb0020dd36"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_begin </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>rate</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>channels</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>bps</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Begins a new audio packet within the given audio stream. </p> |
| <p>This packet will be built up with repeated writes of PCM data, finally being sent when complete via <a class="el" href="audio_8h.html#a84443c0608f328d4e3ab691c18b23f98" title="Ends the current audio packet, writing the finished packet as an audio instruction. ">guac_audio_stream_end()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> which should start a new audio packet. </td></tr> |
| <tr><td class="paramname">rate</td><td>The audio rate of the packet, in Hz. </td></tr> |
| <tr><td class="paramname">channels</td><td>The number of audio channels. </td></tr> |
| <tr><td class="paramname">bps</td><td>The number of bits per audio sample. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a84443c0608f328d4e3ab691c18b23f98"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_end </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Ends the current audio packet, writing the finished packet as an audio instruction. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> whose current audio packet should be completed and sent. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af75feccacea2b14ee946064cf623f143"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_flush </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Flushes the given audio stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> to flush. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adcc872292b5ba6c39905610b2bccbf31"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees the given audio stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> to free. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab118f5ff66054e8290b2e1ebf780e0c3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_write_encoded </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>audio</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const unsigned char * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Appends arbitrarily-encoded data to the encoded_data buffer within the given audio stream. </p> |
| <p>This data must be encoded in the output format of the encoder used by the stream. This function is mainly for use by encoder implementations.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">audio</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> to write data through. </td></tr> |
| <tr><td class="paramname">data</td><td>Arbitrary encoded data to write through the audio stream. </td></tr> |
| <tr><td class="paramname">length</td><td>The number of bytes of data provided. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a11bdfee60584106ba85d97a3f8273cc2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void guac_audio_stream_write_pcm </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structguac__audio__stream.html">guac_audio_stream</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const unsigned char * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Writes PCM data to the given audio stream. </p> |
| <p>This PCM data will be automatically encoded by the audio encoder associated with this stream. This function must only be called after an audio packet has been started with <a class="el" href="audio_8h.html#a84459a128f62ec7be47a73fb0020dd36" title="Begins a new audio packet within the given audio stream. ">guac_audio_stream_begin()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The <a class="el" href="structguac__audio__stream.html" title="Basic audio stream. ">guac_audio_stream</a> to write PCM data through. </td></tr> |
| <tr><td class="paramname">data</td><td>The PCM data to write. </td></tr> |
| <tr><td class="paramname">length</td><td>The number of bytes of PCM data provided. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Jun 10 2015 21:39:32 for libguac by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.9.1 |
| </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> |
