us.zoom.sdk.InMeetingShareController Interface Reference

Share controller in meeting. More...

Data Structures
interface	InMeetingShareListener
	Callback event of meeting sharing. More...

Public Member Functions
void	addListener (InMeetingShareListener listener)
	Register a listener for meeting shared callback event.
void	removeListener (InMeetingShareListener listener)
	Unregister the listener.
MobileRTCSDKError	startShareScreen (Intent data)
	Start sharing screen.
MobileRTCSDKError	stopShareScreen ()
	Stop sharing screen.
MobileRTCSDKError	startShareViewContent (MobileRTCShareView shareView)
	Sharing the content saved in MobileRTCShareView. Noticed: When Video effects, like InMeetingVirtualBackgroundController or I3DAvatarSettingContext, is used in the meeting, Camera share will be forbidden when call MobileRTCShareView.setShareCamera(String).
MobileRTCSDKError	stopShareView ()
	Stop sharing the content in MobileRTCShareView.
boolean	isShareLocked ()
	Query if screen share is locked by host.
MobileRTCSDKError	lockShare (boolean isLock)
	The host/co-host can use this function to lock current meeting share.
boolean	isSharingOut ()
	Query if the current user is sharing successfully.
boolean	isSharingScreen ()
	Query if the current user is sharing screen.
boolean	isOtherSharing ()
	Query if other user is sharing.
boolean	isSenderSupportAnnotation (long shareSourceUserID)
	Query if the annotation is enabled in current sharing.
Bitmap	getShareBitmap ()
	Get share bitmap in zoom ui.
boolean	isWhiteboardLegalNoticeAvailable ()
	Whether whiteboard legal notice is available.
String	getWhiteboardLegalNoticesPrompt ()
	Return whiteboard legal notice prompt.
String	getWhiteboardLegalNoticesExplained ()
	Return explained text for whiteboard legal notice.
CannotShareReasonType	canStartShare ()
	Determine whether the current meeting can start sharing.
List< ZoomSDKSharingSourceInfo >	getSharingSourceInfoList (long userID)
	Get the list of sharing source info.
List< Long >	getViewableSharingUserList ()
	Get the ID of users who are sharing.

Detailed Description

Share controller in meeting.

Definition at line 14 of file InMeetingShareController.java.

Member Function Documentation

addListener()

void us.zoom.sdk.InMeetingShareController.addListener

(

InMeetingShareListener

listener

)

Register a listener for meeting shared callback event.

Parameters

listener

The listener instance.

canStartShare()

CannotShareReasonType us.zoom.sdk.InMeetingShareController.canStartShare

(

)

Determine whether the current meeting can start sharing.

Returns

reason The reason that no one can start sharing.

getShareBitmap()

Bitmap us.zoom.sdk.InMeetingShareController.getShareBitmap

(

)

Get share bitmap in zoom ui.

Returns

share bitmap

getSharingSourceInfoList()

List< ZoomSDKSharingSourceInfo > us.zoom.sdk.InMeetingShareController.getSharingSourceInfoList

(

long

userID

)

Get the list of sharing source info.

Parameters

userID

The ID of the user who is sharing.

Returns

f the function succeeds, the return value is list, Otherwise, the return value is null.

getViewableSharingUserList()

List< Long > us.zoom.sdk.InMeetingShareController.getViewableSharingUserList

(

)

Get the ID of users who are sharing.

Returns

A list of userID of all users who are sharing.

getWhiteboardLegalNoticesExplained()

String us.zoom.sdk.InMeetingShareController.getWhiteboardLegalNoticesExplained

(

)

Return explained text for whiteboard legal notice.

Returns

explained text for notice

getWhiteboardLegalNoticesPrompt()

String us.zoom.sdk.InMeetingShareController.getWhiteboardLegalNoticesPrompt

(

)

Return whiteboard legal notice prompt.

Returns

notice prompt

isOtherSharing()

boolean us.zoom.sdk.InMeetingShareController.isOtherSharing

(

)

Query if other user is sharing.

Returns

true means sharing, false not.

isSenderSupportAnnotation()

boolean us.zoom.sdk.InMeetingShareController.isSenderSupportAnnotation

(

long

shareSourceUserID

)

Query if the annotation is enabled in current sharing.

Parameters

shareSourceUserID

The ID of user who is sharing.

Returns

TRUES means that the annotation is enabled. FALSE not.

isShareLocked()

boolean us.zoom.sdk.InMeetingShareController.isShareLocked

(

)

Query if screen share is locked by host.

Returns

TRUE means the screen share has been locked by host, FALSE not.

isSharingOut()

boolean us.zoom.sdk.InMeetingShareController.isSharingOut

(

)

Query if the current user is sharing successfully.

Returns

TRUE means sharing successfully, FALSE not.

isSharingScreen()

boolean us.zoom.sdk.InMeetingShareController.isSharingScreen

(

)

Query if the current user is sharing screen.

Returns

TRUE means sharing screen, FALSE not.

isWhiteboardLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingShareController.isWhiteboardLegalNoticeAvailable

(

)

Whether whiteboard legal notice is available.

Returns

true if whiteboard legal notice is available

lockShare()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.lockShare

(

boolean

isLock

)

The host/co-host can use this function to lock current meeting share.

Parameters

isLock

TRUE means to lock the meeting share, FALSE not.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. Note Once the meeting is locked by the host/co-host, other user can not share except the host/co-host.

removeListener()

void us.zoom.sdk.InMeetingShareController.removeListener

(

InMeetingShareListener

listener

)

Unregister the listener.

Parameters

listener

The listener instance

startShareScreen()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.startShareScreen

(

Intent

data

)

Start sharing screen.

Parameters

data	The intent data for retrieving the MediaProjection obtained from a successful screen capture request. See:https://developer.android.com/reference/android/media/projection/MediaProjectionManager.html

Returns

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

startShareViewContent()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.startShareViewContent

(

MobileRTCShareView

shareView

)

Sharing the content saved in MobileRTCShareView. Noticed: When Video effects, like InMeetingVirtualBackgroundController or I3DAvatarSettingContext, is used in the meeting, Camera share will be forbidden when call MobileRTCShareView.setShareCamera(String).

Parameters

shareView

The content of MobileRTCShareView.

Returns

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

stopShareScreen()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.stopShareScreen

(

)

Stop sharing screen.

Returns

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

stopShareView()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.stopShareView

(

)

Stop sharing the content in MobileRTCShareView.

Returns

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