us.zoom.sdk.InMeetingWhiteboardController Interface Reference

Public Member Functions
MobileRTCSDKError	setEvent (InMeetingWhiteboardCtrlEvent pEvent)
	Configure the meeting white board controller callback event handler.
boolean	isSupportWhiteBoard ()
	Determine whether the current meeting supports the whiteboard or not.
MobileRTCSDKError	showDashboardView (Activity activity, int requestCode)
	Show the dashboard web view activity.
MobileRTCSDKError	setWhiteboardShareOption (SDKWhiteboardShareOption option)
	Set the setting option for whiteboard who can share.
SDKWhiteboardShareOption	getWhiteboardShareOption ()
	Get the setting option for whiteboard who can share.
MobileRTCSDKError	setWhiteboardCreateOption (SDKWhiteboardCreateOption option)
	Set the setting option for whiteboard who can initiate new whiteboard.
SDKWhiteboardCreateOption	getWhiteboardCreateOption ()
	Get the setting option for whiteboard who can initiate new whiteboard.
MobileRTCSDKError	enableParticipantsCreateWithoutHost (boolean bEnable)
	Enable the participants create new whiteboard without host in the meeting.
boolean	isParticipantsCreateWithoutHostEnabled ()
	Determine whether enable the participants create new whiteboard without host in the meeting.
CannotShareReasonType	canStartShareWhiteboard ()
	Determine whether the current meeting can start sharing the whiteboard.
boolean	isOtherSharingWhiteboard ()
	Query if other user is sharing whiteboard.
boolean	isSharingWhiteboardOut ()
	Query if the current user is successfully sharing a whiteboard.

Detailed Description

Definition at line 6 of file InMeetingWhiteboardController.java.

Member Function Documentation

canStartShareWhiteboard()

CannotShareReasonType us.zoom.sdk.InMeetingWhiteboardController.canStartShareWhiteboard

(

)

Determine whether the current meeting can start sharing the whiteboard.

Returns

The reason that no one can start share the whiteboard.

enableParticipantsCreateWithoutHost()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.enableParticipantsCreateWithoutHost

(

boolean

bEnable

)

Enable the participants create new whiteboard without host in the meeting.

Parameters

bEnable

true indicates to enable. false not.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

getWhiteboardCreateOption()

SDKWhiteboardCreateOption us.zoom.sdk.InMeetingWhiteboardController.getWhiteboardCreateOption

(

)

Get the setting option for whiteboard who can initiate new whiteboard.

getWhiteboardShareOption()

SDKWhiteboardShareOption us.zoom.sdk.InMeetingWhiteboardController.getWhiteboardShareOption

(

)

Get the setting option for whiteboard who can share.

isOtherSharingWhiteboard()

boolean us.zoom.sdk.InMeetingWhiteboardController.isOtherSharingWhiteboard

(

)

Query if other user is sharing whiteboard.

Returns

true means sharing, false not.

isParticipantsCreateWithoutHostEnabled()

boolean us.zoom.sdk.InMeetingWhiteboardController.isParticipantsCreateWithoutHostEnabled

(

)

Determine whether enable the participants create new whiteboard without host in the meeting.

Returns

true indicates to can.

isSharingWhiteboardOut()

boolean us.zoom.sdk.InMeetingWhiteboardController.isSharingWhiteboardOut

(

)

Query if the current user is successfully sharing a whiteboard.

Returns

true means that they are sharing, FALSE means that they are not.

isSupportWhiteBoard()

boolean us.zoom.sdk.InMeetingWhiteboardController.isSupportWhiteBoard

(

)

Determine whether the current meeting supports the whiteboard or not.

Returns

true indicates to support.

setEvent()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.setEvent

(

InMeetingWhiteboardCtrlEvent

pEvent

)

Configure the meeting white board controller callback event handler.

Parameters

pEvent

Event object.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setWhiteboardCreateOption()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.setWhiteboardCreateOption

(

SDKWhiteboardCreateOption

option

)

Set the setting option for whiteboard who can initiate new whiteboard.

Parameters

option

Setting option for whiteboard who can initiate new whiteboard.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setWhiteboardShareOption()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.setWhiteboardShareOption

(

SDKWhiteboardShareOption

option

)

Set the setting option for whiteboard who can share.

Parameters

option

ew setting for whiteboard who can share,SDKWhiteboardShareOption

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

showDashboardView()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.showDashboardView	(	Activity	activity,
		int	requestCode )

Show the dashboard web view activity.

Parameters

activity	the top resume activity
requestCode	the request code Activity#startActivityForResult(Intent, int)

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.