ZoomSDKBOOption Class Reference

Defines breakout room configuration options. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062540#h_1660846b-7d2d-4a87-b8a6-efe29a61759a. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Properties
ZoomSDKBOStopCountDown	countDown
	Sets the countdown after closing breakout room.
BOOL	isParticipantCanChooseBO
	Enables or disable that participant can choose breakout room.
BOOL	isParticipantCanReturnToMainSessionAtAnyTime
	Enables or disable that participant can return to main session at any time.
BOOL	isAutoMoveAllAssignedParticipantsEnabled
	Enables or disable that auto move all assigned participants to breakout room.
BOOL	isBOTimerEnabled
	YES if it's timer BO, NO otherwise.
BOOL	isTimerAutoStopBOEnabled
	YES if time is up, stops BO auto, NO otherwise.
unsigned int	nTimerDurationMinutes
	Minutes of BO timer duration, NOTE: when nTimerDurationMinutes is 0, it means that the BO duration is 30 minutes.
BOOL	isAttendeeContained
	Enables or disable webinar attendee join webinar BO. When it changes, the BO data is reset.
BOOL	isPanelistCanChooseBO
	Enables or disable that panelist can choose breakout room.
BOOL	isAttendeeCanChooseBO
	Enables or disable that Attendee can choose breakout room, invalid when attendee is not contained.
BOOL	isUserConfigMaxRoomUserLimitsEnabled
	Enables or disable that max roomUser limits in BO room.
unsigned int	nUserConfigMaxRoomUserLimits
	Numbers of max roomUser limits in BO room, default is 20.
BOOL	isAICompanionEnabled
	Enables or disables AI Companion in breakout rooms.
BOOL	isTranscriptionEnabled
	Enables or disables transcription in breakout rooms.

Detailed Description

Defines breakout room configuration options. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062540#h_1660846b-7d2d-4a87-b8a6-efe29a61759a.

Definition at line 50 of file ZoomSDKNewBreakoutRoomController.h.

Property Documentation

countDown

- (ZoomSDKBOStopCountDown) countDown

readwritenonatomicassign

Sets the countdown after closing breakout room.

Definition at line 55 of file ZoomSDKNewBreakoutRoomController.h.

isAICompanionEnabled

- (BOOL) isAICompanionEnabled

readwritenonatomicassign

Enables or disables AI Companion in breakout rooms.

Note

If set to YES and isAICompanionSupported (ZoomSDKBOMeetingCreator) returns YES, AI Companion auto-starts for host or cohost when they enter the breakout room, provided that AI Companion is already active in the main meeting. Default NO (opt-in). Setting this to YES when IsAICompanionSupported returns NO has no effect.

Definition at line 120 of file ZoomSDKNewBreakoutRoomController.h.

isAttendeeCanChooseBO

- (BOOL) isAttendeeCanChooseBO

readwritenonatomicassign

Enables or disable that Attendee can choose breakout room, invalid when attendee is not contained.

Definition at line 101 of file ZoomSDKNewBreakoutRoomController.h.

isAttendeeContained

- (BOOL) isAttendeeContained

readwritenonatomicassign

Enables or disable webinar attendee join webinar BO. When it changes, the BO data is reset.

Definition at line 91 of file ZoomSDKNewBreakoutRoomController.h.

isAutoMoveAllAssignedParticipantsEnabled

- (BOOL) isAutoMoveAllAssignedParticipantsEnabled

readwritenonatomicassign

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

Definition at line 70 of file ZoomSDKNewBreakoutRoomController.h.

isBOTimerEnabled

- (BOOL) isBOTimerEnabled

readwritenonatomicassign

YES if it's timer BO, NO otherwise.

Definition at line 75 of file ZoomSDKNewBreakoutRoomController.h.

isPanelistCanChooseBO

- (BOOL) isPanelistCanChooseBO

readwritenonatomicassign

Enables or disable that panelist can choose breakout room.

Definition at line 96 of file ZoomSDKNewBreakoutRoomController.h.

isParticipantCanChooseBO

- (BOOL) isParticipantCanChooseBO

readwritenonatomicassign

Enables or disable that participant can choose breakout room.

Definition at line 60 of file ZoomSDKNewBreakoutRoomController.h.

isParticipantCanReturnToMainSessionAtAnyTime

- (BOOL) isParticipantCanReturnToMainSessionAtAnyTime

readwritenonatomicassign

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

Definition at line 65 of file ZoomSDKNewBreakoutRoomController.h.

isTimerAutoStopBOEnabled

- (BOOL) isTimerAutoStopBOEnabled

readwritenonatomicassign

YES if time is up, stops BO auto, NO otherwise.

Definition at line 80 of file ZoomSDKNewBreakoutRoomController.h.

isTranscriptionEnabled

- (BOOL) isTranscriptionEnabled

readwritenonatomicassign

Enables or disables transcription in breakout rooms.

Note

If set to YES and isTranscriptionSupported (ZoomSDKBOMeetingCreator) returns YES, transcription auto-starst for all participants when they enter the breakout room, provided that transcription is already active in the main meeting. Default NO (opt-in). Setting this to YES when isTranscriptionSupported returns NO has no effect.

Definition at line 129 of file ZoomSDKNewBreakoutRoomController.h.

isUserConfigMaxRoomUserLimitsEnabled

- (BOOL) isUserConfigMaxRoomUserLimitsEnabled

readwritenonatomicassign

Enables or disable that max roomUser limits in BO room.

Definition at line 106 of file ZoomSDKNewBreakoutRoomController.h.

nTimerDurationMinutes

- (unsigned int) nTimerDurationMinutes

readwritenonatomicassign

Minutes of BO timer duration, NOTE: when nTimerDurationMinutes is 0, it means that the BO duration is 30 minutes.

Definition at line 85 of file ZoomSDKNewBreakoutRoomController.h.

nUserConfigMaxRoomUserLimits

- (unsigned int) nUserConfigMaxRoomUserLimits

readwritenonatomicassign

Numbers of max roomUser limits in BO room, default is 20.

Definition at line 111 of file ZoomSDKNewBreakoutRoomController.h.