MobileRTCBOOption Class Reference

A class that contains breakout room options. More...

#include <MobileRTCBORole.h>

Inherits NSObject.

Properties
MobileRTCBOStopCountDown	countdownSeconds
	The breakout room countdown seconds.
BOOL	isParticipantCanChooseBO
	Enables or disables that participant can choose breakout room.
BOOL	isParticipantCanReturnToMainSessionAtAnyTime
	Enables or disables that participant can return to main session at any time.
BOOL	isAutoMoveAllAssignedParticipantsEnabled
	Enables or disables that auto move all assigned participants to breakout room.
BOOL	isBOTimerEnabled
	Indicates whether it's a timer breakout room. YES if it's a timer breakout room, NO otherwise.
BOOL	isTimerAutoStopBOEnabled
	Indicates whether to auto stop breakout room when time is up. YES if auto stop is enabled, NO otherwise.
NSInteger	timerDurationMinutes
	The minutes of breakout room timer duration.
BOOL	isAttendeeContained
	Enables or disables webinar attendee join webinar breakout room. When it changes, the breakout room data will be reset.
BOOL	isPanelistCanChooseBO
	Enables or disables that panelist can choose breakout room.
BOOL	isAttendeeCanChooseBO
	Enables or disables that attendee can choose breakout room. Invalid when attendee is not contained.
BOOL	isUserConfigMaxRoomUserLimitsEnabled
	Enables or disables that max room user limits in breakout room.
unsigned int	nUserConfigMaxRoomUserLimits
	The number of max room user limits in breakout room. The default is 20.
BOOL	isAICompanionEnabled
	Enables or disables auto-starting AI Companion for host or co-host in breakout rooms.
BOOL	isTranscriptionEnabled
	Enables or disables auto-starting transcription in breakout rooms.

Detailed Description

A class that contains breakout room options.

Definition at line 97 of file MobileRTCBORole.h.

Property Documentation

countdownSeconds

- (MobileRTCBOStopCountDown) countdownSeconds

readwritenonatomicassign

The breakout room countdown seconds.

Definition at line 102 of file MobileRTCBORole.h.

isAICompanionEnabled

- (BOOL) isAICompanionEnabled

readwritenonatomicassign

Enables or disables auto-starting AI Companion for host or co-host in breakout rooms.

Note

This is effective only when MobileRTCBOCreator::isAICompanionSupported returns YES.

Definition at line 165 of file MobileRTCBORole.h.

isAttendeeCanChooseBO

- (BOOL) isAttendeeCanChooseBO

readwritenonatomicassign

Enables or disables that attendee can choose breakout room. Invalid when attendee is not contained.

Definition at line 149 of file MobileRTCBORole.h.

isAttendeeContained

- (BOOL) isAttendeeContained

readwritenonatomicassign

Enables or disables webinar attendee join webinar breakout room. When it changes, the breakout room data will be reset.

Definition at line 139 of file MobileRTCBORole.h.

isAutoMoveAllAssignedParticipantsEnabled

- (BOOL) isAutoMoveAllAssignedParticipantsEnabled

readwritenonatomicassign

Enables or disables that auto move all assigned participants to breakout room.

Definition at line 117 of file MobileRTCBORole.h.

isBOTimerEnabled

- (BOOL) isBOTimerEnabled

readwritenonatomicassign

Indicates whether it's a timer breakout room. YES if it's a timer breakout room, NO otherwise.

Definition at line 122 of file MobileRTCBORole.h.

isPanelistCanChooseBO

- (BOOL) isPanelistCanChooseBO

readwritenonatomicassign

Enables or disables that panelist can choose breakout room.

Definition at line 144 of file MobileRTCBORole.h.

isParticipantCanChooseBO

- (BOOL) isParticipantCanChooseBO

readwritenonatomicassign

Enables or disables that participant can choose breakout room.

Definition at line 107 of file MobileRTCBORole.h.

isParticipantCanReturnToMainSessionAtAnyTime

- (BOOL) isParticipantCanReturnToMainSessionAtAnyTime

readwritenonatomicassign

Enables or disables that participant can return to main session at any time.

Definition at line 112 of file MobileRTCBORole.h.

isTimerAutoStopBOEnabled

- (BOOL) isTimerAutoStopBOEnabled

readwritenonatomicassign

Indicates whether to auto stop breakout room when time is up. YES if auto stop is enabled, NO otherwise.

Definition at line 127 of file MobileRTCBORole.h.

isTranscriptionEnabled

- (BOOL) isTranscriptionEnabled

readwritenonatomicassign

Enables or disables auto-starting transcription in breakout rooms.

Note

This is effective only when MobileRTCBOCreator::isTranscriptionSupported returns YES.

Definition at line 171 of file MobileRTCBORole.h.

isUserConfigMaxRoomUserLimitsEnabled

- (BOOL) isUserConfigMaxRoomUserLimitsEnabled

readwritenonatomicassign

Enables or disables that max room user limits in breakout room.

Definition at line 154 of file MobileRTCBORole.h.

nUserConfigMaxRoomUserLimits

- (unsigned int) nUserConfigMaxRoomUserLimits

readwritenonatomicassign

The number of max room user limits in breakout room. The default is 20.

Definition at line 159 of file MobileRTCBORole.h.

timerDurationMinutes

- (NSInteger) timerDurationMinutes

readwritenonatomicassign

The minutes of breakout room timer duration.

Warning

When timerDurationMinutes is 0, it means that the breakout room duration is 30 minutes.

Definition at line 133 of file MobileRTCBORole.h.