Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.InMeetingService Interface Reference

Interfaces of Zoom services in meeting. More...

Public Member Functions

void addListener (InMeetingServiceListener listener)
 Registers a listener for in-meeting events.
void removeListener (InMeetingServiceListener listener)
 Unregisters the listener for in-meeting events.
InMeetingAudioController getInMeetingAudioController ()
 Gets the audio controller instance in meeting.
InMeetingVideoController getInMeetingVideoController ()
 Gets the video controller instance in meeting.
InMeetingShareController getInMeetingShareController ()
 Gets the share controller instance in meeting.
InMeetingChatController getInMeetingChatController ()
 Gets the chat controller instance in meeting.
InMeetingAnnotationController getInMeetingAnnotationController ()
 Gets the annotation controller instance in meeting.
InMeetingCloudRecordController getInMeetingCloudRecordController ()
 Gets the cloud recording controller instance in meeting.
InMeetingQAController getInMeetingQAController ()
 Gets the QA controller instance in meeting.
InMeetingWaitingRoomController getInMeetingWaitingRoomController ()
 Gets the waiting room controller instance in meeting.
InMeetingRemoteController getInMeetingRemoteController ()
 Gets the remote controller instance in meeting.
InMeetingLiveStreamController getInMeetingLiveStreamController ()
 Gets the live-streaming controller instance in meeting.
InMeetingWebinarController getInMeetingWebinarController ()
 Gets the webinar controller instance in meeting.
InMeetingBOController getInMeetingBOController ()
 Gets the breakout room controller instance in meeting.
InMeetingInterpretationController getInMeetingInterpretationController ()
 Gets the interpretation controller instance.
InMeetingSignInterpretationController getInMeetingSignInterpretationController ()
 Gets the sign interpretation controller instance.
IEmojiReactionController getEmojiReactionController ()
 Gets the emoji reaction controller instance.
InMeetingAANController getInMeetingAANController ()
 Gets the AAN controller instance.
InMeetingLiveTranscriptionController getInMeetingLiveTranscriptionController ()
 Gets the live transcription controller instance.
InMeetingVirtualBackgroundController getInMeetingVirtualBackgroundController ()
 Gets the virtual background controller instance.
InMeetingRawArchivingController getMeetingRawArchivingController ()
 Gets the raw archiving controller instance.
InMeetingSmartSummaryController getInMeetingSmartSummaryController ()
 Gets the smart summary controller instance.
InMeetingWhiteboardController getInMeetingWhiteboardController ()
 Gets the new whiteboard controller instance.
InMeetingEncryptionController getInMeetingEncryptionController ()
 Gets the encryption controller instance.
InMeetingPollingController getInMeetingPollingController ()
 Gets the polling controller instance.
InMeetingAICompanionController getInMeetingAICompanionController ()
 Gets the AI Companion controller instance.
InMeetingIndicatorController getInMeetingIndicatorController ()
 Gets the indicator controller instance.
InMeetingProductionStudioController getInMeetingProductionStudioController ()
 Gets the Production Studio controller instance.
InMeetingDocsController getInMeetingDocsController ()
 Gets the docs controller instance.
boolean isMeetingConnected ()
 Determines whether the meeting is connected.
boolean isMeetingLocked ()
 Determines whether the meeting is locked by the host.
MobileRTCSDKError lockMeeting (boolean isLock)
 Locks or unlocks the current meeting. The host or co-host can use this function.
int getInMeetingUserCount ()
 Gets the number of participants in the meeting.
MobileRTCSDKError changeName (String inputName, long userId)
 Renames a user in the meeting.
List< Long > getInMeetingUserList ()
 Gets the list of all participants in the meeting.
long getMyUserID ()
 Gets the current user's ID in the meeting.
long getParticipantId ()
 Gets the current user's participant ID.
InMeetingUserInfo getMyUserInfo ()
 Gets the information of the current user in the meeting.
InMeetingUserInfo getUserInfoById (long userId)
 Gets the information of the specified user.
MobileRTCSDKError makeHost (long userId)
 Assigns a user as the host in the meeting.
boolean canReclaimHost ()
 Determines whether the user can reclaim host.
MobileRTCSDKError reclaimHost ()
 Reclaims host permission.
MobileRTCSDKError assignCohost (long userId)
 Assigns a user as co-host in the meeting.
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)
 Determines whether the user can be assigned as co-host in the meeting.
