Interface RoomOption

interface RoomOption {
    isAutoJoinRoom?: boolean;
    isBackToMainSessionEnabled?: boolean;
    isTimerAutoEnabled?: boolean;
    isTimerEnabled?: boolean;
    timerDuration?: number;
    waitSeconds?: number;
}

Properties

isAutoJoinRoom? isBackToMainSessionEnabled? isTimerAutoEnabled? isTimerEnabled? timerDuration? waitSeconds?

Properties

Optional isAutoJoinRoom

isAutoJoinRoom?: boolean

Whether to automatically join the room when the participant is assigned to a room or not.

Optional isBackToMainSessionEnabled

isBackToMainSessionEnabled?: boolean

Whether or not to allow participants in the room to return to the main session.

Optional isTimerAutoEnabled

isTimerAutoEnabled?: boolean

Whether or not to automatically return to the main session when time is up.

Optional isTimerEnabled

isTimerEnabled?: boolean

Whether or not to set a timer for the breakout room.

Optional timerDuration

timerDuration?: number

The duration of the timer.

Optional waitSeconds

waitSeconds?: number

When the breakout room is closing, the buffer time to give the user to leave the room.

Settings

Member Visibility

Theme

On This Page

isAutoJoinRoomisBackToMainSessionEnabledisTimerAutoEnabledisTimerEnabledtimerDurationwaitSeconds