|
guac_recording * | guac_recording_create (guac_client *client, const char *path, const char *name, int create_path, int include_output, int include_mouse, int include_touch, int include_keys) |
| Replaces the socket of the given client such that all further Guacamole protocol output will be copied into a file within the given path and having the given name. More...
|
|
void | guac_recording_free (guac_recording *recording) |
| Frees the resources associated with the given in-progress recording. More...
|
|
void | guac_recording_report_mouse (guac_recording *recording, int x, int y, int button_mask) |
| Reports the current mouse position and button state within the recording. More...
|
|
void | guac_recording_report_touch (guac_recording *recording, int id, int x, int y, int x_radius, int y_radius, double angle, double force) |
| Reports the current state of a touch contact within the recording. More...
|
|
void | guac_recording_report_key (guac_recording *recording, int keysym, int pressed) |
| Reports a change in the state of an individual key within the recording. More...
|
|
Provides functions and structures to be use for session recording.
guac_recording* guac_recording_create |
( |
guac_client * |
client, |
|
|
const char * |
path, |
|
|
const char * |
name, |
|
|
int |
create_path, |
|
|
int |
include_output, |
|
|
int |
include_mouse, |
|
|
int |
include_touch, |
|
|
int |
include_keys |
|
) |
| |
Replaces the socket of the given client such that all further Guacamole protocol output will be copied into a file within the given path and having the given name.
If the create_path flag is non-zero, the given path will be created if it does not yet exist. If creation of the recording file or path fails, error messages will automatically be logged, and no recording will be written. The recording will automatically be closed once the client is freed.
- Parameters
-
client | The client whose output should be copied to a recording file. |
path | The full absolute path to a directory in which the recording file should be created. |
name | The base name to use for the recording file created within the specified path. |
create_path | Zero if the specified path MUST exist for the recording file to be written, or non-zero if the path should be created if it does not yet exist. |
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_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_touch | Non-zero if 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. |
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. |
- Returns
- A new guac_recording structure representing the in-progress recording if the recording file has been successfully created and a recording will be written, NULL otherwise.