boolean canBeCoOwner (long userId)
 Determines whether the user can be assigned as co-owner in the meeting. Co-owner can be granted privilege to manage some assets after the meeting.
MobileRTCSDKError revokeCohost (long userId)
 Revokes the co-host role of a user in the meeting.
MobileRTCSDKError removeUser (long userId)
 Removes a user from the meeting.
MobileRTCSDKError setPlayChimeOnOff (boolean on)
 Sets whether to play a chime when a user joins or leaves the meeting.
boolean isPlayChimeOn ()
 Determines whether chime is enabled when a user joins or leaves the meeting.
long activeShareUserID ()
 Gets the ID of the active presenter in the meeting.
boolean isHostUser (long userId)
 Determines whether the user is the host.
boolean isMyself (long userId)
 Determines whether the owner of the ID is the current user himself.
MobileRTCSDKError raiseMyHand ()
 The current user raises hand.
MobileRTCSDKError lowerHand (long userId)
 The current user puts hands down.
MobileRTCSDKError lowerAllHands (boolean forWebinarAttendees)
 Cancels all hands raised.
boolean isMeetingHost ()
 Determines whether the current user is the host of the meeting.
void leaveCurrentMeeting (boolean endIfPossible)
 Leaves the current meeting.
String getCurrentMeetingID ()
 Gets the unique ID of the current meeting in format such as DVLObefSZizM0xQLhtrCQ==.
long getCurrentMeetingNumber ()
 Gets the current meeting number in format such as 123456789.
String getCurrentMeetingTopic ()
 Gets the topic or title of the current meeting.
String getCurrentMeetingUrl ()
 Gets the URL of the current meeting.
String getCurrentMeetingInviteEmailSubject ()
 Gets the subject of email invitation for the current meeting.
String getCurrentMeetingInviteEmailContent ()
 Gets the content of email invitation for the current meeting.
boolean isFailoverMeeting ()
 Determines whether the current meeting is failover.
int querySessionNetworkStatus (EnumComponentType type, boolean bSending)
 Queries the network status of the current meeting.
boolean claimHostWithHostKey (String hostKey)
 Claims to be a host by host key.
boolean isWebinarMeeting ()
 Determines whether the current meeting is a webinar.
void showZoomParticipantsUI (Activity activity, int requestCode)
 Shows the views of Zoom meeting participants.
void showZoomChatUI (Activity activity, int requestCode)
 Shows the views of Zoom meeting chat.
void showZoomQAUI (Activity activity, int requestCode)
 Shows the views of Zoom questions and answers.
String getMeetingPassword ()
 Gets the current meeting's password.
MobileRTCSDKError setMeetingTopic (String topic)
 Sets a customized meeting topic in the meeting. Only the original host has this permission.
MobileRTCSDKError allowParticipantsToRename (boolean allow)
 Allows participants to rename themselves.
boolean isParticipantsRenameAllowed ()
 Determines whether participants are allowed to rename themselves.
MobileRTCSDKError allowParticipantsToUnmuteSelf (boolean allow)
 Allows participants to unmute themselves.
boolean isParticipantsUnmuteSelfAllowed ()
 Determines whether participants are allowed to unmute themselves.
boolean isInWaitingRoom ()
 Determines whether the current user is in the waiting room.
boolean isLiveTranscriptLegalNoticeAvailable ()
 Determines whether live transcript legal notice is available.
String getLiveTranscriptLegalNoticesPrompt ()
 Gets the live transcript legal notice prompt.
String getLiveTranscriptLegalNoticesExplained ()
 Gets the explained text for live transcript legal notice.
boolean updatePermissions (String[] permissions, int[] grantResults)
 Notifies the SDK that the corresponding permissions have been granted.
MobileRTCSDKError suspendParticipantsActivities ()
 Suspends all participant activities.
boolean canSuspendParticipantsActivities ()
 Determines whether it is allowed to suspend the meeting.
MobileRTCSDKError allowParticipantsToStartVideo (boolean allow)
 Allows participants to start video.
boolean isParticipantsStartVideoAllowed ()
 Determines whether participants are allowed to start video.
MobileRTCSDKError allowParticipantsToShareWhiteBoard (boolean allow)
 Allows participants to share whiteboard.
