Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
InMeetingService.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3import android.app.Activity;
4
5import java.util.List;
6
10public interface InMeetingService {
11
18
25
32
39
46
53
60
67
74
81
88
95
102
109
110
117
124
131
138
145
152
159
167 @Deprecated
169
176
183
190
197
204
211
218
224 public boolean isMeetingConnected();
225
231 public boolean isMeetingLocked();
232
239 public MobileRTCSDKError lockMeeting(boolean isLock);
240
241
248
256 public MobileRTCSDKError changeName(String inputName, long userId);
257
263 public List<Long> getInMeetingUserList();
264
270 public long getMyUserID();
271
277 public long getParticipantId();
278
285
293
302 public MobileRTCSDKError makeHost(long userId);
303
311 public boolean canReclaimHost();
312
321
330 public MobileRTCSDKError assignCohost(long userId);
331
340 public MobileRTCSDKError assignCoHostWithAssetsPrivilege(long userId, List<GrantCoOwnerAssetsInfo> infoList);
341
350 public MobileRTCSDKError makeHostWithAssetsPrivilege(long userId, List<GrantCoOwnerAssetsInfo> infoList);
351
358 public boolean canBeCohost(long userId);
359
366 public boolean canBeCoOwner(long userId);
367
376 public MobileRTCSDKError revokeCohost(long userId);
377
386 public MobileRTCSDKError removeUser(long userId);
387
395
401 public boolean isPlayChimeOn();
402
410 @Deprecated
411 public long activeShareUserID();
412
419 public boolean isHostUser(long userId);
420
427 public boolean isMyself(long userId);
428
435
442 public MobileRTCSDKError lowerHand(long userId);
443
450 public MobileRTCSDKError lowerAllHands(boolean forWebinarAttendees);
451
457 public boolean isMeetingHost();
458
464 public void leaveCurrentMeeting(boolean endIfPossible);
465
469 //public void cleanupMeetingInstance();
470
476 public String getCurrentMeetingID();
477
484
485
491 public String getCurrentMeetingTopic();
492
498 public String getCurrentMeetingUrl();
499
506
513
519 public boolean isFailoverMeeting();
520
528 public int querySessionNetworkStatus(EnumComponentType type, boolean bSending);
529
536 public boolean claimHostWithHostKey(String hostKey);
537
543 public boolean isWebinarMeeting();
544
551 public void showZoomParticipantsUI(Activity activity, int requestCode);
552
559 public void showZoomChatUI(Activity activity, int requestCode);
560
567 public void showZoomQAUI(Activity activity, int requestCode);
568
574 public String getMeetingPassword();
575
582 public MobileRTCSDKError setMeetingTopic(String topic);
583
591
598
606
613
619 public boolean isInWaitingRoom();
620
627
634
641
649 boolean updatePermissions(String[] permissions, int[] grantResults);
650
657
664
672
679
687
694
701
709
710
717
725
726
735
743
750
757
764
772
778 boolean isFocusModeOn();
779
786
794
801
808
816
823
830
838
845 List<Long> getAuthorizedBotListByUserID(long userid);
846
853
861
868 MobileRTCSDKError updateVirtualNameTagRosterInfo(List<ZoomSDKVirtualNameTag> nameTags);
869
877
884 List<Long> getCompanionChildList(long userid);
885}
Enumeration of the focus mode share type. For more information, please visit https://support....
Enumeration of common SDK errors.
Question and answer(QA) controller in webinar.
Remote controller interface in meeting.
Interfaces of Zoom services in meeting.
MobileRTCSDKError allowParticipantsToRequestCloudRecording(boolean bAllow)
Sets whether attendees are able to send requests for the host to start a cloud recording....
String getCurrentMeetingInviteEmailSubject()
Gets the subject of email invitation for the current meeting.
boolean isWebinarMeeting()
Determines whether the current meeting is a webinar.
InMeetingShareController getInMeetingShareController()
Gets the share controller instance in meeting.
MobileRTCSDKError allowParticipantsToRequestLocalRecording(boolean allow)
Allows participants to request local recording.
InMeetingDocsController getInMeetingDocsController()
Gets the docs controller instance.
void leaveCurrentMeeting(boolean endIfPossible)
Leaves the current meeting.
boolean isSelfOriginalHost()
Determines whether the current user is the original host.
String getInMeetingDataCenterInfo()
Gets data center details.
boolean isParticipantsUnmuteSelfAllowed()
Determines whether participants are allowed to unmute themselves.
boolean isParticipantProfilePicturesHidden()
Determines whether the current meeting hides participant pictures.
List< Long > getInMeetingUserList()
Gets the list of all participants in the meeting.
boolean claimHostWithHostKey(String hostKey)
Claims to be a host by host key.
MobileRTCSDKError turnFocusModeOn(boolean on)
Turns focus mode on or off. Focus mode on means participants only see hosts' videos and shared conten...
boolean isParticipantRequestLocalRecordingAllowed()
Determines whether the current meeting allows participants to send local recording privilege requests...
MobileRTCSDKError allowParticipantsToRename(boolean allow)
Allows participants to rename themselves.
MobileRTCSDKError lowerHand(long userId)
The current user puts hands down.
boolean isMeetingHost()
Determines whether the current user is the host of the meeting.
void showZoomChatUI(Activity activity, int requestCode)
Shows the views of Zoom meeting chat.
InMeetingIndicatorController getInMeetingIndicatorController()
Gets the indicator controller instance.
MobileRTCSDKError assignCohost(long userId)
Assigns a user as co-host in the meeting.
InMeetingUserInfo getBotAuthorizedUserInfoByUserID(long botUserId)
Gets the information about the robot's authorized user.
boolean isFailoverMeeting()
Determines whether the current meeting is failover.
MobileRTCSDKError lowerAllHands(boolean forWebinarAttendees)
Cancels all hands raised.
long getCurrentMeetingNumber()
Gets the current meeting number in format such as 123456789.
InMeetingUserInfo getCompanionParentUser(long userid)
Gets the information about the user's parent user.
boolean isAutoAllowLocalRecordingRequest()
Determines whether the current meeting auto-grants participants local recording privilege requests....
InMeetingSmartSummaryController getInMeetingSmartSummaryController()
Gets the smart summary controller instance.
MobileRTCSDKError removeUser(long userId)
Removes a user from the meeting.
InMeetingLiveStreamController getInMeetingLiveStreamController()
Gets the live-streaming controller instance in meeting.
String getCurrentMeetingInviteEmailContent()
Gets the content of email invitation for the current meeting.
String getMeetingPassword()
Gets the current meeting's password.
InMeetingChatController getInMeetingChatController()
Gets the chat controller instance in meeting.
InMeetingAICompanionController getInMeetingAICompanionController()
Gets the AI Companion controller instance.
void addListener(InMeetingServiceListener listener)
Registers a listener for in-meeting events.
boolean updatePermissions(String[] permissions, int[] grantResults)
Notifies the SDK that the corresponding permissions have been granted.
boolean isHostUser(long userId)
Determines whether the user is the host.
InMeetingProductionStudioController getInMeetingProductionStudioController()
Gets the Production Studio controller instance.
MobileRTCSDKError allowParticipantsToUnmuteSelf(boolean allow)
Allows participants to unmute themselves.
boolean isMyself(long userId)
Determines whether the owner of the ID is the current user himself.
InMeetingWebinarController getInMeetingWebinarController()
Gets the webinar controller instance in meeting.
MobileRTCSDKError lockMeeting(boolean isLock)
Locks or unlocks the current meeting. The host or co-host can use this function.
boolean canBeCohost(long userId)
Determines whether the user can be assigned as co-host in the meeting.
String getLiveTranscriptLegalNoticesPrompt()
Gets the live transcript legal notice prompt.
MobileRTCSDKError suspendParticipantsActivities()
Suspends all participant activities.
InMeetingLiveTranscriptionController getInMeetingLiveTranscriptionController()
Gets the live transcription controller instance.
boolean isFocusModeOn()
Determines whether focus mode is on.
MobileRTCSDKError reclaimHost()
Reclaims host permission.
IEmojiReactionController getEmojiReactionController()
Gets the emoji reaction controller instance.
boolean canEnableParticipantRequestCloudRecording()
Determines whether the current user can enable participant request cloud recording.
boolean isSupportVirtualNameTag()
Determines whether the virtual name tag feature is supported.
InMeetingWhiteboardController getInMeetingWhiteboardController()
Gets the new whiteboard controller instance.
MobileRTCSDKError allowParticipantsToStartVideo(boolean allow)
Allows participants to start video.
MobileRTCSDKError setFocusModeShareType(MobileRTCFocusModeShareType shareType)
Sets the focus mode type indicating who can see the shared content which is controlled by the host or...
String getLiveTranscriptLegalNoticesExplained()
Gets the explained text for live transcript legal notice.
MobileRTCSDKError canHideParticipantProfilePictures()
Determines whether the current user can hide participant profile pictures.
long activeShareUserID()
Gets the ID of the active presenter in the meeting.
boolean canSuspendParticipantsActivities()
Determines whether it is allowed to suspend the meeting.
boolean isLiveTranscriptLegalNoticeAvailable()
Determines whether live transcript legal notice is available.
InMeetingUserInfo getUserInfoById(long userId)
Gets the information of the specified user.
List< Long > getAuthorizedBotListByUserID(long userid)
Gets the authorizer's robot list.
boolean isParticipantRequestCloudRecordingAllowed()
Determines whether the current meeting allows participants to send cloud recording start requests....
MobileRTCSDKError makeHostWithAssetsPrivilege(long userId, List< GrantCoOwnerAssetsInfo > infoList)
Assigns a user as host and grants privileges to manage assets after the meeting.
MobileRTCSDKError assignCoHostWithAssetsPrivilege(long userId, List< GrantCoOwnerAssetsInfo > infoList)
Assigns a user as co-host and grants privileges to manage assets after the meeting.
void showZoomQAUI(Activity activity, int requestCode)
Shows the views of Zoom questions and answers.
MobileRTCSDKError changeName(String inputName, long userId)
Renames a user in the meeting.
MobileRTCSDKError revokeCohost(long userId)
Revokes the co-host role of a user in the meeting.
int getInMeetingUserCount()
Gets the number of participants in the meeting.
long getMyUserID()
Gets the current user's ID in the meeting.
InMeetingWaitingRoomController getInMeetingWaitingRoomController()
Gets the waiting room controller instance in meeting.
String getCurrentMeetingID()
Gets the unique ID of the current meeting in format such as DVLObefSZizM0xQLhtrCQ==.
MobileRTCSDKError enableVirtualNameTag(boolean bEnabled)
Enables or disables the virtual name tag feature for the account.
InMeetingRemoteController getInMeetingRemoteController()
Gets the remote controller instance in meeting.
boolean isMeetingLocked()
Determines whether the meeting is locked by the host.
InMeetingVirtualBackgroundController getInMeetingVirtualBackgroundController()
Gets the virtual background controller instance.
MobileRTCSDKError allowParticipantsToShareWhiteBoard(boolean allow)
Allows participants to share whiteboard.
InMeetingInterpretationController getInMeetingInterpretationController()
Gets the interpretation controller instance.
boolean isMeetingConnected()
Determines whether the meeting is connected.
MobileRTCSDKError raiseMyHand()
The current user raises hand.
boolean isParticipantsShareWhiteBoardAllowed()
Determines whether participants are allowed to share whiteboard.
MobileRTCSDKError hideParticipantProfilePictures(boolean hide)
Hides or shows participant profile pictures.
boolean isParticipantsStartVideoAllowed()
Determines whether participants are allowed to start video.
InMeetingQAController getInMeetingQAController()
Gets the QA controller instance in meeting.
MobileRTCSDKError setMeetingTopic(String topic)
Sets a customized meeting topic in the meeting. Only the original host has this permission.
InMeetingVideoController getInMeetingVideoController()
Gets the video controller instance in meeting.
InMeetingAudioController getInMeetingAudioController()
Gets the audio controller instance in meeting.
InMeetingUserInfo getMyUserInfo()
Gets the information of the current user in the meeting.
boolean canReclaimHost()
Determines whether the user can reclaim host.
MobileRTCSDKError makeHost(long userId)
Assigns a user as the host in the meeting.
long getParticipantId()
Gets the current user's participant ID.
boolean canSetMeetingTopic()
Determines whether the host or cohost can change the meeting topic.
boolean canBeCoOwner(long userId)
Determines whether the user can be assigned as co-owner in the meeting. Co-owner can be granted privi...
boolean isInWaitingRoom()
Determines whether the current user is in the waiting room.
String getCurrentMeetingTopic()
Gets the topic or title of the current meeting.
InMeetingBOController getInMeetingBOController()
Gets the breakout room controller instance in meeting.
void removeListener(InMeetingServiceListener listener)
Unregisters the listener for in-meeting events.
MobileRTCSDKError autoAllowLocalRecordingRequest(boolean allow)
Sets whether to auto-allow participant local recording requests.
String getCurrentMeetingUrl()
Gets the URL of the current meeting.
InMeetingAnnotationController getInMeetingAnnotationController()
Gets the annotation controller instance in meeting.
void showZoomParticipantsUI(Activity activity, int requestCode)
Shows the views of Zoom meeting participants.
InMeetingCloudRecordController getInMeetingCloudRecordController()
Gets the cloud recording controller instance in meeting.
MobileRTCSDKError updateVirtualNameTagRosterInfo(List< ZoomSDKVirtualNameTag > nameTags)
Updates the virtual name tag roster information for the account.
boolean isFocusModeEnabled()
Determines whether focus mode is enabled by the web portal.
InMeetingAANController getInMeetingAANController()
Gets the AAN controller instance.
MobileRTCFocusModeShareType getFocusModeShareType()
Gets the share focus mode type indicating who can see the shared content which is controlled by the h...
boolean isParticipantsRenameAllowed()
Determines whether participants are allowed to rename themselves.
InMeetingPollingController getInMeetingPollingController()
Gets the polling controller instance.
InMeetingSignInterpretationController getInMeetingSignInterpretationController()
Gets the sign interpretation controller instance.
InMeetingEncryptionController getInMeetingEncryptionController()
Gets the encryption controller instance.
boolean isPlayChimeOn()
Determines whether chime is enabled when a user joins or leaves the meeting.
MobileRTCSDKError setPlayChimeOnOff(boolean on)
Sets whether to play a chime when a user joins or leaves the meeting.
List< Long > getCompanionChildList(long userid)
Gets the user's child list.
InMeetingRawArchivingController getMeetingRawArchivingController()
Gets the raw archiving controller instance.
int querySessionNetworkStatus(EnumComponentType type, boolean bSending)
Queries the network status of the current meeting.
User information object in Zoom meeting.