Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
BOOption Struct Reference

BO option. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions

 BOOption ()

Data Fields

BO_STOP_COUNTDOWN countdown_seconds
bool IsParticipantCanChooseBO
bool IsParticipantCanReturnToMainSessionAtAnyTime
bool IsAutoMoveAllAssignedParticipantsEnabled
bool IsBOTimerEnabled
bool IsTimerAutoStopBOEnabled
unsigned int nTimerDurationMinutes
bool IsAttendeeContained
 The following items are for Webinar only.
bool IsPanelistCanChooseBO
bool IsAttendeeCanChooseBO
bool IsUserConfigMaxRoomUserLimitsEnabled
unsigned int nUserConfigMaxRoomUserLimits
bool isAICompanionEnabled
bool isTranscriptionEnabled

Detailed Description

BO option.

Definition at line 207 of file meeting_breakout_rooms_interface_v2.h.

Constructor & Destructor Documentation

◆ BOOption()

BOOption::BOOption ( )
inline

Definition at line 254 of file meeting_breakout_rooms_interface_v2.h.

255 {
260 IsBOTimerEnabled = false;
263 IsPanelistCanChooseBO = false;
264 IsAttendeeCanChooseBO = false;
267 IsAttendeeContained = false;
268 isAICompanionEnabled = false;
270 }
bool IsAttendeeContained
The following items are for Webinar only.
BO_STOP_COUNTDOWN countdown_seconds

References BO_STOP_COUNTDOWN_SECONDS_60, countdown_seconds, isAICompanionEnabled, IsAttendeeCanChooseBO, IsAttendeeContained, IsAutoMoveAllAssignedParticipantsEnabled, IsBOTimerEnabled, IsPanelistCanChooseBO, IsParticipantCanChooseBO, IsParticipantCanReturnToMainSessionAtAnyTime, IsTimerAutoStopBOEnabled, isTranscriptionEnabled, IsUserConfigMaxRoomUserLimitsEnabled, nTimerDurationMinutes, and nUserConfigMaxRoomUserLimits.

Field Documentation

◆ countdown_seconds

BO_STOP_COUNTDOWN BOOption::countdown_seconds

Set the countdown after closing breakout room.

Definition at line 210 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ isAICompanionEnabled

bool BOOption::isAICompanionEnabled

If true and IBOCreator::IsAICompanionSupported() returns true, AI Companion will auto-start for host or cohost when they enter the breakout room, provided that AI Companion is already active in the main meeting. Default is false (opt-in). Setting this to true when IsAICompanionSupported() returns false has no effect.

Definition at line 244 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsAttendeeCanChooseBO

bool BOOption::IsAttendeeCanChooseBO

Enable/Disable that Attendee can choose breakout room, invalid when attendee is not contained.

Definition at line 232 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsAttendeeContained

bool BOOption::IsAttendeeContained

The following items are for Webinar only.

Enable/Disable Webinar Attendee join Webinar BO, When it changes, the BO data will be reset.

Definition at line 228 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsAutoMoveAllAssignedParticipantsEnabled

bool BOOption::IsAutoMoveAllAssignedParticipantsEnabled

Enable/Disable that auto move all assigned participants to breakout room.

Definition at line 216 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsBOTimerEnabled

bool BOOption::IsBOTimerEnabled

true: it's timer BO false: not timer BO

Definition at line 218 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsPanelistCanChooseBO

bool BOOption::IsPanelistCanChooseBO

Enable/Disable that Panelist can choose breakout room.

Definition at line 230 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsParticipantCanChooseBO

bool BOOption::IsParticipantCanChooseBO

Enable/Disable that participant can choose breakout room. Only for Meeting not Webinar.

Definition at line 212 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsParticipantCanReturnToMainSessionAtAnyTime

bool BOOption::IsParticipantCanReturnToMainSessionAtAnyTime

Enable/Disable that participant can return to main session at any time.

Definition at line 214 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsTimerAutoStopBOEnabled

bool BOOption::IsTimerAutoStopBOEnabled

true: if time is up, will stop BO auto. false: don't auto stop. Only for Meeting not Webinar.

Definition at line 220 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ isTranscriptionEnabled

bool BOOption::isTranscriptionEnabled

If true and IBOCreator::IsTranscriptionSupported() returns true, Transcription auto-start for all participants when they enter the breakout room, provided that Transcription is already active in the main meeting. Default is false (opt-in). Setting this to true when IsTranscriptionSupported() returns false has no effect.

Definition at line 252 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ IsUserConfigMaxRoomUserLimitsEnabled

bool BOOption::IsUserConfigMaxRoomUserLimitsEnabled

Enable/Disable that max roomUser limits in BO room.

Definition at line 234 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ nTimerDurationMinutes

unsigned int BOOption::nTimerDurationMinutes

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

Definition at line 222 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().

◆ nUserConfigMaxRoomUserLimits

unsigned int BOOption::nUserConfigMaxRoomUserLimits

numbers of max roomUser limits in BO room.

Definition at line 236 of file meeting_breakout_rooms_interface_v2.h.

Referenced by BOOption().