boolean isParticipantsShareWhiteBoardAllowed ()
 Determines whether participants are allowed to share whiteboard.
boolean isParticipantRequestLocalRecordingAllowed ()
 Determines whether the current meeting allows participants to send local recording privilege requests. It is only available in regular meetings (no webinar or breakout room).
MobileRTCSDKError allowParticipantsToRequestLocalRecording (boolean allow)
 Allows participants to request local recording.
boolean isAutoAllowLocalRecordingRequest ()
 Determines whether the current meeting auto-grants participants local recording privilege requests. It is only available in regular meetings (no webinar or breakout room).
MobileRTCSDKError autoAllowLocalRecordingRequest (boolean allow)
 Sets whether to auto-allow participant local recording requests.
MobileRTCSDKError canHideParticipantProfilePictures ()
 Determines whether the current user can hide participant profile pictures.
MobileRTCSDKError hideParticipantProfilePictures (boolean hide)
 Hides or shows participant profile pictures.
boolean isParticipantProfilePicturesHidden ()
 Determines whether the current meeting hides participant pictures.
String getInMeetingDataCenterInfo ()
 Gets data center details.
boolean isFocusModeEnabled ()
 Determines whether focus mode is enabled by the web portal.
MobileRTCSDKError turnFocusModeOn (boolean on)
 Turns focus mode on or off. Focus mode on means participants only see hosts' videos and shared content, and videos of spotlighted participants.
boolean isFocusModeOn ()
 Determines whether focus mode is on.
MobileRTCFocusModeShareType getFocusModeShareType ()
 Gets the share focus mode type indicating who can see the shared content which is controlled by the host or co-host.
MobileRTCSDKError setFocusModeShareType (MobileRTCFocusModeShareType shareType)
 Sets the focus mode type indicating who can see the shared content which is controlled by the host or co-host.
boolean canEnableParticipantRequestCloudRecording ()
 Determines whether the current user can enable participant request cloud recording.
boolean isParticipantRequestCloudRecordingAllowed ()
 Determines whether the current meeting allows participants to send cloud recording start requests. This is only available in regular meetings and webinars (no breakout rooms).
MobileRTCSDKError allowParticipantsToRequestCloudRecording (boolean bAllow)
 Sets whether attendees are able to send requests for the host to start a cloud recording. This is only available in regular meetings and webinars (no breakout rooms).
boolean isSelfOriginalHost ()
 Determines whether the current user is the original host.
boolean canSetMeetingTopic ()
 Determines whether the host or cohost can change the meeting topic.
InMeetingUserInfo getBotAuthorizedUserInfoByUserID (long botUserId)
 Gets the information about the robot's authorized user.
List< Long > getAuthorizedBotListByUserID (long userid)
 Gets the authorizer's robot list.
boolean isSupportVirtualNameTag ()
 Determines whether the virtual name tag feature is supported.
MobileRTCSDKError enableVirtualNameTag (boolean bEnabled)
 Enables or disables the virtual name tag feature for the account.
MobileRTCSDKError updateVirtualNameTagRosterInfo (List< ZoomSDKVirtualNameTag > nameTags)
 Updates the virtual name tag roster information for the account.
InMeetingUserInfo getCompanionParentUser (long userid)
 Gets the information about the user's parent user.
List< Long > getCompanionChildList (long userid)
 Gets the user's child list.

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 ( )

Gets the ID of the active presenter in the meeting.

Returns
If the function succeeds, it returns the ID of the active presenter. 0 means no one is sharing.
Deprecated
The share user ID should be got from InMeetingShareController.InMeetingShareListener.onSharingStatus.

◆ addListener()

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

Registers a listener for in-meeting events.

Parameters
listenerThe listener instance.

◆ allowParticipantsToRename()

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

Allows participants to rename themselves.

Parameters
allowtrue to allow, false to disallow.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ allowParticipantsToRequestCloudRecording()

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

Sets whether attendees are able to send requests for the host to start a cloud recording. This is only available in regular meetings and webinars (no breakout rooms).

Parameters
bAllowtrue to allow participants to send cloud recording privilege requests, false otherwise.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ allowParticipantsToRequestLocalRecording()

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

Allows participants to request local recording.

Parameters
allowtrue to allow, false to disallow.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ allowParticipantsToShareWhiteBoard()

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

Allows participants to share whiteboard.

