GUACAMOLE-25: Update documentation regarding loading of dynamic virtual channel plugins.
This commit is contained in:
parent
0d29694afc
commit
402b039384
@ -294,12 +294,18 @@ guac_user_blob_handler guac_rdp_audio_blob_handler;
|
|||||||
guac_user_end_handler guac_rdp_audio_end_handler;
|
guac_user_end_handler guac_rdp_audio_end_handler;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads Guacamole's "guacai" plugin for FreeRDP, adding support for the
|
* Adds Guacamole's "guacai" plugin to the list of dynamic virtual channel
|
||||||
* "AUDIO_INPUT" dynamic virtual channel. This function must ONLY be called
|
* plugins to be loaded by FreeRDP's "drdynvc" plugin. The plugin will only
|
||||||
* after FreeRDP's "drdynvc" virtual channel plugin has been loaded.
|
* be loaded once guac_rdp_load_drdynvc() is invoked with the guac_rdp_dvc_list
|
||||||
|
* passed to this function. The "guacai" plugin ultimately adds support for the
|
||||||
|
* "AUDIO_INPUT" dynamic virtual channel.
|
||||||
*
|
*
|
||||||
* @param context
|
* @param context
|
||||||
* The rdpContext associated with the active RDP session.
|
* The rdpContext associated with the active RDP session.
|
||||||
|
*
|
||||||
|
* @param list
|
||||||
|
* The guac_rdp_dvc_list to which the "guacai" plugin should be added, such
|
||||||
|
* that it may later be loaded by guac_rdp_load_drdynvc().
|
||||||
*/
|
*/
|
||||||
void guac_rdp_audio_load_plugin(rdpContext* context, guac_rdp_dvc_list* list);
|
void guac_rdp_audio_load_plugin(rdpContext* context, guac_rdp_dvc_list* list);
|
||||||
|
|
||||||
|
@ -97,12 +97,24 @@ guac_rdp_disp* guac_rdp_disp_alloc();
|
|||||||
void guac_rdp_disp_free(guac_rdp_disp* disp);
|
void guac_rdp_disp_free(guac_rdp_disp* disp);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads the "disp" plugin for FreeRDP. It is still up to external code to
|
|
||||||
* detect when the "disp" channel is connected, and update the guac_rdp_disp
|
|
||||||
* with a call to guac_rdp_disp_connect().
|
|
||||||
*
|
|
||||||
* @param context The rdpContext associated with the active RDP session.
|
* @param context The rdpContext associated with the active RDP session.
|
||||||
*/
|
*/
|
||||||
|
/**
|
||||||
|
* Adds FreeRDP's "disp" plugin to the list of dynamic virtual channel plugins
|
||||||
|
* to be loaded by FreeRDP's "drdynvc" plugin. The plugin will only be loaded
|
||||||
|
* once guac_rdp_load_drdynvc() is invoked with the guac_rdp_dvc_list passed to
|
||||||
|
* this function. The "disp" plugin ultimately adds support for the Display
|
||||||
|
* Update channel. NOTE: It is still up to external code to detect when the
|
||||||
|
* "disp" channel is connected, and update the guac_rdp_disp with a call to
|
||||||
|
* guac_rdp_disp_connect().
|
||||||
|
*
|
||||||
|
* @param context
|
||||||
|
* The rdpContext associated with the active RDP session.
|
||||||
|
*
|
||||||
|
* @param list
|
||||||
|
* The guac_rdp_dvc_list to which the "disp" plugin should be added, such
|
||||||
|
* that it may later be loaded by guac_rdp_load_drdynvc().
|
||||||
|
*/
|
||||||
void guac_rdp_disp_load_plugin(rdpContext* context, guac_rdp_dvc_list* list);
|
void guac_rdp_disp_load_plugin(rdpContext* context, guac_rdp_dvc_list* list);
|
||||||
|
|
||||||
#ifdef HAVE_FREERDP_DISPLAY_UPDATE_SUPPORT
|
#ifdef HAVE_FREERDP_DISPLAY_UPDATE_SUPPORT
|
||||||
|
Loading…
Reference in New Issue
Block a user