blob: 5ae522f23afbe9151dd1b1b9bdf7a2db14b1982e [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"/>
<title>libguac: guac_client_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/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.8.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">guac_client_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__client__info.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aed4ddf74fa55fe039f38225c3373f25b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client__info.html#aed4ddf74fa55fe039f38225c3373f25b">optimal_width</a></td></tr>
<tr class="memdesc:aed4ddf74fa55fe039f38225c3373f25b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of pixels the remote client requests for the display width. <a href="#aed4ddf74fa55fe039f38225c3373f25b"></a><br/></td></tr>
<tr class="memitem:a58c3084b5e6b40ad43956562764d8732"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client__info.html#a58c3084b5e6b40ad43956562764d8732">optimal_height</a></td></tr>
<tr class="memdesc:a58c3084b5e6b40ad43956562764d8732"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of pixels the remote client requests for the display height. <a href="#a58c3084b5e6b40ad43956562764d8732"></a><br/></td></tr>
<tr class="memitem:a662fb7d39af7bddcb2f5c83a6b54f923"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client__info.html#a662fb7d39af7bddcb2f5c83a6b54f923">audio_mimetypes</a></td></tr>
<tr class="memdesc:a662fb7d39af7bddcb2f5c83a6b54f923"><td class="mdescLeft">&#160;</td><td class="mdescRight">NULL-terminated array of client-supported audio mimetypes. <a href="#a662fb7d39af7bddcb2f5c83a6b54f923"></a><br/></td></tr>
<tr class="memitem:a8b5c9d593d6a6a5deaeadbe2973b9fe8"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structguac__client__info.html#a8b5c9d593d6a6a5deaeadbe2973b9fe8">video_mimetypes</a></td></tr>
<tr class="memdesc:a8b5c9d593d6a6a5deaeadbe2973b9fe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">NULL-terminated array of client-supported video mimetypes. <a href="#a8b5c9d593d6a6a5deaeadbe2973b9fe8"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>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>Field Documentation</h2>
<a class="anchor" id="a662fb7d39af7bddcb2f5c83a6b54f923"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** guac_client_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 class="anchor" id="a58c3084b5e6b40ad43956562764d8732"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_client_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 class="anchor" id="aed4ddf74fa55fe039f38225c3373f25b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guac_client_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 class="anchor" id="a8b5c9d593d6a6a5deaeadbe2973b9fe8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char** guac_client_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="client_8h_source.html">client.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 23 2014 12:01:41 for libguac by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</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>