Parameters
allowtrue to allow, false to disallow.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ allowParticipantsToStartVideo()

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

Allows participants to start video.

Parameters
allowtrue to allow, false to disallow.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ allowParticipantsToUnmuteSelf()

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

Allows participants to unmute themselves.

Parameters
allowtrue to allow, false to disallow.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ assignCohost()

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

Assigns a user as co-host in the meeting.

Parameters
userIdThe user's ID who is specified as co-host in the meeting.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
The co-host cannot be assigned as co-host by himself. 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
userIdThe ID of user to be assigned as co-host.
infoListA 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)

Sets whether to auto-allow participant local recording requests.

Parameters
allowtrue to enable auto-allow, false to disable.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ canBeCohost()

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

Determines whether the user can be assigned as co-host in the meeting.

Parameters
userIdThe ID of the user who is assigned as co-host in the meeting.
Returns
true if the user can be assigned as co-host. Otherwise, false.

◆ canBeCoOwner()

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

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

Parameters
userIdThe ID of the user who is assigned as co-owner in the meeting.
Returns
true if the user can be assigned as co-owner. Otherwise, false.

◆ canEnableParticipantRequestCloudRecording()

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

Determines whether the current user can enable participant request cloud recording.

Returns
true if the current user can enable participant request cloud recording. Otherwise, false.

◆ canHideParticipantProfilePictures()

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

Determines whether the current user can hide participant profile pictures.

Note
This feature is influenced by focus mode change.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ canReclaimHost()

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

Determines whether the user can reclaim host.

Returns
true if the user can reclaim host. Otherwise, false.
Note
Only the user who is the original host, but not the host now, can reclaim host.

◆ canSetMeetingTopic()

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

Determines whether the host or cohost can change the meeting topic.

Returns
true if the host or cohost can change the meeting topic. Otherwise, false.

◆ canSuspendParticipantsActivities()

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

Determines whether it is allowed to suspend the meeting.

Returns
true if it can suspend. Otherwise, false.

◆ changeName()

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

Renames a user in the meeting.

Parameters
inputNameThe new screen name for the user in the meeting.
userIdThe user's ID whose screen name will be changed in the meeting.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ claimHostWithHostKey()

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

Claims to be a host by host key.

Parameters
hostKeyHost key got from web.
Returns
true if the function succeeds. Otherwise, false.

◆ enableVirtualNameTag()

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

Enables or disables the virtual name tag feature for the account.

Parameters
bEnabledtrue to enable, false otherwise.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ getAuthorizedBotListByUserID()

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

Gets the authorizer's robot list.

Parameters
useridThe user's ID for which you want to get the information.
Returns
If the function succeeds, it returns the authorizer's robot list in the meeting. Otherwise, this function fails and returns null. Valid for both Zoom style and user custom interface mode.

◆ getBotAuthorizedUserInfoByUserID()

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

Gets the information about the robot's authorized user.

Parameters
botUserIdThe user's ID for which to get the information.
Returns
If the function succeeds, it returns the user info. Otherwise, this function fails and returns null.

◆ getCompanionChildList()

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

Gets the user's child list.

Parameters
useridThe user's ID for which to get the information.
Returns
If the function succeeds, it returns the sub-user list of user companion mode. Otherwise, this function fails and returns null.

◆ getCompanionParentUser()

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

Gets the information about the user's parent user.

Parameters
useridThe user's ID for which to get the information.
Returns
If the function succeeds, it returns the user info. Otherwise, this function fails and returns null.

◆ getCurrentMeetingID()

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

Gets the unique ID of the current meeting in format such as DVLObefSZizM0xQLhtrCQ==.

Clean up meeting instance.

Returns
If the function succeeds, it returns the current meeting ID. Otherwise, this function fails and returns null.

◆ getCurrentMeetingInviteEmailContent()

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

Gets the content of email invitation for the current meeting.

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

◆ getCurrentMeetingInviteEmailSubject()

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

Gets the subject of email invitation for the current meeting.

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

◆ getCurrentMeetingNumber()

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

Gets the current meeting number in format such as 123456789.

Returns
If the function succeeds, it returns the current meeting number. Otherwise, this function fails and returns 0.

◆ getCurrentMeetingTopic()

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

Gets the topic or title of the current meeting.

Returns
If the function succeeds, it returns the topic or title. Otherwise, this function fails and returns null.

