Class BreakoutRoomUpdated

Updates the state of breakout rooms based on the provided data and parameters.

This method handles changes in breakout rooms, updates the relevant state variables, and triggers necessary UI updates based on the current status of the breakout rooms.

Param: options

The options object containing the data and parameters.

Param: options.data

The data object containing information about the breakout rooms.

Param: options.parameters

The parameters object containing various state update functions and other parameters.

Param: options.parameters.breakOutRoomStarted

Indicates if the breakout room has started.

Param: options.parameters.breakOutRoomEnded

Indicates if the breakout room has ended.

Param: options.parameters.breakoutRooms

The list of current breakout rooms.

Param: options.parameters.hostNewRoom

The ID of the new room for the host.

Param: options.parameters.islevel

The level of the breakout room (e.g., '2' for host).

Param: options.parameters.participantsAll

The list of all participants.

Param: options.parameters.participants

The list of participants who are not banned.

Param: options.parameters.meetingDisplayType

The current display type of the meeting.

Param: options.parameters.prevMeetingDisplayType

The previous display type of the meeting.

Param: options.parameters.updateBreakoutRooms

Function to update the breakout rooms.

Param: options.parameters.updateBreakOutRoomStarted

Function to update the breakout room started state.

Param: options.parameters.updateBreakOutRoomEnded

Function to update the breakout room ended state.

Param: options.parameters.updateHostNewRoom

Function to update the host's new room.

Param: options.parameters.updateMeetingDisplayType

Function to update the meeting display type.

Param: options.parameters.updateParticipantsAll

Function to update the list of all participants.

Param: options.parameters.updateParticipants

Function to update the list of participants who are not banned.

Param: options.parameters.onScreenChanges

Function to handle screen changes.

Param: options.parameters.rePort

Function to handle reporting.

Returns

A promise that resolves when the breakout room state has been updated.

Throws

Will throw an error if the update process fails.

Example

const options = {
  data: {
    forHost: true,
    newRoom: 3,
    status: 'started',
    members: [
      { name: 'user1', isBanned: false, audioID: 'audio1', videoID: 'video1' },
      { name: 'user2', isBanned: true, audioID: 'audio2', videoID: 'video2' },
    ],
    breakoutRooms: [[{ name: 'user1' }, { name: 'user2' }]],
  },
  parameters: {
    socket: socketInstance,
    roomName: 'mainRoom',
    screenStates: [{ mainScreenPerson: 'user1', mainScreenFilled: true, adminOnMainScreen: false }],
    participants: [{ name: 'admin', islevel: '2' }],
    breakOutRoomStarted: false,
    breakOutRoomEnded: false,
    hostNewRoom: 0,
    islevel: '2',
    participantsAll: [],
    updateBreakoutRooms: (rooms) => {},
    updateBreakOutRoomStarted: (started) => {},
    updateBreakOutRoomEnded: (ended) => {},
    updateHostNewRoom: (room) => {},
    updateMeetingDisplayType: (type) => {},
    updateParticipantsAll: (participants) => {},
    updateParticipants: (participants) => {},
    onScreenChanges: async () => {},
    rePort: async () => {},
  },
};

const breakoutRoomService = new BreakoutRoomUpdated();
await breakoutRoomService.breakoutRoomUpdated(options);

Constructors

constructor

Methods

breakoutRoomUpdated

Constructors

constructor

Methods

breakoutRoomUpdated

Settings

Member Visibility

On This Page

Constructors
Methods