Share controller in meeting. More...

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

Public Member Functions
void	addListener (InMeetingShareListener listener)
	Registers a listener for meeting shared callback events.
void	removeListener (InMeetingShareListener listener)
	Unregisters the listener.
MobileRTCSDKError	startShareScreen (Intent data)
	Starts sharing the screen.
MobileRTCSDKError	stopShareScreen ()
	Stops sharing the screen.
MobileRTCSDKError	startShareViewContent (MobileRTCShareView shareView)
	Shares the content saved in MobileRTCShareView.
MobileRTCSDKError	stopShareView ()
	Stops sharing the content in MobileRTCShareView.
boolean	isShareLocked ()
	Determines whether screen share is locked by the host.
MobileRTCSDKError	lockShare (boolean isLock)
	Locks the current meeting share. The host or co-host can use this function.
boolean	isSharingOut ()
	Determines whether the current user is sharing successfully.
boolean	isSharingScreen ()
	Determines whether the current user is sharing the screen.
boolean	isOtherSharing ()
	Determines whether another user is sharing.
boolean	isSenderSupportAnnotation (long shareSourceUserID)
	Determines whether annotation is enabled in the current sharing.
Bitmap	getShareBitmap ()
	Gets the share bitmap in Zoom UI.
boolean	isWhiteboardLegalNoticeAvailable ()
	Determines whether whiteboard legal notice is available.
String	getWhiteboardLegalNoticesPrompt ()
	Gets the whiteboard legal notice prompt.
String	getWhiteboardLegalNoticesExplained ()
	Gets the explained text for whiteboard legal notice.
CannotShareReasonType	canStartShare ()
	Determines whether the current meeting can start sharing.
List< ZoomSDKSharingSourceInfo >	getSharingSourceInfoList (long userID)
	Gets the list of sharing source info.
List< Long >	getViewableSharingUserList ()
	Gets the IDs of users who are sharing.
MobileRTCASVStatisticInfo	getMeetingShareStatisticInfo ()
	Gets meeting share statistics information.

Detailed Description

Share controller in meeting.

Definition at line 13 of file InMeetingShareController.java.

Member Function Documentation

◆ addListener()

void us.zoom.sdk.InMeetingShareController.addListener ( InMeetingShareListener listener )

Registers a listener for meeting shared callback events.

Parameters

listener The listener instance.

◆ canStartShare()

CannotShareReasonType us.zoom.sdk.InMeetingShareController.canStartShare ( )

Determines whether the current meeting can start sharing.

Returns: If the function succeeds, it returns the reason that no one can start sharing. Otherwise, this function fails and returns null.

◆ getMeetingShareStatisticInfo()

MobileRTCASVStatisticInfo us.zoom.sdk.InMeetingShareController.getMeetingShareStatisticInfo ( )

Gets meeting share statistics information.

Returns: If the function succeeds, it returns a MobileRTCASVStatisticInfo instance containing share stats. Otherwise, this function fails and returns null if no sharing is active or if data is unavailable.

◆ getShareBitmap()

Bitmap us.zoom.sdk.InMeetingShareController.getShareBitmap ( )

Gets the share bitmap in Zoom UI.

Returns: If the function succeeds, it returns the share bitmap. Otherwise, this function fails and returns null.

◆ getSharingSourceInfoList()

List< ZoomSDKSharingSourceInfo > us.zoom.sdk.InMeetingShareController.getSharingSourceInfoList ( long userID )

Gets the list of sharing source info.

Parameters

userID The user's ID who is sharing.

Returns: If the function succeeds, it returns the list. Otherwise, this function fails and returns null.

◆ getViewableSharingUserList()

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

Gets the IDs of users who are sharing.

Returns: If the function succeeds, it returns a list of user IDs of all users who are sharing. Otherwise, this function fails and returns null.

◆ getWhiteboardLegalNoticesExplained()