◆ getCurrentMeetingUrl()

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

Gets the URL of the current meeting.

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

◆ getEmojiReactionController()

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

Gets the emoji reaction controller instance.

Returns
If the function succeeds, it returns the emoji reaction controller instance. Otherwise, this function fails and returns null.

◆ getFocusModeShareType()

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

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

Returns
If the function succeeds, it returns the current share focus mode type. Otherwise, this function fails and returns null.

◆ getInMeetingAANController()

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

Gets the AAN controller instance.

Returns
If the function succeeds, it returns the AAN controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingAICompanionController()

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

Gets the AI Companion controller instance.

Returns
If the function succeeds, it returns the AI Companion controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingAnnotationController()

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

Gets the annotation controller instance in meeting.

Returns
If the function succeeds, it returns the annotation controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingAudioController()

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

Gets the audio controller instance in meeting.

Returns
If the function succeeds, it returns the audio controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingBOController()

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

Gets the breakout room controller instance in meeting.

Returns
If the function succeeds, it returns the breakout room controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingChatController()

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

Gets the chat controller instance in meeting.

Returns
If the function succeeds, it returns the chat controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingCloudRecordController()

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

Gets the cloud recording controller instance in meeting.

Returns
If the function succeeds, it returns the cloud recording controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingDataCenterInfo()

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

Gets data center details.

Returns
If the function succeeds, it returns the data center details. Otherwise, this function fails and returns null.

◆ getInMeetingDocsController()

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

Gets the docs controller instance.

Returns
If the function succeeds, it returns the docs controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingEncryptionController()

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

Gets the encryption controller instance.

Returns
If the function succeeds, it returns the encryption controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingIndicatorController()

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

Gets the indicator controller instance.

Returns
If the function succeeds, it returns the indicator controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingInterpretationController()

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

Gets the interpretation controller instance.

Returns
If the function succeeds, it returns the interpretation controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingLiveStreamController()

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

Gets the live-streaming controller instance in meeting.

Returns
If the function succeeds, it returns the live-streaming controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingLiveTranscriptionController()

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

Gets the live transcription controller instance.

Returns
If the function succeeds, it returns the live transcription controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingPollingController()

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

Gets the polling controller instance.

Returns
If the function succeeds, it returns the polling controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingProductionStudioController()

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

Gets the Production Studio controller instance.

Returns
If the function succeeds, it returns the Production Studio controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingQAController()

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

Gets the QA controller instance in meeting.

Returns
If the function succeeds, it returns the QA controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingRemoteController()

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

Gets the remote controller instance in meeting.

Returns
If the function succeeds, it returns the remote controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingShareController()

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

Gets the share controller instance in meeting.

Returns
If the function succeeds, it returns the share controller instance. Otherwise, this function fails and returns null.

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

◆ getInMeetingSignInterpretationController()

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

Gets the sign interpretation controller instance.

Returns
If the function succeeds, it returns the sign interpretation controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingSmartSummaryController()

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

Gets the smart summary controller instance.

Returns
If the function succeeds, it returns the smart summary controller instance. Otherwise, this function fails and returns null.
Deprecated
Use InMeetingAICompanionController.getInMeetingSmartSummaryController instead.

◆ getInMeetingUserCount()

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

Gets the number of participants in the meeting.

Returns
If the function succeeds, it returns the number of participants. Otherwise, this function fails and returns 0.

◆ getInMeetingUserList()

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

Gets the list of all participants in the meeting.

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

◆ getInMeetingVideoController()

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

Gets the video controller instance in meeting.

Returns
If the function succeeds, it returns the video controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingVirtualBackgroundController()

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

Gets the virtual background controller instance.

Returns
If the function succeeds, it returns the virtual background controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingWaitingRoomController()

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

Gets the waiting room controller instance in meeting.

Returns
If the function succeeds, it returns the waiting room controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingWebinarController()

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

Gets the webinar controller instance in meeting.

Returns
If the function succeeds, it returns the webinar controller instance. Otherwise, this function fails and returns null.

◆ getInMeetingWhiteboardController()

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

Gets the new whiteboard controller instance.

Returns
If the function succeeds, it returns the whiteboard controller instance. Otherwise, this function fails and returns null.

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

