Public Member Functions
void	addListener (InMeetingServiceListener listener)

void	removeListener (InMeetingServiceListener listener)

InMeetingAudioController	getInMeetingAudioController ()

InMeetingVideoController	getInMeetingVideoController ()

InMeetingShareController	getInMeetingShareController ()

InMeetingChatController	getInMeetingChatController ()

InMeetingAnnotationController	getInMeetingAnnotationController ()

InMeetingCloudRecordController	getInMeetingCloudRecordController ()

InMeetingQAController	getInMeetingQAController ()

InMeetingWaitingRoomController	getInMeetingWaitingRoomController ()

InMeetingRemoteController	getInMeetingRemoteController ()

InMeetingLiveStreamController	getInMeetingLiveStreamController ()

InMeetingWebinarController	getInMeetingWebinarController ()

InMeetingBOController	getInMeetingBOController ()

InMeetingInterpretationController	getInMeetingInterpretationController ()

InMeetingSignInterpretationController	getInMeetingSignInterpretationController ()

IEmojiReactionController	getEmojiReactionController ()

InMeetingAANController	getInMeetingAANController ()

InMeetingLiveTranscriptionController	getInMeetingLiveTranscriptionController ()

InMeetingVirtualBackgroundController	getInMeetingVirtualBackgroundController ()

InMeetingRawArchivingController	getMeetingRawArchivingController ()

InMeetingSmartSummaryController	getInMeetingSmartSummaryController ()

InMeetingWhiteboardController	getInMeetingWhiteboardController ()

InMeetingEncryptionController	getInMeetingEncryptionController ()

InMeetingPollingController	getInMeetingPollingController ()

InMeetingAICompanionController	getInMeetingAICompanionController ()

InMeetingIndicatorController	getInMeetingIndicatorController ()

InMeetingProductionStudioController	getInMeetingProductionStudioController ()

InMeetingDocsController	getInMeetingDocsController ()

boolean	isMeetingConnected ()

boolean	isMeetingLocked ()

MobileRTCSDKError	lockMeeting (boolean isLock)

int	getInMeetingUserCount ()

MobileRTCSDKError	changeName (String inputName, long userId)

List< Long >	getInMeetingUserList ()

long	getMyUserID ()

long	getParticipantId ()

InMeetingUserInfo	getMyUserInfo ()

InMeetingUserInfo	getUserInfoById (long userId)

MobileRTCSDKError	makeHost (long userId)

boolean	canReclaimHost ()

MobileRTCSDKError	reclaimHost ()

MobileRTCSDKError	assignCohost (long userId)

MobileRTCSDKError	assignCoHostWithAssetsPrivilege (long userId, List< GrantCoOwnerAssetsInfo > infoList)
	Assigns a user as co-host and grants privileges to manage assets after the meeting.

MobileRTCSDKError	makeHostWithAssetsPrivilege (long userId, List< GrantCoOwnerAssetsInfo > infoList)
	Assigns a user as host and grants privileges to manage assets after the meeting.

boolean	canBeCohost (long userId)

boolean	canBeCoOwner (long userId)
	Query if the user can be assigned as co-owner in meeting. Co-owner can be granted privilege to manage some assets after the meeting.

MobileRTCSDKError	revokeCohost (long userId)

MobileRTCSDKError	removeUser (long userId)

MobileRTCSDKError	setPlayChimeOnOff (boolean on)

boolean	isPlayChimeOn ()

long	activeShareUserID ()

boolean	isHostUser (long userId)

boolean	isMyself (long userId)

MobileRTCSDKError	raiseMyHand ()

MobileRTCSDKError	lowerHand (long userId)

MobileRTCSDKError	lowerAllHands (boolean forWebinarAttendees)

boolean	isMeetingHost ()

void	leaveCurrentMeeting (boolean endIfPossible)

String	getCurrentMeetingID ()

long	getCurrentMeetingNumber ()

String	getCurrentMeetingTopic ()
	Get the topic/title of the current meeting.

String	getCurrentMeetingUrl ()

String	getCurrentMeetingInviteEmailSubject ()

String	getCurrentMeetingInviteEmailContent ()

boolean	isFailoverMeeting ()

int	querySessionNetworkStatus (EnumComponentType type, boolean bSending)

boolean	claimHostWithHostKey (String hostKey)

boolean	isWebinarMeeting ()

void	showZoomParticipantsUI (Activity activity, int requestCode)

void	showZoomChatUI (Activity activity, int requestCode)

void	showZoomQAUI (Activity activity, int requestCode)

String	getMeetingPassword ()

MobileRTCSDKError	setMeetingTopic (String topic)

MobileRTCSDKError	allowParticipantsToRename (boolean allow)

boolean	isParticipantsRenameAllowed ()

MobileRTCSDKError	allowParticipantsToUnmuteSelf (boolean allow)

boolean	isParticipantsUnmuteSelfAllowed ()

boolean	isInWaitingRoom ()

boolean	isLiveTranscriptLegalNoticeAvailable ()

