Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubsessionOption

Subsession creation options.

Hierarchy

  • SubsessionOption

Index

Properties

Properties

Optional isAutoJoinSubsession

isAutoJoinSubsession?: boolean

Whether a participant should automatically join the subsession when assigned to one.

Optional isAutoMoveBackToMainSession

isAutoMoveBackToMainSession?: boolean

Indicates whether a participant should automatically return to the main session when the host moves them back.

  • If true, the participant returns automatically without confirmation.
  • If false, the participant receives a subsession-invite-back-to-main-session event and must agree to return.

Optional isBackToMainSessionEnabled

isBackToMainSessionEnabled?: boolean

Whether to allow participants in the subsession to return to the main session.

Optional isSubsessionSelectionEnabled

isSubsessionSelectionEnabled?: boolean

Indicates whether participants are allowed to select a subsession to join.

Optional isTimerAutoEnabled

isTimerAutoEnabled?: boolean

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

Optional isTimerEnabled

isTimerEnabled?: boolean

Whether to set a timer for the subsession.

Optional timerDuration

timerDuration?: number

Duration of the timer.

Optional waitSeconds

waitSeconds?: number

When the subsession is closing, the buffer time to leave the subsession.