◆ getLiveTranscriptLegalNoticesExplained()

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

Gets the explained text for live transcript legal notice.

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

◆ getLiveTranscriptLegalNoticesPrompt()

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

Gets the live transcript legal notice prompt.

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

◆ getMeetingPassword()

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

Gets the current meeting's password.

Returns
If the function succeeds, it returns the current meeting's password. Otherwise, this function fails and returns null.

◆ getMeetingRawArchivingController()

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

Gets the raw archiving controller instance.

Returns
If the function succeeds, it returns the raw archiving controller instance. Otherwise, this function fails and returns null.

◆ getMyUserID()

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

Gets the current user's ID in the meeting.

Returns
If the function succeeds, it returns the current user's ID. Otherwise, this function fails and returns 0.

◆ getMyUserInfo()

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

Gets the information of the current user in the meeting.

Returns
If the function succeeds, it returns the information of the current user. Otherwise, this function fails and returns null.

◆ getParticipantId()

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

Gets the current user's participant ID.

Returns
If the function succeeds, it returns the current user's participant ID. Otherwise, this function fails and returns 0.

◆ getUserInfoById()

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

Gets the information of the specified user.

Parameters
userIdThe specified user's ID.
Returns
If the function succeeds, it returns the information of the specified user. Otherwise, this function fails and returns null.

◆ hideParticipantProfilePictures()

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

Hides or shows participant profile pictures.

Parameters
hidetrue to hide participant profile pictures, false to show participant pictures.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ isAutoAllowLocalRecordingRequest()

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

Determines whether the current meeting auto-grants participants local recording privilege requests. It is only available in regular meetings (no webinar or breakout room).

Returns
true if auto-grant is enabled. Otherwise, false.

◆ isFailoverMeeting()

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

Determines whether the current meeting is failover.

Returns
true if the current meeting is failover. Otherwise, false.

◆ isFocusModeEnabled()

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

Determines whether focus mode is enabled by the web portal.

Returns
true if focus mode is enabled. Otherwise, false.

◆ isFocusModeOn()

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

Determines whether focus mode is on.

Returns
true if focus mode is on. Otherwise, false.

◆ isHostUser()

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

Determines whether the user is the host.

Parameters
userIdThe user's ID to be checked.
Returns
true if the user is the host. Otherwise, false.

◆ isInWaitingRoom()

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

Determines whether the current user is in the waiting room.

Returns
true if the current user is in the waiting room. Otherwise, false.

◆ isLiveTranscriptLegalNoticeAvailable()

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

Determines whether live transcript legal notice is available.

Returns
true if live transcript legal notice is available. Otherwise, false.

◆ isMeetingConnected()

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

Determines whether the meeting is connected.

Returns
true if the meeting is connected. Otherwise, false.

◆ isMeetingHost()

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

Determines whether the current user is the host of the meeting.

Returns
true if the current user is the host of the meeting. Otherwise, false.

◆ isMeetingLocked()

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

Determines whether the meeting is locked by the host.

Returns
true if the meeting is locked. Otherwise, false.

◆ isMyself()

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

Determines whether the owner of the ID is the current user himself.

Parameters
userIdThe user's ID to be checked.
Returns
true if the user is himself. Otherwise, false.

◆ isParticipantProfilePicturesHidden()

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

Determines whether the current meeting hides participant pictures.

Returns
true if participant pictures are hidden. Otherwise, false.

◆ isParticipantRequestCloudRecordingAllowed()

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

Determines whether the current meeting allows participants to send cloud recording start requests. This is only available in regular meetings and webinars (no breakout rooms).

Returns
true if participants are allowed to send requests. Otherwise, false.

◆ isParticipantRequestLocalRecordingAllowed()

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

Determines whether the current meeting allows participants to send local recording privilege requests. It is only available in regular meetings (no webinar or breakout room).

Returns
true if allowed. Otherwise, false.

◆ isParticipantsRenameAllowed()

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

Determines whether participants are allowed to rename themselves.

Returns
true if allowed. Otherwise, false.

◆ isParticipantsShareWhiteBoardAllowed()

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

Determines whether participants are allowed to share whiteboard.

Returns
true if allowed. Otherwise, false.

◆ isParticipantsStartVideoAllowed()

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

Determines whether participants are allowed to start video.

Returns
true if allowed. Otherwise, false.

