Breakout room options. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility. More...

Data Fields
BOStopCountdown	countdown = BOStopCountdown.COUNTDOWN_SECONDS_60
	Gets or sets the countdown after closing the breakout room.
boolean	isParticipantCanChooseBO
	Determines whether participants can choose a breakout room.
boolean	isParticipantCanReturnToMainSessionAtAnyTime = true
	Determines whether participants can return to the main session at any time.
boolean	isAutoMoveAllAssignedParticipantsEnabled
	Determines whether to automatically move all assigned participants to the breakout room.
boolean	isBOTimerEnabled
	Determines whether the breakout room uses a timer.
boolean	isTimerAutoStopBOEnabled
	Determines whether to automatically stop the breakout room when time is up.
int	timerDurationMinutes
	Gets or sets the breakout room timer duration in minutes. When timerDurationMinutes is 0, the breakout room duration is 30 minutes.
boolean	isAttendeeContained
	Determines whether webinar attendees can join the webinar breakout room. When this value changes, the breakout room data will be reset.
boolean	isPanelistCanChooseBO
	Determines whether panelists can choose a breakout room.
boolean	isAttendeeCanChooseBO
	Determines whether attendees can choose a breakout room. Invalid when attendees are not contained.
boolean	isUserConfigMaxRoomUserLimitsEnabled
	Determines whether to enable the maximum room user limit in the breakout room.
int	nUserConfigMaxRoomUserLimits = 20
	Gets or sets the maximum number of room users in the breakout room.
boolean	isAICompanionEnabled
	Determines whether AI Companion is enabled for breakout rooms.
boolean	isTranscriptionEnabled
	Determines whether transcription is enabled for breakout rooms.

Detailed Description

Breakout room options. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.

Definition at line 7 of file BOOption.java.

Field Documentation

◆ countdown

BOStopCountdown us.zoom.sdk.BOOption.countdown = BOStopCountdown.COUNTDOWN_SECONDS_60

Gets or sets the countdown after closing the breakout room.

Definition at line 11 of file BOOption.java.

◆ isAICompanionEnabled

boolean us.zoom.sdk.BOOption.isAICompanionEnabled

Determines whether AI Companion is enabled for breakout rooms.

Definition at line 65 of file BOOption.java.

◆ isAttendeeCanChooseBO

boolean us.zoom.sdk.BOOption.isAttendeeCanChooseBO

Determines whether attendees can choose a breakout room. Invalid when attendees are not contained.

Definition at line 50 of file BOOption.java.

◆ isAttendeeContained

boolean us.zoom.sdk.BOOption.isAttendeeContained

Determines whether webinar attendees can join the webinar breakout room. When this value changes, the breakout room data will be reset.

Definition at line 40 of file BOOption.java.

◆ isAutoMoveAllAssignedParticipantsEnabled

boolean us.zoom.sdk.BOOption.isAutoMoveAllAssignedParticipantsEnabled

Determines whether to automatically move all assigned participants to the breakout room.

Definition at line 23 of file BOOption.java.

◆ isBOTimerEnabled

boolean us.zoom.sdk.BOOption.isBOTimerEnabled

Determines whether the breakout room uses a timer.

Definition at line 27 of file BOOption.java.

◆ isPanelistCanChooseBO

boolean us.zoom.sdk.BOOption.isPanelistCanChooseBO

Determines whether panelists can choose a breakout room.

Definition at line 45 of file BOOption.java.

◆ isParticipantCanChooseBO

boolean us.zoom.sdk.BOOption.isParticipantCanChooseBO

Determines whether participants can choose a breakout room.

Definition at line 15 of file BOOption.java.

◆ isParticipantCanReturnToMainSessionAtAnyTime

boolean us.zoom.sdk.BOOption.isParticipantCanReturnToMainSessionAtAnyTime = true

Determines whether participants can return to the main session at any time.

Definition at line 19 of file BOOption.java.

◆ isTimerAutoStopBOEnabled

boolean us.zoom.sdk.BOOption.isTimerAutoStopBOEnabled

Determines whether to automatically stop the breakout room when time is up.

Definition at line 31 of file BOOption.java.

◆ isTranscriptionEnabled

boolean us.zoom.sdk.BOOption.isTranscriptionEnabled

Determines whether transcription is enabled for breakout rooms.

Definition at line 70 of file BOOption.java.

◆ isUserConfigMaxRoomUserLimitsEnabled

boolean us.zoom.sdk.BOOption.isUserConfigMaxRoomUserLimitsEnabled

Determines whether to enable the maximum room user limit in the breakout room.

Definition at line 55 of file BOOption.java.

◆ nUserConfigMaxRoomUserLimits

int us.zoom.sdk.BOOption.nUserConfigMaxRoomUserLimits = 20

Gets or sets the maximum number of room users in the breakout room.

Definition at line 60 of file BOOption.java.

◆ timerDurationMinutes

int us.zoom.sdk.BOOption.timerDurationMinutes

Gets or sets the breakout room timer duration in minutes. When timerDurationMinutes is 0, the breakout room duration is 30 minutes.

Definition at line 35 of file BOOption.java.

Data Fields