MobileRTCBOAdmin Class Reference

Interface for managing breakout rooms. More...

#include <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods
(BOOL)	- startBO
	Start bo meeting which assigned, the callback is: 'onStartBOResponse:'.
(BOOL)	- stopBO
	Stop bo meeting which assigned, the callback is:' onStopBOResponse:'.
(BOOL)	- assignNewUser:toRunningBO:
	Assign a bo user to a started bo meeting.
(BOOL)	- switchUser:toRunningBO:
	Switch a user to a new started bo meeting.
(BOOL)	- canStartBO
	Indicate that the bo can be start or not.
(BOOL)	- joinBOByUserRequest:
	Join bo meeting for designated bo user id.
(BOOL)	- ignoreUserHelpRequest:
	Reply ignore for the help request from bo attendees.
(BOOL)	- broadcastMessage:
	Broadcase message for all attendees in the meeting.
(BOOL)	- inviteBOUserReturnToMainSession:
	Host invite user return to main session, When BO is started and user is in BO.
(BOOL)	- isBroadcastVoiceToBOSupport
	Query if the current meeting supports broadcasting host's voice to BO.
(BOOL)	- canBroadcastVoiceToBO
	Query if the host now has the ability to broadcast voice to BO.
(BOOL)	- broadcastVoiceToBO:
	Start or stop broadcasting voice to BO.

Detailed Description

Interface for managing breakout rooms.

Definition at line 305 of file MobileRTCBORole.h.

Method Documentation

assignNewUser:toRunningBO:

- (BOOL) assignNewUser:		(NSString *_Nonnull)	boUserId
toRunningBO:		(NSString *_Nonnull)	boId

Assign a bo user to a started bo meeting.

Parameters

boUserId	the BO user id.
boId	the BO id.

Returns

The result of call the method.

broadcastMessage:

- (BOOL) broadcastMessage:

(NSString *_Nonnull)

strMsg

Broadcase message for all attendees in the meeting.

Parameters

strMsg

the bo message.

Returns

The result of call the method.

broadcastVoiceToBO:

- (BOOL) broadcastVoiceToBO:

(BOOL)

bStart

Start or stop broadcasting voice to BO.

Parameters

bStart

YES for start and NO for stop.

Returns

YES means that the invocation succeeds., Otherwise, it fails.

canBroadcastVoiceToBO

- (BOOL) canBroadcastVoiceToBO

Query if the host now has the ability to broadcast voice to BO.

Returns

YES means that the host now has the ability, otherwise the host does not.

canStartBO

- (BOOL) canStartBO

Indicate that the bo can be start or not.

Returns

The result of call the method.

ignoreUserHelpRequest:

- (BOOL) ignoreUserHelpRequest:

(NSString *_Nonnull)

boUserId

Reply ignore for the help request from bo attendees.

Parameters

boUserId

the BO user id.

Returns

The result of call the method.

inviteBOUserReturnToMainSession:

- (BOOL) inviteBOUserReturnToMainSession:

(NSString *_Nonnull)

boUserId

Host invite user return to main session, When BO is started and user is in BO.

Parameters

boUserId

the bo user id.

Returns

YES indicates success, otherwise fail.

isBroadcastVoiceToBOSupport

- (BOOL) isBroadcastVoiceToBOSupport

Query if the current meeting supports broadcasting host's voice to BO.

Returns

YES means that the meeting supports this, otherwise it's not supported.

joinBOByUserRequest:

- (BOOL) joinBOByUserRequest:

(NSString *_Nonnull)

boUserId

Join bo meeting for designated bo user id.

Parameters

boUserId

the BO user id.

Returns

The result of call the method.

startBO

- (BOOL) startBO

Start bo meeting which assigned, the callback is: 'onStartBOResponse:'.

Returns

Start success or not.

stopBO

- (BOOL) stopBO

Stop bo meeting which assigned, the callback is:' onStopBOResponse:'.

Returns

Stop success or not.

switchUser:toRunningBO:

- (BOOL) switchUser:		(NSString *_Nonnull)	boUserId
toRunningBO:		(NSString *_Nonnull)	boId

Switch a user to a new started bo meeting.

Parameters

boUserId	the BO user id.
boId	the BO id.

Returns

The result of call the method.