◆ isParticipantsUnmuteSelfAllowed()

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

Determines whether participants are allowed to unmute themselves.

Returns
true if allowed. Otherwise, false.

◆ isPlayChimeOn()

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

Determines whether chime is enabled when a user joins or leaves the meeting.

Returns
true if enabled. Otherwise, false.

◆ isSelfOriginalHost()

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

Determines whether the current user is the original host.

Returns
true if the current user is the original host. Otherwise, false.

◆ isSupportVirtualNameTag()

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

Determines whether the virtual name tag feature is supported.

Returns
true if the virtual name tag feature is supported. Otherwise, false.

◆ isWebinarMeeting()

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

Determines whether the current meeting is a webinar.

Returns
true if the current meeting is a webinar. Otherwise, false.

◆ leaveCurrentMeeting()

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

Leaves the current meeting.

Parameters
endIfPossibleIf true and the current user is the meeting host, the meeting ends when he clicks the button.

◆ lockMeeting()

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

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

Parameters
isLocktrue to lock the meeting, false to unlock.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ lowerAllHands()

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

Cancels all hands raised.

Parameters
forWebinarAttendeesWhen true, the SDK sends the lower all hands command only to webinar attendees. When 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 returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ lowerHand()

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

The current user puts hands down.

Parameters
userIdThe user's ID to put hands down.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ makeHost()

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

Assigns a user as the host in the meeting.

Parameters
userIdThe user's ID who is specified as host in the meeting.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
The host cannot be assigned as host by himself. 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
userIdThe ID of user to be assigned as host.
infoListA 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 )

Queries the network status of the current meeting.

Parameters
typeComponent types defined in EnumComponentType. Note: only gets the status: AS, VIDEO, or AUDIO.
bSendingtrue to get data sending status, false to get receiving status.
Returns
If the function succeeds, it returns the quality level. Otherwise, this function fails and returns -1.

◆ raiseMyHand()

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

The current user raises hand.

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

◆ reclaimHost()

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

Reclaims host permission.

Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
There is a host in the current meeting, but the host permissions are not in the original's hands. The original calls this interface to reclaim host permissions.

◆ removeListener()

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

Unregisters the listener for in-meeting events.

Parameters
listenerThe listener instance.

◆ removeUser()

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

Removes a user from the meeting.

Parameters
userIdThe ID of the user to be removed from the meeting.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.
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)

Revokes the co-host role of a user in the meeting.

Parameters
userIdThe ID of the user who loses the co-host role.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
The co-host cannot revoke the role himself. The user should have the power to revoke the role.

◆ setFocusModeShareType()

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

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

Parameters
shareTypeThe type of focus mode share type.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ setMeetingTopic()

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

Sets a customized meeting topic in the meeting. Only the original host has this permission.

Parameters
topicThe customized topic.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ setPlayChimeOnOff()

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

Sets whether to play a chime when a user joins or leaves the meeting.

Parameters
ontrue to enable, false to disable.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ showZoomChatUI()

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

Shows the views of Zoom meeting chat.

Parameters
activityMakes calls.
requestCodeReplies a request code.

◆ showZoomParticipantsUI()

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

Shows the views of Zoom meeting participants.

Parameters
activityMakes calls.
requestCodeReplies a request code.

◆ showZoomQAUI()

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

Shows the views of Zoom questions and answers.

Parameters
activityMakes calls.
requestCodeReplies a request code.

◆ suspendParticipantsActivities()

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

Suspends all participant activities.

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

◆ turnFocusModeOn()

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

Turns focus mode on or off. Focus mode on means participants only see hosts' videos and shared content, and videos of spotlighted participants.

Parameters
ontrue to turn on, false to turn off.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ updatePermissions()

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

Notifies the SDK that the corresponding permissions have been granted.

Parameters
permissionsThe permissions.
grantResultsThe grant results (PackageManager.PERMISSION_GRANTED or PackageManager.PERMISSION_DENIED).
Returns
true if the function succeeds. Otherwise, false.

◆ updateVirtualNameTagRosterInfo()

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

Updates the virtual name tag roster information for the account.

Parameters
nameTagsThe virtual name tag roster info list for the specified user. The maximum size of nameTags should be less than 20. User should specify the tagName and tagID of each ZoomSDKVirtualNameTag object. The range of tagID is 0-1024.
Returns
If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.