String	getLiveTranscriptLegalNoticesPrompt ()

String	getLiveTranscriptLegalNoticesExplained ()

boolean	updatePermissions (String[] permissions, int[] grantResults)

MobileRTCSDKError	suspendParticipantsActivities ()

boolean	canSuspendParticipantsActivities ()

MobileRTCSDKError	allowParticipantsToStartVideo (boolean allow)

boolean	isParticipantsStartVideoAllowed ()

MobileRTCSDKError	allowParticipantsToShareWhiteBoard (boolean allow)

boolean	isParticipantsShareWhiteBoardAllowed ()

boolean	isParticipantRequestLocalRecordingAllowed ()

MobileRTCSDKError	allowParticipantsToRequestLocalRecording (boolean allow)

boolean	isAutoAllowLocalRecordingRequest ()

MobileRTCSDKError	autoAllowLocalRecordingRequest (boolean allow)

MobileRTCSDKError	canHideParticipantProfilePictures ()

MobileRTCSDKError	hideParticipantProfilePictures (boolean hide)

boolean	isParticipantProfilePicturesHidden ()

String	getInMeetingDataCenterInfo ()

boolean	isFocusModeEnabled ()

MobileRTCSDKError	turnFocusModeOn (boolean on)

boolean	isFocusModeOn ()

MobileRTCFocusModeShareType	getFocusModeShareType ()

MobileRTCSDKError	setFocusModeShareType (MobileRTCFocusModeShareType shareType)

boolean	canEnableParticipantRequestCloudRecording ()

boolean	isParticipantRequestCloudRecordingAllowed ()

MobileRTCSDKError	allowParticipantsToRequestCloudRecording (boolean bAllow)

boolean	isSelfOriginalHost ()

boolean	canSetMeetingTopic ()

InMeetingUserInfo	getBotAuthorizedUserInfoByUserID (long botUserId)

List< Long >	getAuthorizedBotListByUserID (long userid)

boolean	isSupportVirtualNameTag ()

MobileRTCSDKError	enableVirtualNameTag (boolean bEnabled)

MobileRTCSDKError	updateVirtualNameTagRosterInfo (List< ZoomSDKVirtualNameTag > nameTags)

InMeetingUserInfo	getCompanionParentUser (long userid)

List< Long >	getCompanionChildList (long userid)

Detailed Description

Interfaces of ZOOM services in meeting.

Definition at line 10 of file InMeetingService.java.

Member Function Documentation

◆ activeShareUserID()

long us.zoom.sdk.InMeetingService.activeShareUserID ( )

