mediasfu-angular 1.0.1 → 1.0.2

package/dist/lib/consumers/switch-user-audio.service.d.ts

@@ -16,6 +16,39 @@ export interface SwitchUserAudioOptions {
     parameters: SwitchUserAudioParameters;
 }
 export type SwitchUserAudioType = (options: SwitchUserAudioOptions) => Promise<void>;
+/**
+ * Switches the user's audio input device based on the provided audio preference.
+ *
+ * This method checks for audio permissions, attempts to access the specified audio input device,
+ * and updates the application's state accordingly. If the audio input device cannot be accessed,
+ * it will revert to the previous audio input device.
+ *
+ * @param {SwitchUserAudioOptions} options - The options for switching the user's audio input device.
+ * @param {string} options.audioPreference - The preferred audio input device ID.
+ * @param {SwitchUserAudioParameters} options.parameters - Additional parameters required for switching the audio input device.
+ * @param {string} options.parameters.prevAudioInputDevice - The previous audio input device ID.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {boolean} options.parameters.hasAudioPermission - Flag indicating if the user has granted audio permission.
+ * @param {Function} options.parameters.updateUserDefaultAudioInputDevice - Function to update the user's default audio input device.
+ * @param {Function} options.parameters.streamSuccessAudioSwitch - Function to handle successful audio stream switch.
+ * @param {Function} options.parameters.requestPermissionAudio - Function to request audio permission from the user.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check if media permission is granted.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio input device has been successfully switched.
+ *
+ * @throws Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.
+ *
+ * @example
+ * await switchUserAudio({
+ *   audioPreference: 'new-audio-device-id',
+ *   parameters: {
+ *     prevAudioInputDevice: 'previous-device-id',
+ *     hasAudioPermission: true,
+ *     updateUserDefaultAudioInputDevice: updateDeviceFunction,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class SwitchUserAudio {
     /**
      * Switches the user's audio input device based on the provided audio preference.

package/dist/lib/consumers/switch-user-video-alt.service.d.ts

@@ -22,6 +22,38 @@ export interface SwitchUserVideoAltOptions {
     parameters: SwitchUserVideoAltParameters;
 }
 export type SwitchUserVideoAltType = (options: SwitchUserVideoAltOptions) => Promise<void>;
+/**
+ * Switches the user's video stream based on the provided video preference and other parameters.
+ *
+ * This method manages the process of switching the user's video input device,
+ * checking permissions, and updating the relevant application state.
+ * If the specified device is not accessible, it attempts to find an alternative.
+ *
+ * @param {SwitchUserVideoAltOptions} options - The options for switching the user's video.
+ * @param {string} options.videoPreference - The preferred video input device ID.
+ * @param {boolean} options.checkoff - A flag indicating whether to turn off the video before switching.
+ * @param {SwitchUserVideoAltParameters} options.parameters - The parameters required for switching the video.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages to the user.
+ * @param {boolean} options.parameters.hasCameraPermission - Flag indicating if the user has granted camera permission.
+ * @param {Function} options.parameters.updateVideoSwitching - Function to update the video switching state.
+ * @param {Function} options.parameters.requestPermissionCamera - Function to request camera permission from the user.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check if media permissions are granted.
+ *
+ * @returns {Promise<void>} A promise that resolves when the video switching is complete.
+ *
+ * @throws Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.
+ *
+ * @example
+ * await switchUserVideoAlt({
+ *   videoPreference: 'user',
+ *   checkoff: false,
+ *   parameters: {
+ *     hasCameraPermission: true,
+ *     updateVideoSwitching: (state) => { /* update state *\/ },
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class SwitchUserVideoAlt {
     private ClickVideoService;
     constructor(ClickVideoService: ClickVideo);

package/dist/lib/consumers/switch-user-video.service.d.ts

@@ -24,6 +24,53 @@ export interface SwitchUserVideoOptions {
     parameters: SwitchUserVideoParameters;
 }
 export type SwitchUserVideoType = (options: SwitchUserVideoOptions) => Promise<void>;
+/**
+ * Switches the user's video input device based on the provided options.
+ *
+ * This method checks permissions, enumerates available devices, and updates the
+ * video stream based on user preferences. It also manages UI updates and alerts.
+ *
+ * @param {SwitchUserVideoOptions} options - The options for switching the user's video.
+ * @param {string} options.videoPreference - The preferred video input device ID.
+ * @param {boolean} options.checkoff - Flag indicating whether to turn off the video.
+ * @param {SwitchUserVideoParameters} options.parameters - Additional parameters required for switching the video.
+ * @param {boolean} options.parameters.audioOnlyRoom - Indicates if the room is audio-only.
+ * @param {number} options.parameters.frameRate - The desired frame rate for the video.
+ * @param {Object} options.parameters.vidCons - Video constraints such as width and height.
+ * @param {string} options.parameters.prevVideoInputDevice - The previous video input device ID.
+ * @param {Function} options.parameters.showAlert - Function to show alerts to the user.
+ * @param {boolean} options.parameters.hasCameraPermission - Indicates if the user has camera permission.
+ * @param {Function} options.parameters.updateVideoSwitching - Function to update video switching state.
+ * @param {Function} options.parameters.updateUserDefaultVideoInputDevice - Function to update the default video input device.
+ * @param {Function} options.parameters.requestPermissionCamera - Function to request camera permission.
+ * @param {Function} options.parameters.streamSuccessVideo - Function to handle successful video stream.
+ * @param {Function} options.parameters.sleep - Function to pause execution for a specified duration.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check media permissions.
+ *
+ * @returns {Promise<void>} A promise that resolves when the video input device has been successfully switched.
+ *
+ * @throws {Error} Throws an error if switching the video input device fails.
+ *
+ * @example
+ * await switchUserVideo({
+ *   videoPreference: 'user',
+ *   checkoff: false,
+ *   parameters: {
+ *     audioOnlyRoom: false,
+ *     frameRate: 30,
+ *     vidCons: { width: 1280, height: 720 },
+ *     prevVideoInputDevice: 'device-id',
+ *     showAlert: myShowAlertFunction,
+ *     hasCameraPermission: true,
+ *     updateVideoSwitching: myUpdateFunction,
+ *     updateUserDefaultVideoInputDevice: myUpdateFunction,
+ *     requestPermissionCamera: myRequestPermissionFunction,
+ *     streamSuccessVideo: myStreamSuccessFunction,
+ *     sleep: mySleepFunction,
+ *     checkMediaPermission: true,
+ *   },
+ * });
+ */
 export declare class SwitchUserVideo {
     private ClickVideoService;
     constructor(ClickVideoService: ClickVideo);

package/dist/lib/consumers/trigger.service.d.ts

@@ -26,6 +26,44 @@ export interface TriggerOptions {
     parameters: TriggerParameters;
 }
 export type TriggerType = (options: TriggerOptions) => Promise<void>;
+/**
+ * Triggers an update to the screen client based on the provided parameters.
+ *
+ * This function handles various conditions to determine the main screen person,
+ * adjusts the screen states, and emits an update to the screen client via socket.
+ *
+ * @param {TriggerOptions} options - The options for triggering the update.
+ * @param {string[]} options.ref_ActiveNames - Reference to the active names.
+ * @param {TriggerParameters} options.parameters - The parameters for the trigger.
+ * @returns {Promise<void>} A promise that resolves when the trigger is complete.
+ *
+ * @throws Will throw an error if the updateScreenClient operation fails.
+ *
+ * @example
+ * ```typescript
+ * await trigger({
+ *   ref_ActiveNames: ["user1", "user2"],
+ *   parameters: {
+ *     socket: socketInstance,
+ *     roomName: "room1",
+ *     screenStates: [{ mainScreenPerson: "user1", mainScreenFilled: true, adminOnMainScreen: false }],
+ *     participants: [{ name: "admin", islevel: "2" }],
+ *     updateDateState: 0,
+ *     lastUpdate: null,
+ *     nForReadjust: 0,
+ *     eventType: "conference",
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     whiteboardStarted: false,
+ *     whiteboardEnded: false,
+ *     updateUpdateDateState: (date) => {},
+ *     updateLastUpdate: (date) => {},
+ *     updateNForReadjust: (n) => {},
+ *     autoAdjust: async ({ n, parameters }) => [n, 0],
+ *   },
+ * });
+ * ```
+ */
 export declare class Trigger {
     /**
      * Triggers an update to the screen client based on the provided parameters.

package/dist/lib/consumers/update-mini-cards-grid.service.d.ts

@@ -23,6 +23,60 @@ export interface UpdateMiniCardsGridOptions {
     parameters: UpdateMiniCardsGridParameters;
 }
 export type UpdateMiniCardsGridType = (options: UpdateMiniCardsGridOptions) => Promise<void>;
+/**
+ * Updates the mini cards grid based on the specified rows and columns.
+ *
+ * This method calculates the dimensions for the mini cards based on the provided
+ * rows and columns, as well as the container sizes. It also considers pagination
+ * settings and updates the grid sizes accordingly. The method can update either
+ * the default grid or an alternative grid based on the `defal` parameter.
+ *
+ * @param {UpdateMiniCardsGridOptions} options - The options for updating the mini cards grid.
+ * @param {number} options.rows - The number of rows in the grid.
+ * @param {number} options.cols - The number of columns in the grid.
+ * @param {boolean} [options.defal=true] - Flag indicating whether to update the default grid or an alternative grid.
+ * @param {number} [options.actualRows=2] - The actual number of rows in the grid.
+ * @param {UpdateMiniCardsGridParameters} options.parameters - Additional parameters needed for the function.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Function} options.parameters.updateGridRows - Function to update the grid rows.
+ * @param {Function} options.parameters.updateGridCols - Function to update the grid columns.
+ * @param {Function} options.parameters.updateAltGridRows - Function to update the alternative grid rows.
+ * @param {Function} options.parameters.updateAltGridCols - Function to update the alternative grid columns.
+ * @param {Function} options.parameters.updateGridSizes - Function to update the grid sizes.
+ * @param {GridSizes} options.parameters.gridSizes - Object containing grid width and height.
+ * @param {string} options.parameters.paginationDirection - The direction of pagination ('horizontal' or 'vertical').
+ * @param {number} options.parameters.paginationHeightWidth - The height or width of pagination.
+ * @param {boolean} options.parameters.doPaginate - Flag indicating whether pagination is enabled.
+ * @param {ComponentSizes} options.parameters.componentSizes - Object containing container width and height.
+ * @param {EventType} options.parameters.eventType - The type of event ('chat', etc.).
+ *
+ * @returns {Promise<void>} - A Promise that resolves after updating the mini cards grid.
+ *
+ * @example
+ * ```typescript
+ * const gridOptions = {
+ *   rows: 3,
+ *   cols: 4,
+ *   parameters: {
+ *     getUpdatedAllParams: () => updatedParams,
+ *     updateGridRows: (rows) => console.log(`Grid Rows Updated: ${rows}`),
+ *     updateGridCols: (cols) => console.log(`Grid Cols Updated: ${cols}`),
+ *     updateAltGridRows: (rows) => console.log(`Alt Grid Rows Updated: ${rows}`),
+ *     updateAltGridCols: (cols) => console.log(`Alt Grid Cols Updated: ${cols}`),
+ *     updateGridSizes: (sizes) => console.log(`Grid Sizes Updated: ${JSON.stringify(sizes)}`),
+ *     gridSizes: { gridWidth: 100, gridHeight: 100 },
+ *     paginationDirection: 'horizontal',
+ *     paginationHeightWidth: 50,
+ *     doPaginate: true,
+ *     componentSizes: { otherWidth: 800, otherHeight: 600 },
+ *     eventType: 'chat',
+ *   },
+ * };
+ *
+ * const miniCardGridService = new UpdateMiniCardsGrid();
+ * miniCardGridService.updateMiniCardsGrid(gridOptions);
+ * ```
+ */
 export declare class UpdateMiniCardsGrid {
     /**
      * Updates the mini cards grid based on the specified rows and columns.

package/dist/lib/consumers/update-participant-audio-decibels.service.d.ts

@@ -7,6 +7,51 @@ export interface UpdateParticipantAudioDecibelsOptions {
     updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
 }
 export type UpdateParticipantAudioDecibelsType = (options: UpdateParticipantAudioDecibelsOptions) => void;
+/**
+ * Updates or adds a participant's audio decibel data in the array.
+ *
+ * This method checks if a participant's name exists in the audio decibels array.
+ * If it does, it updates the participant's `averageLoudness`; otherwise, it adds a new entry.
+ * After modification, it calls `updateAudioDecibels` to apply the changes to the array.
+ *
+ * @param {UpdateParticipantAudioDecibelsOptions} options - The options for updating participant audio decibels.
+ * @param {string} options.name - The name of the participant.
+ * @param {number} options.averageLoudness - The current average loudness of the participant.
+ * @param {AudioDecibels[]} options.audioDecibels - The array of current audio decibel entries.
+ * @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
+ *
+ * @returns {void} - This function does not return a value.
+ *
+ * @example
+ * ```typescript
+ * const audioDecibels = [
+ *   { name: 'Alice', averageLoudness: -10 },
+ *   { name: 'Bob', averageLoudness: -12 },
+ * ];
+ *
+ * const updateAudioDecibels = (newDecibels) => {
+ *   console.log('Updated audio decibels:', newDecibels);
+ * };
+ *
+ * const updateService = new UpdateParticipantAudioDecibels();
+ *
+ * // Update existing participant
+ * updateService.updateParticipantAudioDecibels({
+ *   name: 'Alice',
+ *   averageLoudness: -8,
+ *   audioDecibels,
+ *   updateAudioDecibels,
+ * });
+ *
+ * // Add a new participant
+ * updateService.updateParticipantAudioDecibels({
+ *   name: 'Charlie',
+ *   averageLoudness: -15,
+ *   audioDecibels,
+ *   updateAudioDecibels,
+ * });
+ * ```
+ */
 export declare class UpdateParticipantAudioDecibels {
     /**
      * Updates the audio decibels for a participant.

package/dist/lib/methods/background-methods/launch-background.service.d.ts

@@ -4,6 +4,31 @@ export interface LaunchBackgroundOptions {
     isBackgroundModalVisible: boolean;
 }
 export type LaunchBackgroundType = (options: LaunchBackgroundOptions) => void;
+/**
+ * Toggles the visibility of the background modal.
+ *
+ * This method updates the visibility state of the background modal by calling
+ * the provided update function with the negation of the current visibility state.
+ *
+ * @param {LaunchBackgroundOptions} options - The options object containing necessary variables and functions.
+ * @param {Function} options.updateIsBackgroundModalVisible - Function to update the visibility state of the background modal.
+ * @param {boolean} options.isBackgroundModalVisible - Current visibility state of the background modal.
+ *
+ * @returns {void}
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   updateIsBackgroundModalVisible: (isVisible) => {
+ *     console.log(`Background modal is now ${isVisible ? 'visible' : 'hidden'}.`);
+ *   },
+ *   isBackgroundModalVisible: false,
+ * };
+ *
+ * const launchBackgroundService = new LaunchBackground();
+ * launchBackgroundService.launchBackground(options);
+ * ```
+ */
 export declare class LaunchBackground {
     /**
      * Toggles the visibility of the background modal.

package/dist/lib/methods/breakout-room-methods/breakout-room-updated.service.d.ts

@@ -27,6 +27,77 @@ export interface BreakoutRoomUpdatedOptions {
     parameters: BreakoutRoomUpdatedParameters;
 }
 export type BreakoutRoomUpdatedType = (options: BreakoutRoomUpdatedOptions) => Promise<void>;
+/**
+ * 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 {BreakoutRoomUpdatedOptions} options - The options object containing the data and parameters.
+ * @param {BreakoutRoomUpdatedData} options.data - The data object containing information about the breakout rooms.
+ * @param {BreakoutRoomUpdatedParameters} options.parameters - The parameters object containing various state update functions and other parameters.
+ * @param {boolean} options.parameters.breakOutRoomStarted - Indicates if the breakout room has started.
+ * @param {boolean} options.parameters.breakOutRoomEnded - Indicates if the breakout room has ended.
+ * @param {Array<BreakoutParticipant[]>} options.parameters.breakoutRooms - The list of current breakout rooms.
+ * @param {number} options.parameters.hostNewRoom - The ID of the new room for the host.
+ * @param {string} options.parameters.islevel - The level of the breakout room (e.g., '2' for host).
+ * @param {Array<Participant>} options.parameters.participantsAll - The list of all participants.
+ * @param {Array<Participant>} options.parameters.participants - The list of participants who are not banned.
+ * @param {string} options.parameters.meetingDisplayType - The current display type of the meeting.
+ * @param {string} options.parameters.prevMeetingDisplayType - The previous display type of the meeting.
+ * @param {Function} options.parameters.updateBreakoutRooms - Function to update the breakout rooms.
+ * @param {Function} options.parameters.updateBreakOutRoomStarted - Function to update the breakout room started state.
+ * @param {Function} options.parameters.updateBreakOutRoomEnded - Function to update the breakout room ended state.
+ * @param {Function} options.parameters.updateHostNewRoom - Function to update the host's new room.
+ * @param {Function} options.parameters.updateMeetingDisplayType - Function to update the meeting display type.
+ * @param {Function} options.parameters.updateParticipantsAll - Function to update the list of all participants.
+ * @param {Function} options.parameters.updateParticipants - Function to update the list of participants who are not banned.
+ * @param {Function} options.parameters.onScreenChanges - Function to handle screen changes.
+ * @param {Function} options.parameters.rePort - Function to handle reporting.
+ *
+ * @returns {Promise<void>} A promise that resolves when the breakout room state has been updated.
+ *
+ * @throws Will throw an error if the update process fails.
+ *
+ * @example
+ * ```typescript
+ * 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);
+ * ```
+ */
 export declare class BreakoutRoomUpdated {
     /**
      * Updates the state of breakout rooms based on the provided data and parameters.

package/dist/lib/methods/breakout-room-methods/launch-breakout-rooms.service.d.ts

@@ -4,6 +4,30 @@ export interface LaunchBreakoutRoomsOptions {
     isBreakoutRoomsModalVisible: boolean;
 }
 export type LaunchBreakoutRoomsType = (options: LaunchBreakoutRoomsOptions) => void;
+/**
+ * Launches the breakout rooms by toggling the visibility of the breakout rooms modal.
+ *
+ * This method is used to show or hide the breakout rooms modal based on the current visibility state.
+ *
+ * @param {LaunchBreakoutRoomsOptions} options - The options object containing necessary variables and functions.
+ * @param {Function} options.updateIsBreakoutRoomsModalVisible - Function to update the visibility state of the breakout rooms modal.
+ * @param {boolean} options.isBreakoutRoomsModalVisible - Current visibility state of the breakout rooms modal.
+ *
+ * @returns {void}
+ *
+ * @example
+ * ```typescript
+ * const options: LaunchBreakoutRoomsOptions = {
+ *   updateIsBreakoutRoomsModalVisible: (isVisible) => {
+ *     console.log('Breakout Rooms Modal is now:', isVisible ? 'Visible' : 'Hidden');
+ *   },
+ *   isBreakoutRoomsModalVisible: false,
+ * };
+ *
+ * const launchBreakoutRoomsService = new LaunchBreakoutRooms();
+ * launchBreakoutRoomsService.launchBreakoutRooms(options);
+ * ```
+ */
 export declare class LaunchBreakoutRooms {
     /**
      * Launches the breakout rooms by toggling the visibility of the breakout rooms modal.

package/dist/lib/methods/co-host-methods/launch-co-host.service.d.ts

@@ -4,6 +4,30 @@ export interface LaunchCoHostOptions {
     isCoHostModalVisible: boolean;
 }
 export type LaunchCoHostType = (options: LaunchCoHostOptions) => void;
+/**
+ * Toggles the visibility of the co-host modal.
+ *
+ * This method is used to show or hide the co-host modal based on the current visibility state.
+ *
+ * @param {LaunchCoHostOptions} options - The options object containing necessary variables and functions.
+ * @param {Function} options.updateIsCoHostModalVisible - Function to update the visibility state of the co-host modal.
+ * @param {boolean} options.isCoHostModalVisible - Current visibility state of the co-host modal.
+ *
+ * @returns {void}
+ *
+ * @example
+ * ```typescript
+ * const options: LaunchCoHostOptions = {
+ *   updateIsCoHostModalVisible: (isVisible) => {
+ *     console.log('Co-Host Modal is now:', isVisible ? 'Visible' : 'Hidden');
+ *   },
+ *   isCoHostModalVisible: false,
+ * };
+ *
+ * const launchCoHostService = new launchCoHost();
+ * launchCoHostService.launchCoHost(options);
+ * ```
+ */
 export declare class launchCoHost {
     /**
      * Toggles the visibility of the co-host modal.

package/dist/lib/methods/co-host-methods/modify-co-host-settings.service.d.ts

@@ -13,6 +13,50 @@ export interface ModifyCoHostSettingsOptions {
     socket: Socket;
 }
 export type ModifyCoHostSettingsType = (options: ModifyCoHostSettingsOptions) => Promise<void>;
+/**
+ * Modifies the co-host settings for a given room.
+ *
+ * This method allows you to update the co-host for a chat room, set their responsibilities,
+ * and emit the relevant changes to the server. It also handles demo mode restrictions.
+ *
+ * @param {ModifyCoHostSettingsOptions} options - The options for modifying co-host settings.
+ * @param {string} options.roomName - The name of the room.
+ * @param {Function} options.showAlert - Function to show an alert message.
+ * @param {string} options.selectedParticipant - The participant selected to be co-host.
+ * @param {string} options.coHost - The current co-host.
+ * @param {Array<CoHostResponsibility>} options.coHostResponsibility - The responsibilities assigned to the co-host.
+ * @param {Function} options.updateIsCoHostModalVisible - Function to update the visibility of the co-host modal.
+ * @param {Function} options.updateCoHostResponsibility - Function to update the co-host responsibility.
+ * @param {Function} options.updateCoHost - Function to update the co-host.
+ * @param {Socket} options.socket - The socket instance for emitting events.
+ *
+ * @returns {Promise<void>} A promise that resolves when the co-host settings have been modified.
+ *
+ * @remarks
+ * - If the room is in demo mode (room name starts with "d"), co-host cannot be added and an alert is shown.
+ * - If a valid participant is selected, they are set as the new co-host.
+ * - The co-host responsibility is updated.
+ * - A socket event is emitted to update the co-host information.
+ * - The co-host modal is closed after updating the settings.
+ *
+ * @example
+ * ```typescript
+ * const options: ModifyCoHostSettingsOptions = {
+ *   roomName: 'mainRoom',
+ *   showAlert: (alert) => console.log(alert.message),
+ *   selectedParticipant: 'JohnDoe',
+ *   coHost: 'No coHost',
+ *   coHostResponsibility: ['manage participants', 'start/stop recording'],
+ *   updateIsCoHostModalVisible: (isVisible) => console.log('Co-host modal visible:', isVisible),
+ *   updateCoHostResponsibility: (responsibility) => console.log('Updated co-host responsibility:', responsibility),
+ *   updateCoHost: (coHost) => console.log('New co-host:', coHost),
+ *   socket: socketInstance,
+ * };
+ *
+ * const modifyCoHostService = new ModifyCoHostSettings();
+ * await modifyCoHostService.modifyCoHostSettings(options);
+ * ```
+ */
 export declare class ModifyCoHostSettings {
     /**
      * Modifies the co-host settings for a given room.

package/dist/lib/methods/display-settings-methods/launch-display-settings.service.d.ts

@@ -4,6 +4,28 @@ export interface LaunchDisplaySettingsOptions {
     isDisplaySettingsModalVisible: boolean;
 }
 export type LaunchDisplaySettingsType = (options: LaunchDisplaySettingsOptions) => void;
+/**
+ * Toggles the visibility of the display settings modal.
+ *
+ * This method allows you to show or hide the display settings modal by updating its visibility state.
+ *
+ * @param {LaunchDisplaySettingsOptions} options - The options for launching the display settings.
+ * @param {Function} options.updateIsDisplaySettingsModalVisible - Function to update the visibility state of the display settings modal.
+ * @param {boolean} options.isDisplaySettingsModalVisible - Current visibility state of the display settings modal.
+ *
+ * @returns {void}
+ *
+ * @example
+ * ```typescript
+ * const options: LaunchDisplaySettingsOptions = {
+ *   updateIsDisplaySettingsModalVisible: (isVisible) => console.log('Display settings modal is now:', isVisible),
+ *   isDisplaySettingsModalVisible: false,
+ * };
+ *
+ * const launchDisplaySettingsService = new LaunchDisplaySettings();
+ * launchDisplaySettingsService.launchDisplaySettings(options);
+ * ```
+ */
 export declare class LaunchDisplaySettings {
     /**
      * Toggles the visibility of the display settings modal.

package/dist/lib/methods/display-settings-methods/modify-display-settings.service.d.ts

@@ -33,6 +33,81 @@ export interface ModifyDisplaySettingsOptions {
     parameters: ModifyDisplaySettingsParameters;
 }
 export type ModifyDisplaySettingsType = (options: ModifyDisplaySettingsOptions) => Promise<void>;
+/**
+ * Modifies the display settings based on the provided parameters.
+ *
+ * This method updates the display settings for the meeting based on the participant's level,
+ * recording status, and other conditions. It validates display types and shows alerts
+ * when necessary. It also handles the display settings for breakout rooms.
+ *
+ * @param {ModifyDisplaySettingsOptions} options - The options containing the parameters to modify the display settings.
+ * @param {Object} options.parameters - The parameters for modifying the display settings.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {string} options.parameters.meetingDisplayType - The current meeting display type.
+ * @param {boolean} options.parameters.autoWave - Flag indicating if auto wave is enabled.
+ * @param {boolean} options.parameters.forceFullDisplay - Flag indicating if full display is forced.
+ * @param {boolean} options.parameters.meetingVideoOptimized - Flag indicating if the meeting video is optimized.
+ * @param {string} options.parameters.islevel - The current level of the meeting.
+ * @param {boolean} options.parameters.recordStarted - Flag indicating if recording has started.
+ * @param {boolean} options.parameters.recordResumed - Flag indicating if recording has resumed.
+ * @param {boolean} options.parameters.recordStopped - Flag indicating if recording has stopped.
+ * @param {boolean} options.parameters.recordPaused - Flag indicating if recording is paused.
+ * @param {string} options.parameters.recordingDisplayType - The current recording display type.
+ * @param {boolean} options.parameters.recordingVideoOptimized - Flag indicating if the recording video is optimized.
+ * @param {string} options.parameters.prevForceFullDisplay - The previous force full display value.
+ * @param {string} options.parameters.prevMeetingDisplayType - The previous meeting display type.
+ * @param {Function} options.parameters.updateMeetingDisplayType - Function to update the meeting display type.
+ * @param {Function} options.parameters.updateAutoWave - Function to update the auto wave setting.
+ * @param {Function} options.parameters.updateForceFullDisplay - Function to update the force full display setting.
+ * @param {Function} options.parameters.updateMeetingVideoOptimized - Function to update the meeting video optimization setting.
+ * @param {Function} options.parameters.updatePrevForceFullDisplay - Function to update the previous force full display setting.
+ * @param {Function} options.parameters.updatePrevMeetingDisplayType - Function to update the previous meeting display type.
+ * @param {Function} options.parameters.updateIsDisplaySettingsModalVisible - Function to update the visibility of the display settings modal.
+ * @param {Function} options.parameters.updateFirstAll - Function to update the first all setting.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window.
+ * @param {boolean} options.parameters.breakOutRoomStarted - Flag indicating if a breakout room has started.
+ * @param {boolean} options.parameters.breakOutRoomEnded - Flag indicating if a breakout room has ended.
+ * @param {Function} options.parameters.onScreenChanges - Function to handle screen changes.
+ *
+ * @returns {Promise<void>} A promise that resolves when the display settings have been modified.
+ *
+ * @example
+ * ```typescript
+ * const options: ModifyDisplaySettingsOptions = {
+ *   parameters: {
+ *     showAlert: (alert) => console.log(alert.message),
+ *     meetingDisplayType: 'video',
+ *     autoWave: true,
+ *     forceFullDisplay: false,
+ *     meetingVideoOptimized: true,
+ *     islevel: '1',
+ *     recordStarted: false,
+ *     recordResumed: false,
+ *     recordStopped: false,
+ *     recordPaused: false,
+ *     recordingDisplayType: 'media',
+ *     recordingVideoOptimized: false,
+ *     prevForceFullDisplay: false,
+ *     prevMeetingDisplayType: 'media',
+ *     updateMeetingDisplayType: (type) => console.log('Updated display type:', type),
+ *     updateAutoWave: (wave) => console.log('Updated auto wave:', wave),
+ *     updateForceFullDisplay: (fullDisplay) => console.log('Updated force full display:', fullDisplay),
+ *     updateMeetingVideoOptimized: (optimized) => console.log('Updated video optimization:', optimized),
+ *     updatePrevForceFullDisplay: (fullDisplay) => console.log('Updated previous full display:', fullDisplay),
+ *     updatePrevMeetingDisplayType: (type) => console.log('Updated previous display type:', type),
+ *     updateIsDisplaySettingsModalVisible: (isVisible) => console.log('Display settings modal is now:', isVisible),
+ *     updateFirstAll: (firstAll) => console.log('Updated first all:', firstAll),
+ *     updateUpdateMainWindow: (update) => console.log('Updated main window:', update),
+ *     breakOutRoomStarted: false,
+ *     breakOutRoomEnded: false,
+ *     onScreenChanges: async ({ changed, parameters }) => console.log('Screen changes:', changed),
+ *   },
+ * };
+ *
+ * const modifyDisplaySettingsService = new ModifyDisplaySettings();
+ * await modifyDisplaySettingsService.modifyDisplaySettings(options);
+ * ```
+ */
 export declare class ModifyDisplaySettings {
     /**
      * Modifies the display settings based on the provided parameters.

package/dist/lib/methods/exit-methods/confirm-exit.service.d.ts

@@ -7,6 +7,30 @@ export interface ConfirmExitOptions {
     ban?: boolean;
 }
 export type ConfirmExitType = (options: ConfirmExitOptions) => Promise<void>;
+/**
+ * Confirms the exit of a member from a room and optionally bans them.
+ *
+ * This method emits a socket event to disconnect the specified member from the given room.
+ * If the `ban` option is set to true, the member will be banned from rejoining the room.
+ *
+ * @param {ConfirmExitOptions} options - The options for confirming the exit.
+ * @param {Socket} options.socket - The socket instance to emit the event.
+ * @param {string} options.member - The member who is exiting.
+ * @param {string} options.roomName - The name of the room the member is exiting from.
+ * @param {boolean} [options.ban=false] - Whether to ban the member from the room.
+ * @returns {Promise<void>} A promise that resolves when the exit is confirmed.
+ *
+ * @example
+ * ```typescript
+ * const confirmExitService = new ConfirmExit();
+ * await confirmExitService.confirmExit({
+ *   socket: socketInstance,
+ *   member: 'JohnDoe',
+ *   roomName: 'Room1',
+ *   ban: true, // Optional: set to true if you want to ban the member
+ * });
+ * ```
+ */
 export declare class ConfirmExit {
     /**
      * Confirms the exit of a member from a room and optionally bans them.