An in-progress session recording, attached to a guac_client instance such that output Guacamole instructions may be dynamically intercepted and written to a file. More...

#include <recording.h>

Data Fields
guac_socket *	socket
	The guac_socket which writes directly to the recording file, rather than to any particular user.

int	include_output
	Non-zero if output which is broadcast to each connected client (graphics, streams, etc.) should be included in the session recording, zero otherwise.

int	include_mouse
	Non-zero if changes to mouse state, such as position and buttons pressed or released, should be included in the session recording, zero otherwise.

int	include_touch
	Non-zero if multi-touch events should be included in the session recording, zero otherwise.

int	include_keys
	Non-zero if keys pressed and released should be included in the session recording, zero otherwise.

Detailed Description

An in-progress session recording, attached to a guac_client instance such that output Guacamole instructions may be dynamically intercepted and written to a file.

Field Documentation

◆ include_keys

int guac_recording::include_keys

Non-zero if keys pressed and released should be included in the session recording, zero otherwise.

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.

◆ include_mouse

int guac_recording::include_mouse

Non-zero if changes to mouse state, such as position and buttons pressed or released, should be included in the session recording, zero otherwise.

Including mouse state is necessary for the mouse cursor to be rendered in any resulting video.

◆ include_output

int guac_recording::include_output

Non-zero if output which is broadcast to each connected client (graphics, streams, etc.) should be included in the session recording, zero otherwise.

Including output is necessary for any recording which must later be viewable as video.

◆ include_touch

int guac_recording::include_touch

Non-zero if multi-touch events should be included in the session recording, zero otherwise.

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.

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