us.zoom.sdk.InMeetingWhiteboardController Interface Reference

Public Member Functions
MobileRTCSDKError	setEvent (InMeetingWhiteboardCtrlEvent pEvent)
	Configure the meeting white board controller callback event handler.
boolean	isSupportWhiteBoard ()
	Determines 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 ()
	Determines whether enable the participants create new whiteboard without host in the meeting.
CannotShareReasonType	canStartShareWhiteboard ()
	Determines whether the current meeting can start sharing the whiteboard.
boolean	canStartShareNewWhiteboard ()
	Determines whether the current user can create a new whiteboard.
MobileRTCSDKError	startNewWhiteboardShare ()
	Starts sharing a new whiteboard.
boolean	canStopWhiteboardShare ()
	Determines whether the current user can stop sharing the new whiteboard.
MobileRTCSDKError	stopWhiteboardShare ()
	When self sharing whiteboard, stop self; when self not sharing, stop all others.
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

canStartShareNewWhiteboard()

boolean us.zoom.sdk.InMeetingWhiteboardController.canStartShareNewWhiteboard

(

)

Determines whether the current user can create a new whiteboard.

Returns

true if the current user can create a new whiteboard. Otherwise, this function returns false.

canStartShareWhiteboard()

CannotShareReasonType us.zoom.sdk.InMeetingWhiteboardController.canStartShareWhiteboard

(

)

Determines whether the current meeting can start sharing the whiteboard.

Returns

The reason that no one can start share the whiteboard.

canStopWhiteboardShare()

boolean us.zoom.sdk.InMeetingWhiteboardController.canStopWhiteboardShare

(

)

Determines whether the current user can stop sharing the new whiteboard.

Returns

true if the current user can stop sharing the new whiteboard. Otherwise, this function returns false.

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

(

)

Determines 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

(

)

Determines 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.

startNewWhiteboardShare()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.startNewWhiteboardShare

(

)

Starts sharing a new whiteboard.

Returns

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

Note

Valid only for custom user interface mode.

stopWhiteboardShare()

MobileRTCSDKError us.zoom.sdk.InMeetingWhiteboardController.stopWhiteboardShare

(

)

When self sharing whiteboard, stop self; when self not sharing, stop all others.

Returns

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

Note

Valid only for user custom interface mode.