Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
WebinarBOOptions Struct Reference

Webinar breakout room options. More...

#include <IWebinarBreakoutRoomHelper.h>

Data Fields

bool isPanelistCanChooseRoom = false
 True indicates panelist can choose room.
 
bool isAttendeeCanChooseRoom = false
 True indicates attendee can choose room.
 
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.
 
int maxParticipantsCountPerRoom = 500
 Max participants count of each room.
 
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.
 

Detailed Description

Webinar breakout room options.

Definition at line 38 of file IWebinarBreakoutRoomHelper.h.

Field Documentation

◆ boTimerDuration

uint64_t WebinarBOOptions::boTimerDuration = 0

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

Definition at line 47 of file IWebinarBreakoutRoomHelper.h.

◆ countdownSeconds

BO_STOP_COUNTDOWN WebinarBOOptions::countdownSeconds = BO_STOP_NOT_COUNTDOWN

BO stop countdown seconds, see BO_STOP_COUNTDOWN enum.

Definition at line 51 of file IWebinarBreakoutRoomHelper.h.

◆ isAttendeeCanChooseRoom

bool WebinarBOOptions::isAttendeeCanChooseRoom = false

True indicates attendee can choose room.

Definition at line 41 of file IWebinarBreakoutRoomHelper.h.

◆ isAutoMoveAllAssignedParticipantsEnabled

bool WebinarBOOptions::isAutoMoveAllAssignedParticipantsEnabled = false

True indicates automatically move all assigned participants into breakout rooms.

Definition at line 43 of file IWebinarBreakoutRoomHelper.h.

◆ isBOTimerEnabled

bool WebinarBOOptions::isBOTimerEnabled = false

True indicates it's a timer BO.

Definition at line 46 of file IWebinarBreakoutRoomHelper.h.

◆ isNotifyMeWhenTimeIsUp

bool WebinarBOOptions::isNotifyMeWhenTimeIsUp = false

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

Definition at line 49 of file IWebinarBreakoutRoomHelper.h.

◆ isPanelistCanChooseRoom

bool WebinarBOOptions::isPanelistCanChooseRoom = false

True indicates panelist can choose room.

Definition at line 40 of file IWebinarBreakoutRoomHelper.h.

◆ isParticipantCanReturnToMainSessionAtAnyTime

bool WebinarBOOptions::isParticipantCanReturnToMainSessionAtAnyTime = true

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

Definition at line 42 of file IWebinarBreakoutRoomHelper.h.

◆ maxParticipantsCountPerRoom

int WebinarBOOptions::maxParticipantsCountPerRoom = 500

Max participants count of each room.

Definition at line 44 of file IWebinarBreakoutRoomHelper.h.