Deprecated: the share user id should be got from {InMeetingShareListener.onSharingStatus(ZoomSDKSharingSourceInfo).

Get the ID of active presenter in meeting.

Returns: The ID of active presenter. 0 means no one is sharing

◆ addListener()

void us.zoom.sdk.InMeetingService.addListener ( InMeetingServiceListener listener )

Register a listener for in-meeting events.

Parameters

listener The listener instance.

◆ allowParticipantsToRename()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToRename ( boolean allow )

Allow participant to rename self

Parameters

allow true: allow, false: disallow

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

◆ allowParticipantsToRequestCloudRecording()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToRequestCloudRecording ( boolean bAllow )

Toggle whether attendees can send requests for the host to start a cloud recording. This can only be used in regular meetings and webinars (no breakout rooms).

Parameters

bAllow TRUE indicates that participants are allowed to send cloud recording privilege requests.

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

◆ allowParticipantsToRequestLocalRecording()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToRequestLocalRecording ( boolean allow )

Allow participant to request local recording

Parameters

allow true: allow, false: disallow

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

◆ allowParticipantsToShareWhiteBoard()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToShareWhiteBoard ( boolean allow )

Allow participant to share white board

Parameters

allow true: allow, false: disallow

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

◆ allowParticipantsToStartVideo()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToStartVideo ( boolean allow )

Allow participant to start video

Parameters

allow true: allow, false: disallow

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

◆ allowParticipantsToUnmuteSelf()

MobileRTCSDKError us.zoom.sdk.InMeetingService.allowParticipantsToUnmuteSelf ( boolean allow )

Allow participant to unmute self

Parameters

allow true: allow, false: disallow

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

◆ assignCohost()

MobileRTCSDKError us.zoom.sdk.InMeetingService.assignCohost ( long userId )

Assign a user as co-host in meeting.

Parameters

userId The ID of user who is specified as co-host in meeting.

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

Note: The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.

◆ assignCoHostWithAssetsPrivilege()

MobileRTCSDKError us.zoom.sdk.InMeetingService.assignCoHostWithAssetsPrivilege	(	long	userId,
		List< GrantCoOwnerAssetsInfo >	infoList )

Assigns a user as co-host and grants privileges to manage assets after the meeting.

Parameters

userId	The ID of user to be assigned as co-host.
infoList	A List of `GrantCoOwnerAssetsInfo` objects representing the assets and privileges to grant.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise the function fails. For more information, see MobileRTCSDKError.

Note: Before calling this method, you must obtain the assets to be granted via InMeetingUserInfo.getGrantCoOwnerAssetsInfo().

◆ autoAllowLocalRecordingRequest()

MobileRTCSDKError us.zoom.sdk.InMeetingService.autoAllowLocalRecordingRequest ( boolean allow )

Allow participant to request local recording

Parameters

allow true: allow, false: disallow

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

◆ canBeCohost()

boolean us.zoom.sdk.InMeetingService.canBeCohost ( long userId )

Query if the user can be assigned as co-host in meeting.

Parameters

userId The ID of user who will be assigned as co-host in meeting.

Returns: TRUE means that the user can be assigned as co-host. Otherwise cannot.

◆ canBeCoOwner()

boolean us.zoom.sdk.InMeetingService.canBeCoOwner ( long userId )

Query if the user can be assigned as co-owner in meeting. Co-owner can be granted privilege to manage some assets after the meeting.

Parameters

userId The ID of user who will be assigned as co-owner in meeting.

Returns: TRUE means that the user can be assigned as co-owner. Otherwise cannot.

◆ canEnableParticipantRequestCloudRecording()

boolean us.zoom.sdk.InMeetingService.canEnableParticipantRequestCloudRecording ( )

Determine if the current user can enable participant request cloud recording.

Returns: true means the current user can enable participant request cloud recording.

◆ canHideParticipantProfilePictures()

MobileRTCSDKError us.zoom.sdk.InMeetingService.canHideParticipantProfilePictures ( )

Query if the current user can hide participant profile pictures. Note: This feature is influenced by focus mode change.

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

◆ canReclaimHost()

boolean us.zoom.sdk.InMeetingService.canReclaimHost ( )

Call this interface to check whether the user can reclaim host

Returns: true if the user can reclaim host, otherwise return false

Note: Only the user is original host, but not host now, can reclaim host

◆ canSetMeetingTopic()

boolean us.zoom.sdk.InMeetingService.canSetMeetingTopic ( )

Determine if host/cohost can change the meeting topic.

Returns: If it can change the meeting topic, the return value is true.

◆ canSuspendParticipantsActivities()

boolean us.zoom.sdk.InMeetingService.canSuspendParticipantsActivities ( )

Query is allow to suspend meeting

Returns: true can suspend,false can not

◆ changeName()

MobileRTCSDKError us.zoom.sdk.InMeetingService.changeName	(	String	inputName,
		long	userId )

Rename users in meeting.

Parameters

inputName	Enter a new screen name for user in meeting.
userId	The ID of user whose screen name is changed in meeting.

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

◆ claimHostWithHostKey()

boolean us.zoom.sdk.InMeetingService.claimHostWithHostKey ( String hostKey )

Set to claim to be a host by host key.

Parameters

hostKey Host key got from web.

Returns: If the function succeeds, the return value is TRUE. FALSE failed.

◆ enableVirtualNameTag()

MobileRTCSDKError us.zoom.sdk.InMeetingService.enableVirtualNameTag ( boolean bEnabled )

Enable the virtual name tag feature for the account.

Parameters

bEnabled true means enabled. Otherwise not.

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

◆ getAuthorizedBotListByUserID()

List< Long > us.zoom.sdk.InMeetingService.getAuthorizedBotListByUserID ( long userid )

Get the authorizer's robot list.

Parameters

userid Specify the user ID for which you want to get the information.

Returns: If the function succeeds, the return value is the authorizer's robot list in the meeting. Otherwise the function fails, and the return value is null. Valid for both ZOOM style and user custom interface mode.

◆ getBotAuthorizedUserInfoByUserID()

InMeetingUserInfo us.zoom.sdk.InMeetingService.getBotAuthorizedUserInfoByUserID ( long botUserId )

Get the information about he robot's authorized user.

Parameters

botUserId Specify the user ID for which to get the information.

Returns: If the function succeeds, the return value is a pointer to the IUserInfo.

◆ getCompanionChildList()

List< Long > us.zoom.sdk.InMeetingService.getCompanionChildList ( long userid )

Get the user's child list.

Parameters

userid Specify the user ID for which to get the information.

Returns: If the function succeeds, the return value is the sub-user list of user companion mode. Otherwise the function fails, and the return value is null.

◆ getCompanionParentUser()

InMeetingUserInfo us.zoom.sdk.InMeetingService.getCompanionParentUser ( long userid )

Get the information about the user's parent user.

Parameters

userid Specify the user ID for which to get the information.

Returns: If the function succeeds, the return value is a InMeetingUserInfo object. Otherwise the function fails, and the return value is null.

◆ getCurrentMeetingID()

String us.zoom.sdk.InMeetingService.getCurrentMeetingID ( )

Clean up meeting instance. Get unique ID of current meeting in format such as DVLObefSZizM0xQLhtrCQ==.

Returns: Current meeting ID.

◆ getCurrentMeetingInviteEmailContent()

String us.zoom.sdk.InMeetingService.getCurrentMeetingInviteEmailContent ( )

Get content of email invitation for current meeting.

Returns: Content of email invitation.

◆ getCurrentMeetingInviteEmailSubject()

String us.zoom.sdk.InMeetingService.getCurrentMeetingInviteEmailSubject ( )

Get subject of email invitation for current meeting.

Returns: Subject of email invitation.

◆ getCurrentMeetingNumber()

long us.zoom.sdk.InMeetingService.getCurrentMeetingNumber ( )

Get current meeting number in format such as 123456789.

Returns: Current meeting number.

◆ getCurrentMeetingTopic()

String us.zoom.sdk.InMeetingService.getCurrentMeetingTopic ( )

Get the topic/title of the current meeting.

Returns: The topic/title of the current meeting.

◆ getCurrentMeetingUrl()

String us.zoom.sdk.InMeetingService.getCurrentMeetingUrl ( )

Get the URL of the current meeting.

Returns: The URL of the current meeting

◆ getEmojiReactionController()

IEmojiReactionController us.zoom.sdk.InMeetingService.getEmojiReactionController ( )

Get emojiReaction controller

Returns: The instance defined in IEmojiReactionController

◆ getFocusModeShareType()

MobileRTCFocusModeShareType us.zoom.sdk.InMeetingService.getFocusModeShareType ( )

Get share focus mode type indicating who can see the shared content which is controlled by host or co-host.

Returns: The current share focus mode type.

◆ getInMeetingAANController()

InMeetingAANController us.zoom.sdk.InMeetingService.getInMeetingAANController ( )

Get AAN Controller

Returns: The instance defined in InMeetingAANController

◆ getInMeetingAICompanionController()

InMeetingAICompanionController us.zoom.sdk.InMeetingService.getInMeetingAICompanionController ( )

Get the AI Companion Controller.

Returns: The instance defined in InMeetingAICompanionController.

◆ getInMeetingAnnotationController()

InMeetingAnnotationController us.zoom.sdk.InMeetingService.getInMeetingAnnotationController ( )

Get annotation controller instance in meeting.

Returns: The instance defined in InMeetingAnnotationController.

◆ getInMeetingAudioController()

InMeetingAudioController us.zoom.sdk.InMeetingService.getInMeetingAudioController ( )

Get audio controller instance in meeting.

Returns: The instance defined in InMeetingAudioController.

◆ getInMeetingBOController()

InMeetingBOController us.zoom.sdk.InMeetingService.getInMeetingBOController ( )

Get breakout room controller instance in meeting.

Returns: The instance defined in InMeetingBOController.

◆ getInMeetingChatController()

InMeetingChatController us.zoom.sdk.InMeetingService.getInMeetingChatController ( )

Get chat controller instance in meeting.

Returns: The instance defined in InMeetingChatController.

◆ getInMeetingCloudRecordController()

InMeetingCloudRecordController us.zoom.sdk.InMeetingService.getInMeetingCloudRecordController ( )

Get cloud recording controller instance in meeting.

Returns: The instance defined in InMeetingCloudRecordController.

◆ getInMeetingDataCenterInfo()

String us.zoom.sdk.InMeetingService.getInMeetingDataCenterInfo ( )

Return data center details

◆ getInMeetingDocsController()

InMeetingDocsController us.zoom.sdk.InMeetingService.getInMeetingDocsController ( )

Get the docs controller

Returns: If the function succeeds, the return value is InMeetingDocsController. Otherwise returns NULL.

◆ getInMeetingEncryptionController()

InMeetingEncryptionController us.zoom.sdk.InMeetingService.getInMeetingEncryptionController ( )

Get the encryption controller.

Returns: The instance defined in InMeetingEncryptionController

◆ getInMeetingIndicatorController()

InMeetingIndicatorController us.zoom.sdk.InMeetingService.getInMeetingIndicatorController ( )

Get the indicator controller.

Returns: The instance defined in InMeetingIndicatorController.

◆ getInMeetingInterpretationController()

InMeetingInterpretationController us.zoom.sdk.InMeetingService.getInMeetingInterpretationController ( )

Get interpretation controller

Returns: The instance defined in InMeetingInterpretationController.

◆ getInMeetingLiveStreamController()

InMeetingLiveStreamController us.zoom.sdk.InMeetingService.getInMeetingLiveStreamController ( )

Get live-streaming controller instance in meeting.

Returns: The instance defined in InMeetingLiveStreamController.

◆ getInMeetingLiveTranscriptionController()

InMeetingLiveTranscriptionController us.zoom.sdk.InMeetingService.getInMeetingLiveTranscriptionController ( )

Get live transcription controller

Returns: The instance defined in InMeetingLiveTranscriptionController

◆ getInMeetingPollingController()

InMeetingPollingController us.zoom.sdk.InMeetingService.getInMeetingPollingController ( )

Get the Polling controller.

Returns: If the function succeeds, the return value is a pointer to InMeetingSmartSummaryController InMeetingPollingController. Otherwise returns NULL.

◆ getInMeetingProductionStudioController()

InMeetingProductionStudioController us.zoom.sdk.InMeetingService.getInMeetingProductionStudioController ( )

Get the Production Studio controller.

Returns: If the function succeeds, the return value is InMeetingProductionStudioController. Otherwise returns NULL.

◆ getInMeetingQAController()

InMeetingQAController us.zoom.sdk.InMeetingService.getInMeetingQAController ( )

Get QA controller instance in meeting.

Returns: The instance defined in InMeetingQAController.

◆ getInMeetingRemoteController()

InMeetingRemoteController us.zoom.sdk.InMeetingService.getInMeetingRemoteController ( )

Get remote controller instance in meeting.

Returns: The instance defined in InMeetingRemoteController.

◆ getInMeetingShareController()

InMeetingShareController us.zoom.sdk.InMeetingService.getInMeetingShareController ( )

Get shared controller instance in meeting.

Returns: The instance defined in InMeetingShareController.

Referenced by us.zoom.sdk.MobileRTCVideoView.initActivity().

◆ getInMeetingSignInterpretationController()

InMeetingSignInterpretationController us.zoom.sdk.InMeetingService.getInMeetingSignInterpretationController ( )

Get sign interpretation controller

Returns: The instance defined in InMeetingSignInterpretationController.

◆ getInMeetingSmartSummaryController()

InMeetingSmartSummaryController us.zoom.sdk.InMeetingService.getInMeetingSmartSummaryController ( )

Deprecated: replaced with InMeetingAICompanionController#getInMeetingSmartSummaryController() Get the smart summary controller.

Returns: If the function succeeds, the return value is a pointer to InMeetingSmartSummaryController InMeetingSmartSummaryController. Otherwise returns NULL.

◆ getInMeetingUserCount()

int us.zoom.sdk.InMeetingService.getInMeetingUserCount ( )

Get the number of participants in meeting.

Returns: The number of participants in meeting

◆ getInMeetingUserList()

List< Long > us.zoom.sdk.InMeetingService.getInMeetingUserList ( )

Get the list of all participants in meeting.

Returns: List of all users ID.

◆ getInMeetingVideoController()

InMeetingVideoController us.zoom.sdk.InMeetingService.getInMeetingVideoController ( )

Get video controller instance in meeting.

Returns: The instance defined in InMeetingVideoController.

◆ getInMeetingVirtualBackgroundController()

InMeetingVirtualBackgroundController us.zoom.sdk.InMeetingService.getInMeetingVirtualBackgroundController ( )

Get virtual background controller

Returns: The instance defined in InMeetingVirtualBackgroundController

◆ getInMeetingWaitingRoomController()

InMeetingWaitingRoomController us.zoom.sdk.InMeetingService.getInMeetingWaitingRoomController ( )

Get waiting room controller instance in meeting.

Returns: The instance defined in InMeetingWaitingRoomController.

◆ getInMeetingWebinarController()

InMeetingWebinarController us.zoom.sdk.InMeetingService.getInMeetingWebinarController ( )

Get webinar controller instance in meeting.

Returns: The instance defined in InMeetingWebinarController.

◆ getInMeetingWhiteboardController()

InMeetingWhiteboardController us.zoom.sdk.InMeetingService.getInMeetingWhiteboardController ( )

Get the new whiteboard controller

Returns: The instance defined in InMeetingWhiteboardController

Referenced by us.zoom.sdk.MobileRTCVideoView.init().

◆ getLiveTranscriptLegalNoticesExplained()

String us.zoom.sdk.InMeetingService.getLiveTranscriptLegalNoticesExplained ( )

Return explained text for live transcript legal notice

Returns: explained text for notice

◆ getLiveTranscriptLegalNoticesPrompt()

String us.zoom.sdk.InMeetingService.getLiveTranscriptLegalNoticesPrompt ( )

Return live transcript legal notice prompt

Returns: notice prompt

◆ getMeetingPassword()

String us.zoom.sdk.InMeetingService.getMeetingPassword ( )

get the current meeting's password

Returns: The current meeting's password

◆ getMeetingRawArchivingController()

InMeetingRawArchivingController us.zoom.sdk.InMeetingService.getMeetingRawArchivingController ( )

Get the Raw Archiving controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingRawArchivingController InMeetingRawArchivingController. Otherwise returns NULL.

◆ getMyUserID()

long us.zoom.sdk.InMeetingService.getMyUserID ( )

Get the current user ID in the meeting.

Returns: The current user ID.

◆ getMyUserInfo()

InMeetingUserInfo us.zoom.sdk.InMeetingService.getMyUserInfo ( )

Get the information of current user in meeting.

Returns: The information of current user, an object of InMeetingUserInfo.

◆ getParticipantId()

long us.zoom.sdk.InMeetingService.getParticipantId ( )

Get the current user participant id.

Returns: the current user participant id.

◆ getUserInfoById()

InMeetingUserInfo us.zoom.sdk.InMeetingService.getUserInfoById ( long userId )

Get the information of the specified user.

Parameters

userId The ID of specified user.

Returns: The information of specified user, an object of InMeetingUserInfo.

◆ hideParticipantProfilePictures()

MobileRTCSDKError us.zoom.sdk.InMeetingService.hideParticipantProfilePictures ( boolean hide )

Hide/Show participant profile pictures.

Parameters

hide	true means hide participant profile pictures, false means show participant pictures.

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

◆ isAutoAllowLocalRecordingRequest()

boolean us.zoom.sdk.InMeetingService.isAutoAllowLocalRecordingRequest ( )

Check whether the current meeting auto grant participants local recording privilege request, it can only be used in regular meetings(no webinar or bo).

Returns: true: allow, false: disallow

◆ isFailoverMeeting()

boolean us.zoom.sdk.InMeetingService.isFailoverMeeting ( )

Query if the current meeting is failover.

Returns: TRUE means that the current meeting is failover. FALSE not.

◆ isFocusModeEnabled()

boolean us.zoom.sdk.InMeetingService.isFocusModeEnabled ( )

Get the focus mode enabled or not by web portal.

Returns: true means focus mode enabled. Otherwise false.

◆ isFocusModeOn()

boolean us.zoom.sdk.InMeetingService.isFocusModeOn ( )

Get the focus mode on or off.

Returns: true Means focus mode on, otherwise false.

◆ isHostUser()

boolean us.zoom.sdk.InMeetingService.isHostUser ( long userId )

Query if the current user is host.

Parameters

userId The ID of user to be checked.

Returns: TRUE means host. FALSE not.

◆ isInWaitingRoom()

boolean us.zoom.sdk.InMeetingService.isInWaitingRoom ( )

Query if current user is in the waiting room

Returns: TRUE means in waiting room. FALSE not.

◆ isLiveTranscriptLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingService.isLiveTranscriptLegalNoticeAvailable ( )

Whether live transcript legal notice is available

Returns: True if live transcript legal notice is available

◆ isMeetingConnected()

boolean us.zoom.sdk.InMeetingService.isMeetingConnected ( )

Query if the meeting is connected.

Returns: TRUE means connected. FALSE not.

◆ isMeetingHost()

boolean us.zoom.sdk.InMeetingService.isMeetingHost ( )

Query if the current user is the host of the meeting.

Returns: TRUE means that the current user is the host of the meeting. FALSE not.

◆ isMeetingLocked()

boolean us.zoom.sdk.InMeetingService.isMeetingLocked ( )

Query if the meeting is locked by host.

Returns: TRUE means locked. FALSE not.

◆ isMyself()

boolean us.zoom.sdk.InMeetingService.isMyself ( long userId )

Query if the owner of ID is the current user himself.

Parameters

userId The ID of user to be checked.

Returns: TRUE means user himself. FALSE not.

◆ isParticipantProfilePicturesHidden()

boolean us.zoom.sdk.InMeetingService.isParticipantProfilePicturesHidden ( )

Query if the current meeting hides participant pictures.

Returns: true means hide participant pictures, false means show participant pictures

◆ isParticipantRequestCloudRecordingAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantRequestCloudRecordingAllowed ( )

Check whether the current meeting allows participants to send cloud recording start requests. This can only be used in regular meetings and webinars (no breakout rooms).

Returns: If allows participants to send request, the return value is true.

◆ isParticipantRequestLocalRecordingAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantRequestLocalRecordingAllowed ( )

Check whether the current meeting allows participants to send local recording privilege request, it can only be used in regular meetings(no webinar or bo).

Returns: true: allow, false: disallow

◆ isParticipantsRenameAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantsRenameAllowed ( )

Query is allow participant to rename self

Returns: true: allow, false: disallow

◆ isParticipantsShareWhiteBoardAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantsShareWhiteBoardAllowed ( )

Query is allow participant to share white board

Returns: true: allow, false: disallow

◆ isParticipantsStartVideoAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantsStartVideoAllowed ( )

Query is allow participant to start video

Returns: true: allow, false: disallow

◆ isParticipantsUnmuteSelfAllowed()

boolean us.zoom.sdk.InMeetingService.isParticipantsUnmuteSelfAllowed ( )

Query is allow participant to unmute self

Returns: true: allow, false: disallow

◆ isPlayChimeOn()

boolean us.zoom.sdk.InMeetingService.isPlayChimeOn ( )

Query if chime is enabled when user joins/leaves meeting.

Returns: TRUE means enabled. FALSE not.

◆ isSelfOriginalHost()

boolean us.zoom.sdk.InMeetingService.isSelfOriginalHost ( )

Query whether the current user is the original host.

Returns: TRUE means the current user is the original host. FALSE not.

◆ isSupportVirtualNameTag()

boolean us.zoom.sdk.InMeetingService.isSupportVirtualNameTag ( )

Determine if support virtual name tag feature.

Returns: true means supports the virtual name tag feature. false means not.

◆ isWebinarMeeting()

boolean us.zoom.sdk.InMeetingService.isWebinarMeeting ( )

Query if the current meeting is a webinar.

Returns: TRUE means that the current meeting is a webinar. FALSE not.

◆ leaveCurrentMeeting()

void us.zoom.sdk.InMeetingService.leaveCurrentMeeting ( boolean endIfPossible )

Leave the current meeting.

Parameters

endIfPossible If it is true and the current user is the meeting host, the meeting will be ended when he click the button.

◆ lockMeeting()

MobileRTCSDKError us.zoom.sdk.InMeetingService.lockMeeting ( boolean isLock )

Query if the current meeting is locked by host or co-host.

Parameters

isLock TRUE means locked. FALSE unlocked.

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

◆ lowerAllHands()

MobileRTCSDKError us.zoom.sdk.InMeetingService.lowerAllHands ( boolean forWebinarAttendees )

Cancel all hands raised.

Parameters

forWebinarAttendees When forWebinarAttendees is true, the SDK sends the lower all hands command only to webinar attendees. When forWebinarAttendees is false, the SDK sends the lower all hands command to anyone who is not a webinar attendee, such as the webinar host/cohost/panelist or everyone in a regular meeting.

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

◆ lowerHand()

MobileRTCSDKError us.zoom.sdk.InMeetingService.lowerHand ( long userId )

The current user puts hands down.

Parameters

userId The ID of user to put hands down.

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

◆ makeHost()

MobileRTCSDKError us.zoom.sdk.InMeetingService.makeHost ( long userId )

Assign a user as the host in meeting.

Parameters

userId The ID of user who is specified as host in meeting.

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

Note: The host cannot be assigned as host by himself. And the user should have the power to assign the role.

◆ makeHostWithAssetsPrivilege()

MobileRTCSDKError us.zoom.sdk.InMeetingService.makeHostWithAssetsPrivilege	(	long	userId,
		List< GrantCoOwnerAssetsInfo >	infoList )

Assigns a user as host and grants privileges to manage assets after the meeting.

Parameters

userId	The ID of user to be assigned as host.
infoList	A List of `GrantCoOwnerAssetsInfo` objects representing the assets and privileges to grant.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise the function fails. For more information, see MobileRTCSDKError.

Note: Before calling this method, you must obtain the assets to be granted via InMeetingUserInfo.getGrantCoOwnerAssetsInfo().

◆ querySessionNetworkStatus()

int us.zoom.sdk.InMeetingService.querySessionNetworkStatus	(	EnumComponentType	type,
		boolean	bSending )

Query network status of current meeting.

Parameters

type	Component types defined in `EnumComponentType`. Note: you can only get the status: AS/VIDEO/AUDIO
bSending	TRUE means to get data sending status; FALSE means receiving status.

Returns: Quality levels defined in SessionNetQualityLevel.

◆ raiseMyHand()

MobileRTCSDKError us.zoom.sdk.InMeetingService.raiseMyHand ( )

The current user raises hand.

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

◆ reclaimHost()

MobileRTCSDKError us.zoom.sdk.InMeetingService.reclaimHost ( )

Reclaim host permission.

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

Note: There is a host in the current meeting, but the host permissions are not in the original's hands. The original call this interface to reclaim host permissions.

◆ removeListener()

void us.zoom.sdk.InMeetingService.removeListener ( InMeetingServiceListener listener )

Unregister the listener for in-meeting events.

Parameters

listener The listener instance.

◆ removeUser()

MobileRTCSDKError us.zoom.sdk.InMeetingService.removeUser ( long userId )

Remove a user from the meeting.

Parameters

userId The ID of user to be removed from the meeting.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed. Note: Once the user is removed by the host, he can no longer join the current meeting.

◆ revokeCohost()

MobileRTCSDKError us.zoom.sdk.InMeetingService.revokeCohost ( long userId )

Revoke co-host role of user in meeting.

Parameters

userId The ID of user who will lose the co-host role.

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

Note: The co-host could not revoke the role himself. And the user should have the power to revoke the role.

◆ setFocusModeShareType()

MobileRTCSDKError us.zoom.sdk.InMeetingService.setFocusModeShareType ( MobileRTCFocusModeShareType shareType )

Set the focus mode type indicating who can see the shared content which is controlled by host or co-host.

Parameters

shareType The type of focus mode share type.

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

◆ setMeetingTopic()

MobileRTCSDKError us.zoom.sdk.InMeetingService.setMeetingTopic ( String topic )

Set a customized meeting topic in meeting, only original-host has this permission

Parameters

topic The customized topic

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

◆ setPlayChimeOnOff()

MobileRTCSDKError us.zoom.sdk.InMeetingService.setPlayChimeOnOff ( boolean on )

Set whether to play chime when user joins or leaves meeting.

Parameters

on	TRUE means enabled. FALSE disabled.

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

◆ showZoomChatUI()

void us.zoom.sdk.InMeetingService.showZoomChatUI	(	Activity	activity,
		int	requestCode )

Show the views of ZOOM meeting chat

Parameters

activity	Make calls.
requestCode	Reply a request code.

◆ showZoomParticipantsUI()

void us.zoom.sdk.InMeetingService.showZoomParticipantsUI	(	Activity	activity,
		int	requestCode )

Show the views of ZOOM meeting participants.

Parameters

activity	Make calls.
requestCode	Reply a request code.

◆ showZoomQAUI()

void us.zoom.sdk.InMeetingService.showZoomQAUI	(	Activity	activity,
		int	requestCode )

Show the views of ZOOM questions and answers.

Parameters

activity	Make calls.
requestCode	Reply a request code.

◆ suspendParticipantsActivities()

MobileRTCSDKError us.zoom.sdk.InMeetingService.suspendParticipantsActivities ( )

Suspend all participant activities

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

◆ turnFocusModeOn()

MobileRTCSDKError us.zoom.sdk.InMeetingService.turnFocusModeOn ( boolean on )

Turn focus mode on or off. Focus mode on means Participants will only be able to see hosts' videos and shared content, and videos of spotlighted participants.

Parameters

on	true means to turn on. False means to turn off.

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

◆ updatePermissions()

boolean us.zoom.sdk.InMeetingService.updatePermissions	(	String[]	permissions,
		int[]	grantResults )

Will need to call this interface to notify SDK that the corresponding permissions have been granted.

Parameters

permissions	permission
grantResults	grantResults{ PackageManager.PERMISSION_GRANTED PackageManager.PERMISSION_DENIED}

Returns: true or false.

◆ updateVirtualNameTagRosterInfo()

MobileRTCSDKError us.zoom.sdk.InMeetingService.updateVirtualNameTagRosterInfo ( List< ZoomSDKVirtualNameTag > nameTags )

Update the virtual name tag roster information for the account.

Parameters

nameTags The virtual name tag roster info list for specified user. The maximum size of nameTags should less 20. User should specified the tagName and tagID of each ZoomSDKVirtualNameTag object. The range of tagID is 0-1024.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ activeShareUserID()

◆ addListener()

◆ allowParticipantsToRename()

◆ allowParticipantsToRequestCloudRecording()

◆ allowParticipantsToRequestLocalRecording()

◆ allowParticipantsToShareWhiteBoard()

◆ allowParticipantsToStartVideo()

◆ allowParticipantsToUnmuteSelf()

◆ assignCohost()

◆ assignCoHostWithAssetsPrivilege()

◆ autoAllowLocalRecordingRequest()

◆ canBeCohost()

◆ canBeCoOwner()

◆ canEnableParticipantRequestCloudRecording()

◆ canHideParticipantProfilePictures()

◆ canReclaimHost()

◆ canSetMeetingTopic()

◆ canSuspendParticipantsActivities()

◆ changeName()

◆ claimHostWithHostKey()

◆ enableVirtualNameTag()

◆ getAuthorizedBotListByUserID()

◆ getBotAuthorizedUserInfoByUserID()

◆ getCompanionChildList()

◆ getCompanionParentUser()

◆ getCurrentMeetingID()

◆ getCurrentMeetingInviteEmailContent()

◆ getCurrentMeetingInviteEmailSubject()

◆ getCurrentMeetingNumber()

◆ getCurrentMeetingTopic()

◆ getCurrentMeetingUrl()

◆ getEmojiReactionController()

◆ getFocusModeShareType()

◆ getInMeetingAANController()

◆ getInMeetingAICompanionController()

◆ getInMeetingAnnotationController()

◆ getInMeetingAudioController()

◆ getInMeetingBOController()

◆ getInMeetingChatController()

◆ getInMeetingCloudRecordController()

◆ getInMeetingDataCenterInfo()

◆ getInMeetingDocsController()

◆ getInMeetingEncryptionController()

◆ getInMeetingIndicatorController()

◆ getInMeetingInterpretationController()

◆ getInMeetingLiveStreamController()

◆ getInMeetingLiveTranscriptionController()

◆ getInMeetingPollingController()

◆ getInMeetingProductionStudioController()

◆ getInMeetingQAController()

◆ getInMeetingRemoteController()

◆ getInMeetingShareController()

◆ getInMeetingSignInterpretationController()

◆ getInMeetingSmartSummaryController()

◆ getInMeetingUserCount()

◆ getInMeetingUserList()

◆ getInMeetingVideoController()

◆ getInMeetingVirtualBackgroundController()

◆ getInMeetingWaitingRoomController()

◆ getInMeetingWebinarController()

◆ getInMeetingWhiteboardController()

◆ getLiveTranscriptLegalNoticesExplained()

◆ getLiveTranscriptLegalNoticesPrompt()

◆ getMeetingPassword()

◆ getMeetingRawArchivingController()

◆ getMyUserID()

◆ getMyUserInfo()

◆ getParticipantId()

◆ getUserInfoById()

◆ hideParticipantProfilePictures()

◆ isAutoAllowLocalRecordingRequest()

◆ isFailoverMeeting()

◆ isFocusModeEnabled()

◆ isFocusModeOn()

◆ isHostUser()

◆ isInWaitingRoom()

◆ isLiveTranscriptLegalNoticeAvailable()