| <!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" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.6"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>libguac: guac_recording Struct 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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">libguac<span id="projectnumber"> 1.5.3</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.6 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Data Fields</a> </div> |
| <div class="headertitle"><div class="title">guac_recording Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An in-progress session recording, attached to a <a class="el" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> instance such that output Guacamole instructions may be dynamically intercepted and written to a file. |
| <a href="structguac__recording.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="recording_8h_source.html">recording.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:af247a939054d3e1da051688e32beebe1"><td class="memItemLeft" align="right" valign="top"><a id="af247a939054d3e1da051688e32beebe1" name="af247a939054d3e1da051688e32beebe1"></a> |
| <a class="el" href="structguac__socket.html">guac_socket</a> * </td><td class="memItemRight" valign="bottom"><b>socket</b></td></tr> |
| <tr class="memdesc:af247a939054d3e1da051688e32beebe1"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="structguac__socket.html" title="The core I/O object of Guacamole.">guac_socket</a> which writes directly to the recording file, rather than to any particular user. <br /></td></tr> |
| <tr class="separator:af247a939054d3e1da051688e32beebe1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3efc682b40d7989c8e80e9bd7fa73b80"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__recording.html#a3efc682b40d7989c8e80e9bd7fa73b80">include_output</a></td></tr> |
| <tr class="memdesc:a3efc682b40d7989c8e80e9bd7fa73b80"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if output which is broadcast to each connected client (graphics, streams, etc.) should be included in the session recording, zero otherwise. <br /></td></tr> |
| <tr class="separator:a3efc682b40d7989c8e80e9bd7fa73b80"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a023a7adb2305f0dd1e4e3f12ad37d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__recording.html#a3a023a7adb2305f0dd1e4e3f12ad37d6">include_mouse</a></td></tr> |
| <tr class="memdesc:a3a023a7adb2305f0dd1e4e3f12ad37d6"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if changes to mouse state, such as position and buttons pressed or released, should be included in the session recording, zero otherwise. <br /></td></tr> |
| <tr class="separator:a3a023a7adb2305f0dd1e4e3f12ad37d6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3189271cc506aae3d0980e7b2a580f23"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__recording.html#a3189271cc506aae3d0980e7b2a580f23">include_touch</a></td></tr> |
| <tr class="memdesc:a3189271cc506aae3d0980e7b2a580f23"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if multi-touch events should be included in the session recording, zero otherwise. <br /></td></tr> |
| <tr class="separator:a3189271cc506aae3d0980e7b2a580f23"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abe405bddf126b78899464171f838cf35"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__recording.html#abe405bddf126b78899464171f838cf35">include_keys</a></td></tr> |
| <tr class="memdesc:abe405bddf126b78899464171f838cf35"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if keys pressed and released should be included in the session recording, zero otherwise. <br /></td></tr> |
| <tr class="separator:abe405bddf126b78899464171f838cf35"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An in-progress session recording, attached to a <a class="el" href="structguac__client.html" title="Guacamole proxy client.">guac_client</a> instance such that output Guacamole instructions may be dynamically intercepted and written to a file. </p> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="abe405bddf126b78899464171f838cf35" name="abe405bddf126b78899464171f838cf35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abe405bddf126b78899464171f838cf35">◆ </a></span>include_keys</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_recording::include_keys</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Non-zero if keys pressed and released should be included in the session recording, zero otherwise. </p> |
| <p>Including key events within the recording may be necessary in certain auditing contexts, but should only be done with caution. Key events can easily contain sensitive information, such as passwords, credit card numbers, etc. </p> |
| |
| </div> |
| </div> |
| <a id="a3a023a7adb2305f0dd1e4e3f12ad37d6" name="a3a023a7adb2305f0dd1e4e3f12ad37d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3a023a7adb2305f0dd1e4e3f12ad37d6">◆ </a></span>include_mouse</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_recording::include_mouse</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Non-zero if changes to mouse state, such as position and buttons pressed or released, should be included in the session recording, zero otherwise. </p> |
| <p>Including mouse state is necessary for the mouse cursor to be rendered in any resulting video. </p> |
| |
| </div> |
| </div> |
| <a id="a3efc682b40d7989c8e80e9bd7fa73b80" name="a3efc682b40d7989c8e80e9bd7fa73b80"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3efc682b40d7989c8e80e9bd7fa73b80">◆ </a></span>include_output</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_recording::include_output</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Non-zero if output which is broadcast to each connected client (graphics, streams, etc.) should be included in the session recording, zero otherwise. </p> |
| <p>Including output is necessary for any recording which must later be viewable as video. </p> |
| |
| </div> |
| </div> |
| <a id="a3189271cc506aae3d0980e7b2a580f23" name="a3189271cc506aae3d0980e7b2a580f23"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3189271cc506aae3d0980e7b2a580f23">◆ </a></span>include_touch</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_recording::include_touch</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Non-zero if multi-touch events should be included in the session recording, zero otherwise. </p> |
| <p>Depending on whether the remote desktop will automatically provide graphical feedback for touches, including touch events may be necessary for multi-touch interactions to be rendered in any resulting video. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>guacamole/<a class="el" href="recording_8h_source.html">recording.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 |
| </small></address> |
| </body> |
| </html> |
