blob: 09f325b95c09f36ca8855c4c64f774fa083c81d9 [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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libguac: guac_user_info 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libguac
&#160;<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&amp;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&amp;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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">guac_user_info Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Information exposed by the remote client during the connection handshake which can be used by a client plugin.
<a href="structguac__user__info.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a496d5f3d26a7db0a0490afa553126c66"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#a496d5f3d26a7db0a0490afa553126c66">optimal_width</a></td></tr>
<tr class="memdesc:a496d5f3d26a7db0a0490afa553126c66"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of pixels the remote client requests for the display width. <a href="#a496d5f3d26a7db0a0490afa553126c66">More...</a><br /></td></tr>
<tr class="separator:a496d5f3d26a7db0a0490afa553126c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a252079af642b62554566e8675dc43354"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#a252079af642b62554566e8675dc43354">optimal_height</a></td></tr>
<tr class="memdesc:a252079af642b62554566e8675dc43354"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of pixels the remote client requests for the display height. <a href="#a252079af642b62554566e8675dc43354">More...</a><br /></td></tr>
<tr class="separator:a252079af642b62554566e8675dc43354"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a043432620dafe7ba38fcd3550fdc7d27"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#a043432620dafe7ba38fcd3550fdc7d27">audio_mimetypes</a></td></tr>
<tr class="memdesc:a043432620dafe7ba38fcd3550fdc7d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">NULL-terminated array of client-supported audio mimetypes. <a href="#a043432620dafe7ba38fcd3550fdc7d27">More...</a><br /></td></tr>
<tr class="separator:a043432620dafe7ba38fcd3550fdc7d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace535bea6879596b6473657f3fc83b57"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#ace535bea6879596b6473657f3fc83b57">video_mimetypes</a></td></tr>
<tr class="memdesc:ace535bea6879596b6473657f3fc83b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">NULL-terminated array of client-supported video mimetypes. <a href="#ace535bea6879596b6473657f3fc83b57">More...</a><br /></td></tr>
<tr class="separator:ace535bea6879596b6473657f3fc83b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac05b09cce376e656f4e4baa19f888345"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#ac05b09cce376e656f4e4baa19f888345">image_mimetypes</a></td></tr>
<tr class="memdesc:ac05b09cce376e656f4e4baa19f888345"><td class="mdescLeft">&#160;</td><td class="mdescRight">NULL-terminated array of client-supported image mimetypes. <a href="#ac05b09cce376e656f4e4baa19f888345">More...</a><br /></td></tr>
<tr class="separator:ac05b09cce376e656f4e4baa19f888345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac19c08c0ef7441556be0afed6fb9c7c7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#ac19c08c0ef7441556be0afed6fb9c7c7">optimal_resolution</a></td></tr>
<tr class="memdesc:ac19c08c0ef7441556be0afed6fb9c7c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The DPI of the physical remote display if configured for the optimal width/height combination described here. <a href="#ac19c08c0ef7441556be0afed6fb9c7c7">More...</a><br /></td></tr>
<tr class="separator:ac19c08c0ef7441556be0afed6fb9c7c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c08990b6fd1e0627652a9c879ea2078"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__user__info.html#a2c08990b6fd1e0627652a9c879ea2078">timezone</a></td></tr>
<tr class="memdesc:a2c08990b6fd1e0627652a9c879ea2078"><td class="mdescLeft">&#160;</td><td class="mdescRight">The timezone of the remote system. <a href="#a2c08990b6fd1e0627652a9c879ea2078">More...</a><br /></td></tr>
<tr class="separator:a2c08990b6fd1e0627652a9c879ea2078"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information exposed by the remote client during the connection handshake which can be used by a client plugin. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a043432620dafe7ba38fcd3550fdc7d27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a043432620dafe7ba38fcd3550fdc7d27">&#9670;&nbsp;</a></span>audio_mimetypes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** guac_user_info::audio_mimetypes</td>
</tr>
</table>
</div><div class="memdoc">
<p>NULL-terminated array of client-supported audio mimetypes. </p>
<p>If the client does not support audio at all, this will be NULL. </p>
</div>
</div>
<a id="ac05b09cce376e656f4e4baa19f888345"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac05b09cce376e656f4e4baa19f888345">&#9670;&nbsp;</a></span>image_mimetypes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** guac_user_info::image_mimetypes</td>
</tr>
</table>
</div><div class="memdoc">
<p>NULL-terminated array of client-supported image mimetypes. </p>
<p>Though all supported image mimetypes will be listed here, it can be safely assumed that all clients will support at least "image/png" and "image/jpeg". </p>
</div>
</div>
<a id="a252079af642b62554566e8675dc43354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a252079af642b62554566e8675dc43354">&#9670;&nbsp;</a></span>optimal_height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_user_info::optimal_height</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of pixels the remote client requests for the display height. </p>
<p>This need not be honored by a client plugin implementation, but if the underlying protocol of the client plugin supports dynamic sizing of the screen, honoring the display size request is recommended. </p>
</div>
</div>
<a id="ac19c08c0ef7441556be0afed6fb9c7c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac19c08c0ef7441556be0afed6fb9c7c7">&#9670;&nbsp;</a></span>optimal_resolution</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_user_info::optimal_resolution</td>
</tr>
</table>
</div><div class="memdoc">
<p>The DPI of the physical remote display if configured for the optimal width/height combination described here. </p>
<p>This need not be honored by a client plugin implementation, but if the underlying protocol of the client plugin supports dynamic sizing of the screen, honoring the stated resolution of the display size request is recommended. </p>
</div>
</div>
<a id="a496d5f3d26a7db0a0490afa553126c66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a496d5f3d26a7db0a0490afa553126c66">&#9670;&nbsp;</a></span>optimal_width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_user_info::optimal_width</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of pixels the remote client requests for the display width. </p>
<p>This need not be honored by a client plugin implementation, but if the underlying protocol of the client plugin supports dynamic sizing of the screen, honoring the display size request is recommended. </p>
</div>
</div>
<a id="a2c08990b6fd1e0627652a9c879ea2078"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c08990b6fd1e0627652a9c879ea2078">&#9670;&nbsp;</a></span>timezone</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* guac_user_info::timezone</td>
</tr>
</table>
</div><div class="memdoc">
<p>The timezone of the remote system. </p>
<p>If the client does not provide a specific timezone then this will be NULL. The format of the timezone is the standard tzdata naming convention. </p>
</div>
</div>
<a id="ace535bea6879596b6473657f3fc83b57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace535bea6879596b6473657f3fc83b57">&#9670;&nbsp;</a></span>video_mimetypes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** guac_user_info::video_mimetypes</td>
</tr>
</table>
</div><div class="memdoc">
<p>NULL-terminated array of client-supported video mimetypes. </p>
<p>If the client does not support video at all, this will be NULL. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>guacamole/<a class="el" href="user_8h_source.html">user.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>