Webex Meetings
Breakout Sessions
Breakout sessions allow meeting participants to join smaller groups within a meeting, facilitated by the meeting host or co-host. Attendees can join or leave these sessions if they are granted permission.
Available from SDK v3.7.0 onwards.
Currently, attendee support is provided, but host controls, such as creating or editing a session, are not supported.
anchorBreakout
anchorRepresents the settings/information for all the Breakout Sessions configured by the host/co-host.
1. startTime: Date
The start time of the breakout sessions.
2. duration: Double
The duration of the breakout sessions in seconds.
3. delay: Double
The delay time in seconds before the breakout sessions are ended after the closing process starts.
4. allowReturnToMainSession: Bool
Indicates whether participants can return to the main session after the breakout sessions are closed.
5. canJoinLater: Bool
Determines if participants can join the session later.
anchorBreakoutSession
anchorContains information for a specific breakout session.
1. name: String
The name of the breakout session.
2. sessionId: String
The unique session ID of the breakout session.
3. isAssigned: Bool
Indicates if the session is assigned by the host or co-host.
anchorAttendee Support Methods
anchorThis section describes attendee support methods.
Join/Leave Breakout Session
Join a breakout session.
webex.phone.call.joinBreakoutSession(breakoutSession: BreakoutSession)
Return to the main session.
webex.phone.call.returnToMainSession()
anchorBreakout Session Events
anchorTo receive breakout events, developers must set a CallObserver using the Call.setObserver method and override the breakout events.
1. Session Enabled
Triggered when breakout sessions are enabled for a meeting.
webex.phone.callObserver.onSessionEnabled
2. Session Started
Occurs when a breakout session starts, returning a breakout object with session info:
webex.phone.callObserver.onSessionStarted(breakout: Breakout)
3. Session Joined
Occurs when an attendee joins a breakout session, either manually or when assigned and started by the host:
webex.phone.callObserver.onSessionJoined(breakoutSession: BreakoutSession)
4. Breakout Sessions List Updated
Triggered when the list of joinable breakout sessions for an attendee is updated:
webex.phone.callObserver.onJoinableSessionUpdated(breakoutSessions: List<BreakoutSession>)
5. Breakout Updated
Triggered when breakout settings are updated:
webex.phone.callObserver.onBreakoutUpdated(breakout: Breakout)
6. Joined Session Updated
Triggered when the breakout session an attendee has joined:
webex.phone.callObserver.onJoinedSessionUpdated(breakoutSession: BreakoutSession)
7. Broadcast Message Received
Occurs when a broadcast message from the host is received by the participant in a session:
webex.phone.callObserver.onBroadcastMessageReceivedFromHost(message: String)
8. Host Asks Participants To Return To Main Session
Triggered when the host requests participants to return to the main meeting:
webex.phone.callObserver.onHostAskingReturnToMainSession()
9. Session Closing
Occurs when the breakout session is about to close, either immediately or after a delay configured by the host or co-host. The delay can be retrieved using the Breakout.getDelay() method:
webex.phone.callObserver.onSessionClosing()
10. Returned to Main Session
Triggered when a participant returns to the main session:
webex.phone.callObserver.onReturnedToMainSession()
11. Error Occurred
Triggered when an error occurs while joining a session or returning to the main session:
webex.phone.callObserver.onBreakoutError(error: BreakoutSession.BreakoutSessionError)