ICloudWhiteboardHelper.h File Reference

Cloud whiteboard interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	CloudWhiteboardStatus
	Cloud whiteboard status. More...
struct	WhiteboardSettingsInfo
	Whiteboard settings info. More...
class	ICloudWhiteboardHelperSink
	Cloud whiteboard helper event callback. More...
class	ICloudWhiteboardHelper
	Cloud whiteboard helper interface. More...

Enumerations
enum	CloudWhiteboardAction { CloudWhiteboardActionNone = 0 , CloudWhiteboardActionClose }
	Cloud whiteboard action Here are more detailed structural descriptions. More...
enum	CloudWhiteboardUserChoiceType { CloudWhiteboardUserChoiceTypeCancel = 0 , CloudWhiteboardUserChoiceTypeConfirm = 1 }
	Respond to ZR cloud whiteboard warning. Here are more detailed structural descriptions. More...
enum	CloudWhiteboardWebWbState {   CloudWhiteboardWebWbStateNone = 0 , CloudWhiteboardWebWbStateLoading = 1 , CloudWhiteboardWebWbStateWebviewError = 2 , CloudWhiteboardWebWbStateShareError = 3 ,   CloudWhiteboardWebWbStateLoaded = 4 }
	Cloud whiteboard webview state Here are more detailed structural descriptions. More...
enum	WhiteboardSharePrivilegeType { WhiteboardSharePrivilegeTypeUnknown = 0 , WhiteboardSharePrivilegeTypeHostGrab = 1 , WhiteboardSharePrivilegeTypeAnyoneGrab }
	Whiteboard share privilege type, apply to both classic and cloud whiteboard. Here are more detailed structural descriptions. More...
enum	WhiteboardInitiatePrivilegeType { WhiteboardInitiatePrivilegeTypeUnknown = 0 , WhiteboardInitiatePrivilegeTypeHostOnly = 1 , WhiteboardInitiatePrivilegeTypeInternalUsers , WhiteboardInitiatePrivilegeTypeAllParticipants }
	Whiteboard initiate privilege type, apply to both classic and cloud whiteboard. Here are more detailed structural descriptions. More...

Detailed Description

Cloud whiteboard interfaces.

Since

Added in ZRC SDK 6.1.0

Definition in file ICloudWhiteboardHelper.h.

Enumeration Type Documentation

CloudWhiteboardAction

enum CloudWhiteboardAction

Cloud whiteboard action Here are more detailed structural descriptions.

Enumerator
CloudWhiteboardActionNone	Invalid.
CloudWhiteboardActionClose	Close cloud whiteboard.

Definition at line 17 of file ICloudWhiteboardHelper.h.

{
    CloudWhiteboardActionNone = 0,    
    CloudWhiteboardActionClose        
};

CloudWhiteboardUserChoiceType

enum CloudWhiteboardUserChoiceType

Respond to ZR cloud whiteboard warning. Here are more detailed structural descriptions.

Enumerator
CloudWhiteboardUserChoiceTypeCancel	Cancel.
CloudWhiteboardUserChoiceTypeConfirm	Confirm.

Definition at line 27 of file ICloudWhiteboardHelper.h.

{
    CloudWhiteboardUserChoiceTypeCancel = 0,    
    CloudWhiteboardUserChoiceTypeConfirm = 1    
};

CloudWhiteboardWebWbState

enum CloudWhiteboardWebWbState

Cloud whiteboard webview state Here are more detailed structural descriptions.

Enumerator
CloudWhiteboardWebWbStateNone	None.
CloudWhiteboardWebWbStateLoading	Cloud whiteboard is loading.
CloudWhiteboardWebWbStateWebviewError	Cloud whiteboard load error.
CloudWhiteboardWebWbStateShareError	Cloud whiteboard share error.
CloudWhiteboardWebWbStateLoaded	Cloud whiteboard loaded successfully.

Definition at line 37 of file ICloudWhiteboardHelper.h.

{
    CloudWhiteboardWebWbStateNone = 0,            
    CloudWhiteboardWebWbStateLoading = 1,         
    CloudWhiteboardWebWbStateWebviewError = 2,    
    CloudWhiteboardWebWbStateShareError = 3,      
    CloudWhiteboardWebWbStateLoaded = 4           
};

WhiteboardInitiatePrivilegeType

enum WhiteboardInitiatePrivilegeType

Whiteboard initiate privilege type, apply to both classic and cloud whiteboard. Here are more detailed structural descriptions.

Enumerator
WhiteboardInitiatePrivilegeTypeUnknown	Invalid.
WhiteboardInitiatePrivilegeTypeHostOnly	Only host can initiate new whiteboard in the meeting.
WhiteboardInitiatePrivilegeTypeInternalUsers	Internal users can initiate new whiteboard in the meeting.
WhiteboardInitiatePrivilegeTypeAllParticipants	All participants can initiate new whiteboard in the meeting.

Definition at line 61 of file ICloudWhiteboardHelper.h.

{
    WhiteboardInitiatePrivilegeTypeUnknown = 0,        
    WhiteboardInitiatePrivilegeTypeHostOnly = 1,       
    WhiteboardInitiatePrivilegeTypeInternalUsers,      
    WhiteboardInitiatePrivilegeTypeAllParticipants,    
};

WhiteboardSharePrivilegeType

enum WhiteboardSharePrivilegeType

Whiteboard share privilege type, apply to both classic and cloud whiteboard. Here are more detailed structural descriptions.

Enumerator
WhiteboardSharePrivilegeTypeUnknown	Invalid.
WhiteboardSharePrivilegeTypeHostGrab	Only host can grab share when someone else is sharing.
WhiteboardSharePrivilegeTypeAnyoneGrab	Anyone can grab share when someone else is sharing.

Definition at line 50 of file ICloudWhiteboardHelper.h.

{
    WhiteboardSharePrivilegeTypeUnknown = 0,     
    WhiteboardSharePrivilegeTypeHostGrab = 1,    
    WhiteboardSharePrivilegeTypeAnyoneGrab,      
};