MobileRTCWaitingRoomService Class Reference

#import <MobileRTCWaitingRoomService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportWaitingRoom
	Is this meeting support Waiting Room feature.
(BOOL)	- isWaitingRoomOnEntryFlagOn
	Is this meeting enabled Waiting Room feature.
(MobileRTCMeetError)	- enableWaitingRoomOnEntry:
	enable or disable waiting room feature of this meeting.
(nullable NSArray< NSNumber * > *)	- waitingRoomList
	get the waiting room user id list.
(nullable MobileRTCMeetingUserInfo *)	- waitingRoomUserInfoByID:
	get the user detail information in waiting room.
(MobileRTCSDKError)	- admitToMeeting:
	admit the user go to meeting fram waiting room.
(MobileRTCSDKError)	- admitAllToMeeting
	Permit all of the users currently in the waiting room to join the meeting.
(MobileRTCSDKError)	- putInWaitingRoom:
	put the user to waiting room from meeting.
(BOOL)	- isAudioEnabledInWaitingRoom
	Determine if the attendee is enabled to turn on audio when joining the meeting.
(BOOL)	- isVideoEnabledInWaitingRoom
	Determine if the attendee is enabled to turn on video when joining the meeting.
(MobileRTCSDKError)	- requestCustomWaitingRoomData
	Get the WaitingRoom CustomizeData information in the waiting room.

Properties
id< MobileRTCWaitingRoomServiceDelegate >	delegate
	Waiting Room service delegate.

Detailed Description

Definition at line 87 of file MobileRTCWaitingRoomService.h.

Method Documentation

admitAllToMeeting

- (MobileRTCSDKError) admitAllToMeeting

Permit all of the users currently in the waiting room to join the meeting.

Returns

If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed, the return is error. For more details, see [MobileRTCSDKError] enum.

admitToMeeting:

- (MobileRTCSDKError) admitToMeeting:

(NSUInteger)

userId

admit the user go to meeting fram waiting room.

Returns

the result of this operation.

Warning

Only meeting host/co-host can run the function.

enableWaitingRoomOnEntry:

- (MobileRTCMeetError) enableWaitingRoomOnEntry:

(BOOL)

bEnable

enable or disable waiting room feature of this meeting.

Returns

the result of this operation.

isAudioEnabledInWaitingRoom

- (BOOL) isAudioEnabledInWaitingRoom

Determine if the attendee is enabled to turn on audio when joining the meeting.

Returns

YES indicates to enable to turn on.

isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Is this meeting support Waiting Room feature.

Returns

Yes if support waiting room.

isVideoEnabledInWaitingRoom

- (BOOL) isVideoEnabledInWaitingRoom

Determine if the attendee is enabled to turn on video when joining the meeting.

Returns

YES indicates to enable to turn on.

isWaitingRoomOnEntryFlagOn

- (BOOL) isWaitingRoomOnEntryFlagOn

Is this meeting enabled Waiting Room feature.

Returns

Yes if enabled.

putInWaitingRoom:

- (MobileRTCSDKError) putInWaitingRoom:

(NSUInteger)

userId

put the user to waiting room from meeting.

Returns

the result of this operation.

Warning

Only meeting host/co-host can run the function.

requestCustomWaitingRoomData

- (MobileRTCSDKError) requestCustomWaitingRoomData

Get the WaitingRoom CustomizeData information in the waiting room.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

waitingRoomList

- (nullable NSArray< NSNumber * > *) waitingRoomList

get the waiting room user id list.

Returns

waiting room user list.

waitingRoomUserInfoByID:

- (nullable MobileRTCMeetingUserInfo *) waitingRoomUserInfoByID:

(NSUInteger)

userId

get the user detail information in waiting room.

Returns

waiting room user information.

Property Documentation

delegate

- (id<MobileRTCWaitingRoomServiceDelegate>) delegate

readwritenonatomicassign

Waiting Room service delegate.

Definition at line 92 of file MobileRTCWaitingRoomService.h.