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