String us.zoom.sdk.InMeetingShareController.getWhiteboardLegalNoticesExplained ( )

Gets the explained text for whiteboard legal notice.

Returns: If the function succeeds, it returns the explained text for notice. Otherwise, this function fails and returns null.

◆ getWhiteboardLegalNoticesPrompt()

String us.zoom.sdk.InMeetingShareController.getWhiteboardLegalNoticesPrompt ( )

Gets the whiteboard legal notice prompt.

Returns: If the function succeeds, it returns the notice prompt. Otherwise, this function fails and returns null.

◆ isOtherSharing()

boolean us.zoom.sdk.InMeetingShareController.isOtherSharing ( )

Determines whether another user is sharing.

Returns: true if another user is sharing. Otherwise, false.

◆ isSenderSupportAnnotation()

boolean us.zoom.sdk.InMeetingShareController.isSenderSupportAnnotation ( long shareSourceUserID )

Determines whether annotation is enabled in the current sharing.

Parameters

shareSourceUserID The user's ID who is sharing.

Returns: true if annotation is enabled. Otherwise, false.

◆ isShareLocked()

boolean us.zoom.sdk.InMeetingShareController.isShareLocked ( )

Determines whether screen share is locked by the host.

Returns: true if the screen share has been locked by the host. Otherwise, false.

◆ isSharingOut()

boolean us.zoom.sdk.InMeetingShareController.isSharingOut ( )

Determines whether the current user is sharing successfully.

Returns: true if sharing successfully. Otherwise, false.

◆ isSharingScreen()

boolean us.zoom.sdk.InMeetingShareController.isSharingScreen ( )

Determines whether the current user is sharing the screen.

Returns: true if sharing the screen. Otherwise, false.

◆ isWhiteboardLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingShareController.isWhiteboardLegalNoticeAvailable ( )

Determines whether whiteboard legal notice is available.

Returns: true if whiteboard legal notice is available. Otherwise, false.

◆ lockShare()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.lockShare ( boolean isLock )

Locks the current meeting share. The host or co-host can use this function.

Parameters

isLock true to lock the meeting share, false otherwise.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Once the meeting is locked by the host or co-host, other users cannot share except the host or co-host.

◆ removeListener()

void us.zoom.sdk.InMeetingShareController.removeListener ( InMeetingShareListener listener )

Unregisters the listener.

Parameters

listener The listener instance.

◆ startShareScreen()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.startShareScreen ( Intent data )

Starts sharing the 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 returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ startShareViewContent()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.startShareViewContent ( MobileRTCShareView shareView )

Shares the content saved in MobileRTCShareView.

Note: When video effects, like InMeetingVirtualBackgroundController or I3DAvatarSettingContext, are used in the meeting, camera share will be forbidden when calling MobileRTCShareView.setShareCamera(String).

Parameters

shareView The content of MobileRTCShareView.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ stopShareScreen()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.stopShareScreen ( )

Stops sharing the screen.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ stopShareView()

MobileRTCSDKError us.zoom.sdk.InMeetingShareController.stopShareView ( )

Stops sharing the content in MobileRTCShareView.

Returns: If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

Data Structures

Public Member Functions

Detailed Description

Member Function Documentation

◆ addListener()

◆ canStartShare()

◆ getMeetingShareStatisticInfo()

◆ getShareBitmap()

◆ getSharingSourceInfoList()

◆ getViewableSharingUserList()

◆ getWhiteboardLegalNoticesExplained()

◆ getWhiteboardLegalNoticesPrompt()

◆ isOtherSharing()

◆ isSenderSupportAnnotation()

◆ isShareLocked()

◆ isSharingOut()

◆ isSharingScreen()

◆ isWhiteboardLegalNoticeAvailable()

◆ lockShare()

◆ removeListener()

◆ startShareScreen()

◆ startShareViewContent()

◆ stopShareScreen()

◆ stopShareView()