us.zoom.sdk

Interface InMeetingWaitingRoomController

public interface InMeetingWaitingRoomController

Waiting Room of Meeting Service Interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InMeetingWaitingRoomController.InMeetingWaitingRoomListener Callback Event of Meeting Waiting Room.

Method Summary

Modifier and Type	Method and Description
void	addListener(InMeetingWaitingRoomController.InMeetingWaitingRoomListener listener) Register a listener for meeting waiting room callback.
MobileRTCSDKError	admitToMeeting(long userId) Allow user to join the meeting.
MobileRTCSDKError	enableWaitingRoomOnEntry(boolean bEnable) Enable the feature to put attendees in waiting room when they enter the current meeting.
InMeetingUserInfo	getWaitingRoomUserInfoByID(long userId) Get the information of user who is in the waiting room by user ID.
java.util.List<java.lang.Long>	getWaitingRoomUserLst() Get the list of meeting participants in the waiting room.
boolean	isSupportWaitingRoom() Query if it is able to enable waiting room in the current meeting.
boolean	isSupportWaitingRoomUponEntryFeature() Query if it is able to put attendees in waiting room in current meeting.
boolean	isWaitingRoomOnEntryFlagOn() Query if it is able to make the attendees enter waiting room when they join the current meeting.
MobileRTCSDKError	putInWaitingRoom(long userId) Put user into waiting room.
void	removeListener(InMeetingWaitingRoomController.InMeetingWaitingRoomListener listener) Unregister the listener.

Method Detail

addListener

void addListener(InMeetingWaitingRoomController.InMeetingWaitingRoomListener listener)

Register a listener for meeting waiting room callback.

Parameters:

listener - The listener instance.

removeListener

void removeListener(InMeetingWaitingRoomController.InMeetingWaitingRoomListener listener)

Unregister the listener.

Parameters:

listener - The listener instance

isSupportWaitingRoom

boolean isSupportWaitingRoom()

Query if it is able to enable waiting room in the current meeting.

Returns:

TRUE means supports. FALSE not.

isSupportWaitingRoomUponEntryFeature

boolean isSupportWaitingRoomUponEntryFeature()

Query if it is able to put attendees in waiting room in current meeting.

Returns:

TRUE means able. FALSE not.

isWaitingRoomOnEntryFlagOn

boolean isWaitingRoomOnEntryFlagOn()

Query if it is able to make the attendees enter waiting room when they join the current meeting.

Returns:

TRUE means enabled. FALSE not.

enableWaitingRoomOnEntry

MobileRTCSDKError enableWaitingRoomOnEntry(boolean bEnable)

Enable the feature to put attendees in waiting room when they enter the current meeting.

Parameters:

bEnable - TRUE means to enable waiting room. FALSE not.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

getWaitingRoomUserLst

java.util.List<java.lang.Long> getWaitingRoomUserLst()

Get the list of meeting participants in the waiting room.

Returns:

The ID list of all the participants in the waiting room. If there is nobody in the waiting room, returns NULL.

getWaitingRoomUserInfoByID

InMeetingUserInfo getWaitingRoomUserInfoByID(long userId)

Get the information of user who is in the waiting room by user ID.

Parameters:

userId - The user ID.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

admitToMeeting

MobileRTCSDKError admitToMeeting(long userId)

Allow user to join the meeting.

Parameters:

userId - The ID of user who is allowed to join the meeting.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

putInWaitingRoom

MobileRTCSDKError putInWaitingRoom(long userId)

Put user into waiting room.

Parameters:

userId - The ID of user who will be put into the waiting room.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.