Breakout room options. More...

#include <IBreakoutRoomHelper.h>

Data Fields
bool	isParticipantCanChooseRoom = false
	options support configure

bool	isParticipantCanReturnToMainSessionAtAnyTime = true
	True indicates participants can return to main session at any time.

bool	isAutoMoveAllAssignedParticipantsEnabled = false
	True indicates automatically move all assigned participants into breakout rooms.

bool	isBOTimerEnabled = false
	True indicates it's a timer BO.

uint64_t	boTimerDuration = 0
	Seconds of BO timer duration, if BO timer is enabled, boTimerDuration is 30*60 seconds by default.

bool	isNotifyMeWhenTimeIsUp = false
	True indicates will receive a notification when duration time is up. Otherwise BO is auto stopped.

BO_STOP_COUNTDOWN	countdownSeconds = BO_STOP_NOT_COUNTDOWN
	BO stop countdown seconds, see BO_STOP_COUNTDOWN enum.

BO_STOP_COUNTDOWN	defaultCountDown = BO_STOP_COUNTDOWN_SECONDS_60
	options not support configure

uint64_t	defaultBOTimerDuration = 30 * 60
	Default BO timer duration in seconds.

bool	isPreAssignEnabled = false
	True indicates web enabled pre-assigned BO options when schedule the meeting.

int	maxRoomCount = 100
	Max room count when creating BO.

Detailed Description

Breakout room options.

Definition at line 48 of file IBreakoutRoomHelper.h.

Field Documentation

◆ boTimerDuration

uint64_t BOOptions::boTimerDuration = 0

Seconds of BO timer duration, if BO timer is enabled, boTimerDuration is 30*60 seconds by default.

Definition at line 55 of file IBreakoutRoomHelper.h.

◆ countdownSeconds

BO_STOP_COUNTDOWN BOOptions::countdownSeconds = BO_STOP_NOT_COUNTDOWN

BO stop countdown seconds, see BO_STOP_COUNTDOWN enum.

Definition at line 57 of file IBreakoutRoomHelper.h.

◆ defaultBOTimerDuration

uint64_t BOOptions::defaultBOTimerDuration = 30 * 60

Default BO timer duration in seconds.

Definition at line 61 of file IBreakoutRoomHelper.h.

◆ defaultCountDown

BO_STOP_COUNTDOWN BOOptions::defaultCountDown = BO_STOP_COUNTDOWN_SECONDS_60

options not support configure

BO default stop countdown seconds, see BO_STOP_COUNTDOWN enum.

Definition at line 60 of file IBreakoutRoomHelper.h.

◆ isAutoMoveAllAssignedParticipantsEnabled

bool BOOptions::isAutoMoveAllAssignedParticipantsEnabled = false

True indicates automatically move all assigned participants into breakout rooms.

Definition at line 53 of file IBreakoutRoomHelper.h.

◆ isBOTimerEnabled

bool BOOptions::isBOTimerEnabled = false

True indicates it's a timer BO.

Definition at line 54 of file IBreakoutRoomHelper.h.

◆ isNotifyMeWhenTimeIsUp

bool BOOptions::isNotifyMeWhenTimeIsUp = false

True indicates will receive a notification when duration time is up. Otherwise BO is auto stopped.

Definition at line 56 of file IBreakoutRoomHelper.h.

◆ isParticipantCanChooseRoom

bool BOOptions::isParticipantCanChooseRoom = false

options support configure

True indicates participants can choose room.

Definition at line 51 of file IBreakoutRoomHelper.h.

◆ isParticipantCanReturnToMainSessionAtAnyTime

bool BOOptions::isParticipantCanReturnToMainSessionAtAnyTime = true

True indicates participants can return to main session at any time.

Definition at line 52 of file IBreakoutRoomHelper.h.

◆ isPreAssignEnabled

bool BOOptions::isPreAssignEnabled = false

True indicates web enabled pre-assigned BO options when schedule the meeting.

Definition at line 62 of file IBreakoutRoomHelper.h.

◆ maxRoomCount

int BOOptions::maxRoomCount = 100

Max room count when creating BO.

Definition at line 63 of file IBreakoutRoomHelper.h.

Data Fields