MobileRTCBOAdmin Class Reference

A class for managing breakout rooms. More...

#include <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods
(BOOL)	- startBO
	Starts the assigned breakout meeting. The callback is 'onStartBOResponse:'.
(BOOL)	- stopBO
	Stops the assigned breakout meeting. The callback is 'onStopBOResponse:'.
(BOOL)	- assignNewUser:toRunningBO:
	Assigns a breakout room user to a started breakout meeting.
(BOOL)	- switchUser:toRunningBO:
	Switches a user to a new started breakout meeting.
(BOOL)	- canStartBO
	Determines if the breakout room can be started.
(BOOL)	- joinBOByUserRequest:
	Joins breakout meeting for designated breakout room user ID.
(BOOL)	- ignoreUserHelpRequest:
	Ignores the help request from breakout room attendees.
(BOOL)	- broadcastMessage:
	Broadcasts a message to all attendees in the meeting.
(BOOL)	- inviteBOUserReturnToMainSession:
	Host invites user to return to main session. When breakout room is started and user is in breakout room.
(BOOL)	- isBroadcastVoiceToBOSupport
	Queries if the current meeting supports broadcasting host's voice to breakout room.
(BOOL)	- canBroadcastVoiceToBO
	Queries if the host now has the ability to broadcast voice to breakout room.
(BOOL)	- broadcastVoiceToBO:
	Starts or stops broadcasting voice to breakout room.

Detailed Description

A class for managing breakout rooms.

Definition at line 320 of file MobileRTCBORole.h.

Method Documentation

assignNewUser:toRunningBO:

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

Assigns a breakout room user to a started breakout meeting.

Parameters

boUserId	The breakout room user ID.
boId	The breakout room ID.

Returns

YES if the function succeeds. Otherwise, NO.

broadcastMessage:

- (BOOL) broadcastMessage:

(NSString *_Nonnull)

strMsg

Broadcasts a message to all attendees in the meeting.

Parameters

strMsg

The breakout room message.

Returns

YES if the function succeeds. Otherwise, NO.

broadcastVoiceToBO:

- (BOOL) broadcastVoiceToBO:

(BOOL)

bStart

Starts or stops broadcasting voice to breakout room.

Parameters

bStart

YES to start, NO to stop.

Returns

YES if the invocation succeeds. Otherwise, NO.

canBroadcastVoiceToBO

- (BOOL) canBroadcastVoiceToBO

Queries if the host now has the ability to broadcast voice to breakout room.

Returns

YES if the host now has the ability. Otherwise, NO.

References canBroadcastVoiceToBO.

Referenced by canBroadcastVoiceToBO.

canStartBO

- (BOOL) canStartBO

Determines if the breakout room can be started.

Returns

YES if the breakout room can be started. Otherwise, NO.

References canStartBO.

Referenced by canStartBO.

ignoreUserHelpRequest:

- (BOOL) ignoreUserHelpRequest:

(NSString *_Nonnull)

boUserId

Ignores the help request from breakout room attendees.

Parameters

boUserId

The breakout room user ID.

Returns

YES if the function succeeds. Otherwise, NO.

inviteBOUserReturnToMainSession:

- (BOOL) inviteBOUserReturnToMainSession:

(NSString *_Nonnull)

boUserId

Host invites user to return to main session. When breakout room is started and user is in breakout room.

Parameters

boUserId

The breakout room user ID.

Returns

YES if the function succeeds. Otherwise, NO.

isBroadcastVoiceToBOSupport

- (BOOL) isBroadcastVoiceToBOSupport

Queries if the current meeting supports broadcasting host's voice to breakout room.

Returns

YES if the meeting supports this. Otherwise, NO.

References isBroadcastVoiceToBOSupport.

Referenced by isBroadcastVoiceToBOSupport.

joinBOByUserRequest:

- (BOOL) joinBOByUserRequest:

(NSString *_Nonnull)

boUserId

Joins breakout meeting for designated breakout room user ID.

Parameters

boUserId

The breakout room user ID.

Returns

YES if the function succeeds. Otherwise, NO.

startBO

- (BOOL) startBO

Starts the assigned breakout meeting. The callback is 'onStartBOResponse:'.

Returns

YES if start succeeds. Otherwise, NO.

References startBO.

Referenced by startBO.

stopBO

- (BOOL) stopBO

Stops the assigned breakout meeting. The callback is 'onStopBOResponse:'.

Returns

YES if stop succeeds. Otherwise, NO.

References stopBO.

Referenced by stopBO.

switchUser:toRunningBO:

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

Switches a user to a new started breakout meeting.

Parameters

boUserId	The breakout room user ID.
boId	The breakout room ID.

Returns

YES if the function succeeds. Otherwise, NO.