mediasfu-angular 1.0.0 → 1.0.2

package/dist/lib/consumers/change-vids.service.d.ts

@@ -64,73 +64,138 @@ export interface ChangeVidsOptions {
     parameters: ChangeVidsParameters;
 }
 export type ChangeVidsType = (options: ChangeVidsOptions) => Promise<void>;
+/**
+ * Asynchronously changes the video streams based on the provided options.
+ *
+ * @param {Object} options - The options for changing video streams.
+ * @param {boolean} [options.screenChanged=false] - Indicates if the screen has changed.
+ * @param {ChangeVidsOptions} options.parameters - The parameters for changing video streams.
+ * @returns {Promise<void>} A promise that resolves when the video streams have been changed.
+ *
+ * @typedef {Object} ChangeVidsOptions
+ * @property {Function} getUpdatedAllParams - Function to get updated parameters.
+ * @property {Array} allVideoStreams - Array of all video streams.
+ * @property {Array} p_activeNames - Array of active participant names.
+ * @property {Array} activeNames - Array of active names.
+ * @property {Array} dispActiveNames - Array of displayed active names.
+ * @property {boolean} shareScreenStarted - Indicates if screen sharing has started.
+ * @property {boolean} shared - Indicates if the screen is shared.
+ * @property {Array} newLimitedStreams - Array of new limited streams.
+ * @property {Array} non_alVideoStreams - Array of non-al video streams.
+ * @property {Array} ref_participants - Array of reference participants.
+ * @property {Array} participants - Array of participants.
+ * @property {string} eventType - Type of the event.
+ * @property {string} islevel - Level of the participant.
+ * @property {string} member - Name of the member.
+ * @property {boolean} sortAudioLoudness - Indicates if audio loudness should be sorted.
+ * @property {Array} audioDecibels - Array of audio decibels.
+ * @property {Array} mixed_alVideoStreams - Array of mixed al video streams.
+ * @property {Array} non_alVideoStreams_muted - Array of muted non-al video streams.
+ * @property {string} remoteProducerId - ID of the remote producer.
+ * @property {Object} localStreamVideo - Local stream video object.
+ * @property {Array} oldAllStreams - Array of old all streams.
+ * @property {number} screenPageLimit - Limit of streams per screen page.
+ * @property {string} meetingDisplayType - Type of meeting display.
+ * @property {boolean} meetingVideoOptimized - Indicates if meeting video is optimized.
+ * @property {boolean} recordingVideoOptimized - Indicates if recording video is optimized.
+ * @property {string} recordingDisplayType - Type of recording display.
+ * @property {Array} paginatedStreams - Array of paginated streams.
+ * @property {number} itemPageLimit - Limit of items per page.
+ * @property {boolean} doPaginate - Indicates if pagination should be done.
+ * @property {boolean} prevDoPaginate - Indicates if pagination was previously done.
+ * @property {number} currentUserPage - Current user page number.
+ * @property {Array} breakoutRooms - Array of breakout rooms.
+ * @property {number} hostNewRoom - Index of the new room for the host.
+ * @property {boolean} breakOutRoomStarted - Indicates if breakout room has started.
+ * @property {boolean} breakOutRoomEnded - Indicates if breakout room has ended.
+ * @property {Object} virtualStream - Virtual stream object.
+ * @property {number} mainRoomsLength - Length of main rooms.
+ * @property {string} memberRoom - Room of the member.
+ * @property {Function} updateP_activeNames - Function to update active participant names.
+ * @property {Function} updateActiveNames - Function to update active names.
+ * @property {Function} updateDispActiveNames - Function to update displayed active names.
+ * @property {Function} updateNewLimitedStreams - Function to update new limited streams.
+ * @property {Function} updateNon_alVideoStreams - Function to update non-al video streams.
+ * @property {Function} updateRef_participants - Function to update reference participants.
+ * @property {Function} updateSortAudioLoudness - Function to update audio loudness sorting.
+ * @property {Function} updateMixed_alVideoStreams - Function to update mixed al video streams.
+ * @property {Function} updateNon_alVideoStreams_muted - Function to update muted non-al video streams.
+ * @property {Function} updatePaginatedStreams - Function to update paginated streams.
+ * @property {Function} updateDoPaginate - Function to update pagination status.
+ * @property {Function} updatePrevDoPaginate - Function to update previous pagination status.
+ * @property {Function} updateCurrentUserPage - Function to update current user page.
+ * @property {Function} updateNumberPages - Function to update number of pages.
+ * @property {Function} updateMainRoomsLength - Function to update main rooms length.
+ * @property {Function} updateMemberRoom - Function to update member room.
+ * @property {Function} mixStreams - Function to mix streams.
+ * @property {Function} dispStreams - Function to display streams.
+ *
+ *
+ * @example
+ * ```typescript
+ * await changeVidsService.changeVids({
+ *   screenChanged: true,
+ *   parameters: {
+ *     allVideoStreams: [], // Your array of video streams
+ *     p_activeNames: [], // Active participant names
+ *     activeNames: [], // Names of active streams
+ *     dispActiveNames: [], // Names of displayed active streams
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     newLimitedStreams: [], // New limited streams
+ *     non_alVideoStreams: [], // Non-audio video streams
+ *     ref_participants: [], // Reference participants
+ *     participants: [], // All participants
+ *     eventType: 'conference', // Type of event
+ *     islevel: '1', // Level of the participant
+ *     member: 'John Doe', // Member's name
+ *     sortAudioLoudness: true,
+ *     audioDecibels: [], // Audio decibel levels
+ *     mixed_alVideoStreams: [], // Mixed audio/video streams
+ *     non_alVideoStreams_muted: [], // Muted non-audio video streams
+ *     remoteProducerId: 'abc123',
+ *     localStreamVideo: null, // Local video stream
+ *     oldAllStreams: [], // Previous streams
+ *     screenPageLimit: 4, // Limit of streams per screen
+ *     meetingDisplayType: 'grid', // Type of display
+ *     meetingVideoOptimized: true, // Video optimization status
+ *     recordingVideoOptimized: false, // Recording optimization status
+ *     recordingDisplayType: 'video', // Recording display type
+ *     paginatedStreams: [], // Paginated streams
+ *     itemPageLimit: 2, // Items per page limit
+ *     doPaginate: true, // Pagination flag
+ *     prevDoPaginate: false, // Previous pagination state
+ *     currentUserPage: 1, // Current page number
+ *     breakoutRooms: [], // Breakout room information
+ *     hostNewRoom: 0, // Host room number
+ *     breakOutRoomStarted: false, // Breakout room status
+ *     breakOutRoomEnded: false, // Breakout room end status
+ *     virtualStream: null, // Virtual stream
+ *     mainRoomsLength: 3, // Number of main rooms
+ *     memberRoom: 1, // Member's room number
+ *     updateP_activeNames: (names) => {}, // Update function for active names
+ *     updateActiveNames: (names) => {}, // Update function for all names
+ *     updateDispActiveNames: (names) => {}, // Update function for displayed names
+ *     updateNewLimitedStreams: (streams) => {}, // Update function for limited streams
+ *     updateNon_alVideoStreams: (participants) => {}, // Update function for non-audio streams
+ *     updateRef_participants: (participants) => {}, // Update function for reference participants
+ *     updateSortAudioLoudness: (sort) => {}, // Update function for sorting audio
+ *     updateMixed_alVideoStreams: (streams) => {}, // Update function for mixed streams
+ *     updateNon_alVideoStreams_muted: (participants) => {}, // Update function for muted streams
+ *     updatePaginatedStreams: (streams) => {}, // Update function for paginated streams
+ *     updateDoPaginate: (paginate) => {}, // Update function for pagination
+ *     updatePrevDoPaginate: (paginate) => {}, // Update function for previous pagination
+ *     updateCurrentUserPage: (page) => {}, // Update function for current page
+ *     updateNumberPages: (pages) => {}, // Update function for number of pages
+ *     updateMainRoomsLength: (length) => {}, // Update function for main room length
+ *     updateMemberRoom: (room) => {}, // Update function for member's room
+ *     mixStreams: async ({ streams, displayType }) => {}, // Function to mix streams
+ *     dispStreams: async ({ streams, displayType }) => {}, // Function to display streams
+ *   },
+ * });
+ * ```
+ */
 export declare class ChangeVids {
-    /**
-     * Asynchronously changes the video streams based on the provided options.
-     *
-     * @param {Object} options - The options for changing video streams.
-     * @param {boolean} [options.screenChanged=false] - Indicates if the screen has changed.
-     * @param {ChangeVidsOptions} options.parameters - The parameters for changing video streams.
-     * @returns {Promise<void>} A promise that resolves when the video streams have been changed.
-     *
-     * @typedef {Object} ChangeVidsOptions
-     * @property {Function} getUpdatedAllParams - Function to get updated parameters.
-     * @property {Array} allVideoStreams - Array of all video streams.
-     * @property {Array} p_activeNames - Array of active participant names.
-     * @property {Array} activeNames - Array of active names.
-     * @property {Array} dispActiveNames - Array of displayed active names.
-     * @property {boolean} shareScreenStarted - Indicates if screen sharing has started.
-     * @property {boolean} shared - Indicates if the screen is shared.
-     * @property {Array} newLimitedStreams - Array of new limited streams.
-     * @property {Array} non_alVideoStreams - Array of non-al video streams.
-     * @property {Array} ref_participants - Array of reference participants.
-     * @property {Array} participants - Array of participants.
-     * @property {string} eventType - Type of the event.
-     * @property {string} islevel - Level of the participant.
-     * @property {string} member - Name of the member.
-     * @property {boolean} sortAudioLoudness - Indicates if audio loudness should be sorted.
-     * @property {Array} audioDecibels - Array of audio decibels.
-     * @property {Array} mixed_alVideoStreams - Array of mixed al video streams.
-     * @property {Array} non_alVideoStreams_muted - Array of muted non-al video streams.
-     * @property {string} remoteProducerId - ID of the remote producer.
-     * @property {Object} localStreamVideo - Local stream video object.
-     * @property {Array} oldAllStreams - Array of old all streams.
-     * @property {number} screenPageLimit - Limit of streams per screen page.
-     * @property {string} meetingDisplayType - Type of meeting display.
-     * @property {boolean} meetingVideoOptimized - Indicates if meeting video is optimized.
-     * @property {boolean} recordingVideoOptimized - Indicates if recording video is optimized.
-     * @property {string} recordingDisplayType - Type of recording display.
-     * @property {Array} paginatedStreams - Array of paginated streams.
-     * @property {number} itemPageLimit - Limit of items per page.
-     * @property {boolean} doPaginate - Indicates if pagination should be done.
-     * @property {boolean} prevDoPaginate - Indicates if pagination was previously done.
-     * @property {number} currentUserPage - Current user page number.
-     * @property {Array} breakoutRooms - Array of breakout rooms.
-     * @property {number} hostNewRoom - Index of the new room for the host.
-     * @property {boolean} breakOutRoomStarted - Indicates if breakout room has started.
-     * @property {boolean} breakOutRoomEnded - Indicates if breakout room has ended.
-     * @property {Object} virtualStream - Virtual stream object.
-     * @property {number} mainRoomsLength - Length of main rooms.
-     * @property {string} memberRoom - Room of the member.
-     * @property {Function} updateP_activeNames - Function to update active participant names.
-     * @property {Function} updateActiveNames - Function to update active names.
-     * @property {Function} updateDispActiveNames - Function to update displayed active names.
-     * @property {Function} updateNewLimitedStreams - Function to update new limited streams.
-     * @property {Function} updateNon_alVideoStreams - Function to update non-al video streams.
-     * @property {Function} updateRef_participants - Function to update reference participants.
-     * @property {Function} updateSortAudioLoudness - Function to update audio loudness sorting.
-     * @property {Function} updateMixed_alVideoStreams - Function to update mixed al video streams.
-     * @property {Function} updateNon_alVideoStreams_muted - Function to update muted non-al video streams.
-     * @property {Function} updatePaginatedStreams - Function to update paginated streams.
-     * @property {Function} updateDoPaginate - Function to update pagination status.
-     * @property {Function} updatePrevDoPaginate - Function to update previous pagination status.
-     * @property {Function} updateCurrentUserPage - Function to update current user page.
-     * @property {Function} updateNumberPages - Function to update number of pages.
-     * @property {Function} updateMainRoomsLength - Function to update main rooms length.
-     * @property {Function} updateMemberRoom - Function to update member room.
-     * @property {Function} mixStreams - Function to mix streams.
-     * @property {Function} dispStreams - Function to display streams.
-     */
     changeVids: ({ screenChanged, parameters }: ChangeVidsOptions) => Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChangeVids, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ChangeVids>;

package/dist/lib/consumers/check-grid.service.d.ts

@@ -5,25 +5,39 @@ export interface CheckGridOptions {
     actives: number;
 }
 export type CheckGridType = (options: CheckGridOptions) => Promise<[boolean, number, number, number, number, number, number] | void>;
+/**
+ * Checks the grid configuration and calculates various parameters based on the number of rows, columns, and active elements.
+ *
+ * @param {CheckGridOptions} options - The options for checking the grid.
+ * @param {number} options.rows - The number of rows in the grid.
+ * @param {number} options.cols - The number of columns in the grid.
+ * @param {number} options.actives - The number of active elements in the grid.
+ * @returns {Promise<[boolean, number, number, number, number, number, number] | void>} A promise that resolves to a tuple containing:
+ * - `removeAltGrid` (boolean): Indicates whether to remove the alternate grid.
+ * - `numtoadd` (number): The number of elements to add.
+ * - `numRows` (number): The number of rows.
+ * - `numCols` (number): The number of columns.
+ * - `remainingVideos` (number): The number of remaining videos.
+ * - `actualRows` (number): The actual number of rows.
+ * - `lastrowcols` (number): The number of columns in the last row.
+ *
+ * If an error occurs, it logs the error to the console.
+ *
+ *   *
+ * @example
+ * ```typescript
+ * const options = {
+ *   rows: 3,
+ *   cols: 4,
+ *   actives: 10,
+ * };
+ *
+ * const result = await checkGridService.checkGrid(options);
+ * console.log(result);
+ * // Output could be: [false, 2, 3, 4, 2, 3, 2]
+ * ```
+ */
 export declare class CheckGrid {
-    /**
-     * Checks the grid configuration and calculates various parameters based on the number of rows, columns, and active elements.
-     *
-     * @param {CheckGridOptions} options - The options for checking the grid.
-     * @param {number} options.rows - The number of rows in the grid.
-     * @param {number} options.cols - The number of columns in the grid.
-     * @param {number} options.actives - The number of active elements in the grid.
-     * @returns {Promise<[boolean, number, number, number, number, number, number] | void>} A promise that resolves to a tuple containing:
-     * - `removeAltGrid` (boolean): Indicates whether to remove the alternate grid.
-     * - `numtoadd` (number): The number of elements to add.
-     * - `numRows` (number): The number of rows.
-     * - `numCols` (number): The number of columns.
-     * - `remainingVideos` (number): The number of remaining videos.
-     * - `actualRows` (number): The actual number of rows.
-     * - `lastrowcols` (number): The number of columns in the last row.
-     *
-     * If an error occurs, it logs the error to the console.
-     */
     checkGrid({ rows, cols, actives, }: CheckGridOptions): Promise<[boolean, number, number, number, number, number, number] | void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<CheckGrid, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<CheckGrid>;

package/dist/lib/consumers/check-permission.service.d.ts

@@ -7,6 +7,31 @@ export interface CheckPermissionOptions {
     permissionType: 'audioSetting' | 'videoSetting' | 'screenshareSetting' | 'chatSetting';
 }
 export type CheckPermissionType = (options: CheckPermissionOptions) => Promise<number>;
+/**
+ * Checks the permission based on the provided settings.
+ *
+ * @param {CheckPermissionOptions} options - The options for checking permissions.
+ * @param {string} options.permissionType - The type of permission to check. Can be "audioSetting", "videoSetting", "screenshareSetting", or "chatSetting".
+ * @param {string} options.audioSetting - The setting for audio permission. Can be "allow", "approval", or other.
+ * @param {string} options.videoSetting - The setting for video permission. Can be "allow", "approval", or other.
+ * @param {string} options.screenshareSetting - The setting for screenshare permission. Can be "allow", "approval", or other.
+ * @param {string} options.chatSetting - The setting for chat permission. Can be "allow", "approval", or other.
+ * @returns {Promise<number>} - Returns 0 if the setting is "allow", 1 if the setting is "approval", and 2 for other settings or invalid permission types.
+ * @throws Will throw an error if an unexpected error occurs during the permission check.
+ *
+ * @example
+ * const options = {
+ *   permissionType: 'videoSetting',
+ *   audioSetting: 'allow',
+ *   videoSetting: 'approval',
+ *   screenshareSetting: 'deny',
+ *   chatSetting: 'allow',
+ * };
+ *
+ * const result = await checkPermissionService.checkPermission(options);
+ * console.log(result);
+ * // Output: 1 (since videoSetting is 'approval')
+ */
 export declare class CheckPermission {
     /**
      * Checks the permission based on the provided settings.

package/dist/lib/consumers/check-screen-share.service.d.ts

@@ -16,6 +16,41 @@ export interface CheckScreenShareOptions {
     parameters: CheckScreenShareParameters;
 }
 export type CheckScreenShareType = (options: CheckScreenShareOptions) => Promise<void>;
+/**
+ * Checks the current screen sharing status and either stops or requests screen sharing based on the provided parameters.
+ *
+ * @param {CheckScreenShareOptions} options - The options for checking screen share.
+ * @param {Object} options.parameters - The parameters for screen sharing.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is currently being shared.
+ * @param {Function} [options.parameters.showAlert] - Function to show alerts.
+ * @param {boolean} options.parameters.whiteboardStarted - Indicates if the whiteboard session has started.
+ * @param {boolean} options.parameters.whiteboardEnded - Indicates if the whiteboard session has ended.
+ * @param {boolean} options.parameters.breakOutRoomStarted - Indicates if the breakout room session has started.
+ * @param {boolean} options.parameters.breakOutRoomEnded - Indicates if the breakout room session has ended.
+ * @param {Function} options.parameters.stopShareScreen - Function to stop screen sharing.
+ * @param {Function} options.parameters.requestScreenShare - Function to request screen sharing.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen sharing status has been checked and the appropriate action has been taken.
+ *
+ * @throws Will log an error message if an error occurs during the process.
+ *
+ * @example
+ * const options = {
+ *   parameters: {
+ *     shared: false,
+ *     whiteboardStarted: false,
+ *     whiteboardEnded: false,
+ *     breakOutRoomStarted: false,
+ *     breakOutRoomEnded: false,
+ *     stopShareScreen: async () => { /* Logic to stop screen sharing *\/ },
+ *     requestScreenShare: async () => { /* Logic to request screen sharing *\/ },
+ *     showAlert: (alert) => { console.log(alert.message); },
+ *   },
+ * };
+ *
+ * await checkScreenShareService.checkScreenShare(options);
+ * // Output: Logic to request screen sharing will be executed.
+ */
 export declare class CheckScreenShare {
     /**
      * Checks the current screen sharing status and either stops or requests screen sharing based on the provided parameters.

package/dist/lib/consumers/close-and-resize.service.d.ts

@@ -49,6 +49,108 @@ export interface CloseAndResizeOptions {
     parameters: CloseAndResizeParameters;
 }
 export type CloseAndResizeType = (options: CloseAndResizeOptions) => Promise<void>;
+/**
+ * Closes and resizes the video and audio elements based on the provided options.
+ *
+ * @param {CloseAndResizeOptions} options - The options for closing and resizing.
+ * @param {string} options.producerId - The ID of the producer.
+ * @param {string} options.kind - The kind of media (audio, video, screenshare, or screen).
+ * @param {object} options.parameters - The parameters for the operation.
+ * @param {function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Array} options.parameters.allAudioStreams - Array of all audio streams.
+ * @param {Array} options.parameters.allVideoStreams - Array of all video streams.
+ * @param {Array} options.parameters.activeNames - Array of active participant names.
+ * @param {Array} options.parameters.participants - Array of participants.
+ * @param {Array} options.parameters.streamNames - Array of stream names.
+ * @param {string} options.parameters.recordingDisplayType - Type of recording display.
+ * @param {boolean} options.parameters.recordingVideoOptimized - Whether recording is video optimized.
+ * @param {string} options.parameters.adminIDStream - ID of the admin stream.
+ * @param {Array} options.parameters.newLimitedStreams - Array of new limited streams.
+ * @param {Array} options.parameters.newLimitedStreamsIDs - Array of new limited stream IDs.
+ * @param {Array} options.parameters.oldAllStreams - Array of old all streams.
+ * @param {boolean} options.parameters.shareScreenStarted - Whether screen sharing has started.
+ * @param {boolean} options.parameters.shared - Whether sharing is active.
+ * @param {string} options.parameters.meetingDisplayType - Type of meeting display.
+ * @param {boolean} options.parameters.defer_receive - Whether to defer receiving.
+ * @param {boolean} options.parameters.lock_screen - Whether the screen is locked.
+ * @param {boolean} options.parameters.firstAll - Whether it is the first all.
+ * @param {boolean} options.parameters.first_round - Whether it is the first round.
+ * @param {boolean} options.parameters.gotAllVids - Whether all videos are received.
+ * @param {string} options.parameters.eventType - Type of event.
+ * @param {string} options.parameters.hostLabel - Label of the host.
+ * @param {boolean} options.parameters.shareEnded - Whether sharing has ended.
+ * @param {boolean} options.parameters.updateMainWindow - Whether to update the main window.
+ * @param {function} options.parameters.updateActiveNames - Function to update active names.
+ * @param {function} options.parameters.updateAllAudioStreams - Function to update all audio streams.
+ * @param {function} options.parameters.updateAllVideoStreams - Function to update all video streams.
+ * @param {function} options.parameters.updateShareScreenStarted - Function to update share screen started status.
+ * @param {function} options.parameters.updateUpdateMainWindow - Function to update main window status.
+ * @param {function} options.parameters.updateNewLimitedStreams - Function to update new limited streams.
+ * @param {function} options.parameters.updateOldAllStreams - Function to update old all streams.
+ * @param {function} options.parameters.updateDefer_receive - Function to update defer receive status.
+ * @param {function} options.parameters.updateMainHeightWidth - Function to update main height and width.
+ * @param {function} options.parameters.updateShareEnded - Function to update share ended status.
+ * @param {function} options.parameters.updateLock_screen - Function to update lock screen status.
+ * @param {function} options.parameters.updateFirstAll - Function to update first all status.
+ * @param {function} options.parameters.updateFirst_round - Function to update first round status.
+ * @param {function} options.parameters.reorderStreams - Function to reorder streams.
+ * @param {function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ * @param {function} options.parameters.getVideos - Function to get videos.
+ * @param {function} options.parameters.rePort - Function to report.
+ *
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ *
+ * @example
+ * const options = {
+ *   producerId: '12345',
+ *   kind: 'video',
+ *   parameters: {
+ *     getUpdatedAllParams: () => { /* Logic to get updated parameters *\/ },
+ *     allAudioStreams: [],
+ *     allVideoStreams: [],
+ *     activeNames: ['Participant1', 'Participant2'],
+ *     participants: [],
+ *     streamNames: [],
+ *     recordingDisplayType: 'video',
+ *     recordingVideoOptimized: true,
+ *     adminIDStream: 'admin123',
+ *     newLimitedStreams: [],
+ *     newLimitedStreamsIDs: [],
+ *     oldAllStreams: [],
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     meetingDisplayType: 'media',
+ *     defer_receive: false,
+ *     lock_screen: false,
+ *     firstAll: false,
+ *     first_round: false,
+ *     gotAllVids: false,
+ *     eventType: 'conference',
+ *     hostLabel: 'Host',
+ *     shareEnded: false,
+ *     updateMainWindow: false,
+ *     updateActiveNames: (names) => { /* Logic to update active names *\/ },
+ *     updateAllAudioStreams: (streams) => { /* Logic to update audio streams *\/ },
+ *     updateShareScreenStarted: (status) => { /* Logic to update share screen status *\/ },
+ *     updateUpdateMainWindow: (status) => { /* Logic to update main window status *\/ },
+ *     updateNewLimitedStreams: (streams) => { /* Logic to update new limited streams *\/ },
+ *     updateOldAllStreams: (streams) => { /* Logic to update old streams *\/ },
+ *     updateDefer_receive: (status) => { /* Logic to update defer receive status *\/ },
+ *     updateMainHeightWidth: (size) => { /* Logic to update main height and width *\/ },
+ *     updateShareEnded: (status) => { /* Logic to update share ended status *\/ },
+ *     updateLock_screen: (status) => { /* Logic to update lock screen status *\/ },
+ *     updateFirstAll: (status) => { /* Logic to update first all status *\/ },
+ *     updateFirst_round: (status) => { /* Logic to update first round status *\/ },
+ *     reorderStreams: async () => { /* Logic to reorder streams *\/ },
+ *     prepopulateUserMedia: async () => { /* Logic to prepopulate user media *\/ },
+ *     getVideos: async () => { /* Logic to get videos *\/ },
+ *     rePort: async () => { /* Logic to report *\/ },
+ *   },
+ * };
+ *
+ * await closeAndResizeService.closeAndResize(options);
+ * // The operation will adjust the video and audio elements as per the given parameters.
+ */
 export declare class CloseAndResize {
     /**
      * Closes and resizes the video and audio elements based on the provided options.

package/dist/lib/consumers/compare-active-names.service.d.ts

@@ -14,6 +14,37 @@ export interface CompareActiveNamesOptions {
     parameters: CompareActiveNamesParameters;
 }
 export type CompareActiveNamesType = (options: CompareActiveNamesOptions) => Promise<void>;
+/**
+ * Compares the current active names with the previous active names and triggers an action if there are changes.
+ *
+ * @param {CompareActiveNamesOptions} options - The options for comparing active names.
+ * @param {boolean} [options.restart=false] - Whether to restart the comparison.
+ * @param {CompareActiveNamesParameters} options.parameters - The parameters for the comparison.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {string[]} options.parameters.activeNames - The current active names.
+ * @param {string[]} options.parameters.prevActiveNames - The previous active names.
+ * @param {Function} options.parameters.updatePrevActiveNames - Function to update the previous active names.
+ * @param {Function} options.parameters.trigger - Function to trigger an action when names change.
+ *
+ * @returns {Promise<void>} A promise that resolves when the comparison is complete.
+ *
+ * @throws Will log an error message if an error occurs during the comparison.
+ *
+ * @example
+ * const options = {
+ *   restart: false,
+ *   parameters: {
+ *     getUpdatedAllParams: () => { /* Logic to get updated parameters *\/ },
+ *     activeNames: ['Alice', 'Bob'],
+ *     prevActiveNames: ['Alice', 'Charlie'],
+ *     updatePrevActiveNames: (names) => { /* Logic to update previous active names *\/ },
+ *     trigger: async (data) => { /* Logic to handle the trigger *\/ },
+ *   },
+ * };
+ *
+ * await compareActiveNamesService.compareActiveNames(options);
+ * // If 'Bob' is not in the previous active names, it will trigger the action.
+ */
 export declare class CompareActiveNames {
     /**
      * Compares the current active names with the previous active names and triggers an action if there are changes.

package/dist/lib/consumers/compare-screen-states.service.d.ts

@@ -15,6 +15,41 @@ export interface CompareScreenStatesOptions {
     parameters: CompareScreenStatesParameters;
 }
 export type CompareScreenStatesType = (options: CompareScreenStatesOptions) => Promise<void>;
+/**
+   * Compares the current screen states with the previous screen states and triggers actions based on changes.
+   *
+   * @param {CompareScreenStatesOptions} options - The options for comparing screen states.
+   * @param {boolean} [options.restart=false] - Whether to restart the comparison process.
+   * @param {CompareScreenStatesParameters} options.parameters - The parameters for the comparison.
+   * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+   * @param {string} options.parameters.recordingDisplayType - The type of display being recorded.
+   * @param {boolean} options.parameters.recordingVideoOptimized - Whether the recording is optimized for video.
+   * @param {ScreenState[]} options.parameters.screenStates - The current screen states.
+   * @param {ScreenState[]} options.parameters.prevScreenStates - The previous screen states.
+   * @param {string[]} options.parameters.activeNames - The active names in the current context.
+   * @param {Function} options.parameters.trigger - Function to trigger actions based on changes.
+   *
+   * @returns {Promise<void>} A promise that resolves when the comparison and any triggered actions are complete.
+   *
+   * @throws Will log an error message if an error occurs during the comparison process.
+   *
+   * @example
+   * const options = {
+   *   restart: false,
+   *   parameters: {
+   *     getUpdatedAllParams: () => { /* Logic to get updated parameters *\/ },
+   *     recordingDisplayType: 'video',
+   *     recordingVideoOptimized: true,
+   *     screenStates: [{ state: 'active' }, { state: 'inactive' }],
+   *     prevScreenStates: [{ state: 'inactive' }, { state: 'active' }],
+   *     activeNames: ['Alice', 'Bob'],
+   *     trigger: async (data) => { /* Logic to handle the trigger *\/ },
+   *   },
+   * };
+   *
+   * await compareScreenStatesService.compareScreenStates(options);
+   * // If any screen state has changed, the trigger function will be called accordingly.
+   */
 export declare class CompareScreenStates {
     /**
      * Compares the current screen states with the previous screen states and triggers actions based on changes.

package/dist/lib/consumers/connect-ips.service.d.ts

@@ -26,6 +26,48 @@ export interface ConnectIpsOptions {
     parameters: ConnectIpsParameters;
 }
 export type ConnectIpsType = (options: ConnectIpsOptions) => Promise<[Record<string, any>[], string[]]>;
+/**
+ * Connects to remote IPs and manages socket connections.
+ *
+ * This method establishes connections to remote IPs for media streaming, handles new pipe producer events,
+ * and manages producer closure events. It updates the necessary state in the application to reflect
+ * the current connections and stream configurations.
+ *
+ * @param {ConnectIpsOptions} options - The options for connecting IPs.
+ * @param {Record<string, any>[]} options.consume_sockets - The array of current socket connections.
+ * @param {string[]} options.remIP - The list of remote IPs to connect to.
+ * @param {string} options.apiUserName - The API username for authentication.
+ * @param {string} [options.apiKey] - The API key for authentication.
+ * @param {string} [options.apiToken] - The API token for authentication.
+ * @param {Function} [options.newProducerMethod] - The method to handle new pipe producer events (default: newPipeProducer).
+ * @param {Function} [options.closedProducerMethod] - The method to handle producer closed events (default: producerClosed).
+ * @param {Function} [options.joinConsumeRoomMethod] - The method to handle joining a consuming room (default: joinConsumeRoom).
+ * @param {ConnectIpsParameters} options.parameters - Additional parameters for the operation.
+ * @param {string[]} options.parameters.roomRecvIPs - The list of IPs that have been received in the room.
+ * @param {Function} options.parameters.updateRoomRecvIPs - Function to update the room received IPs.
+ * @param {Function} options.parameters.updateConsume_sockets - Function to update the consume sockets.
+ *
+ * @returns {Promise<[Record<string, any>[], string[]]>} A promise that resolves to an array containing the updated consume sockets and room received IPs.
+ *
+ * @throws Will throw an error if required parameters are missing or if there is an issue connecting to a remote IP.
+ *
+ * @example
+ * ```typescript
+ * const result = await connectIps({
+ *   consume_sockets: currentSockets,
+ *   remIP: ['192.168.1.1', '192.168.1.2'],
+ *   apiUserName: 'username',
+ *   apiKey: 'your-api-key',
+ *   apiToken: 'your-api-token',
+ *   parameters: {
+ *     roomRecvIPs: [],
+ *     updateRoomRecvIPs: (ips) => { },
+ *     updateConsume_sockets: (sockets) => { },
+ *     // ...other parameters
+ *   },
+ * });
+ * ```
+ */
 export declare class ConnectIps {
     private socketManagerService;
     private newPipeProducerService;

package/dist/lib/consumers/connect-recv-transport.service.d.ts

@@ -18,6 +18,39 @@ export interface ConnectRecvTransportOptions {
     parameters: ConnectRecvTransportParameters;
 }
 export type ConnectRecvTransportType = (options: ConnectRecvTransportOptions) => Promise<void>;
+/**
+ * Connects the receiving transport to consume media from a remote producer.
+ *
+ * @param {ConnectRecvTransportOptions} options - The options for connecting the receiving transport.
+ * @param {Transport} options.consumerTransport - The transport used for consuming media.
+ * @param {string} options.remoteProducerId - The ID of the remote producer.
+ * @param {string} options.serverConsumerTransportId - The ID of the server consumer transport.
+ * @param {Socket} options.nsock - The socket used for communication.
+ * @param {ConnectRecvTransportParameters} options.parameters - The parameters for the connection.
+ *
+ * @returns {Promise<void>} A promise that resolves when the connection is established.
+ *
+ * @throws Will throw an error if the connection or consumption fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   consumerTransport,
+ *   remoteProducerId: 'producer-id',
+ *   serverConsumerTransportId: 'transport-id',
+ *   nsock: socket,
+ *   parameters: connectRecvTransportOptions,
+ * };
+ *
+ * connectRecvTransport(options)
+ *   .then(() => {
+ *     console.log('Transport connected and consuming media');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error connecting transport:', error);
+ *   });
+ * ```
+ */
 export declare class ConnectRecvTransport {
     /**
      * Connects the receiving transport to consume media from a remote producer.