Information exposed by the remote client during the connection handshake which can be used by a client plugin. More...

Data Fields
int	optimal_width
	The number of pixels the remote client requests for the display width.

int	optimal_height
	The number of pixels the remote client requests for the display height.

const char **	audio_mimetypes
	NULL-terminated array of client-supported audio mimetypes.

const char **	video_mimetypes
	NULL-terminated array of client-supported video mimetypes.

const char **	image_mimetypes
	NULL-terminated array of client-supported image mimetypes.

int	optimal_resolution
	The DPI of the physical remote display if configured for the optimal width/height combination described here.

const char *	timezone
	The timezone of the remote system.

guac_protocol_version	protocol_version
	The Guacamole protocol version that the remote system supports, allowing for feature support to be negotiated between client and server.

const char *	name
	The human-readable name of the Guacamole user, supplied by the client during the handshake.

Detailed Description

Information exposed by the remote client during the connection handshake which can be used by a client plugin.

Field Documentation

◆ audio_mimetypes

const char** guac_user_info::audio_mimetypes

NULL-terminated array of client-supported audio mimetypes.

If the client does not support audio at all, this will be NULL.

◆ image_mimetypes

const char** guac_user_info::image_mimetypes

NULL-terminated array of client-supported image mimetypes.

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".

◆ name

const char* guac_user_info::name

The human-readable name of the Guacamole user, supplied by the client during the handshake.

This is an arbitrary value, with no requirements or constraints, including that it need not uniquely identify the user. If the client does not provide a name then this will be NULL.

◆ optimal_height

int guac_user_info::optimal_height

The number of pixels the remote client requests for the display height.

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.

◆ optimal_resolution

int guac_user_info::optimal_resolution

The DPI of the physical remote display if configured for the optimal width/height combination described here.

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.

◆ optimal_width

int guac_user_info::optimal_width

The number of pixels the remote client requests for the display width.

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.

◆ timezone

const char* guac_user_info::timezone

The timezone of the remote system.

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.

◆ video_mimetypes

const char** guac_user_info::video_mimetypes

NULL-terminated array of client-supported video mimetypes.

If the client does not support video at all, this will be NULL.

The documentation for this struct was generated from the following file:

guacamole/user.h

Data Fields