mediasfu-angular 1.0.1 → 1.0.2

package/dist/lib/components/requests-components/render-request-component/render-request-component.component.d.ts

@@ -11,6 +11,28 @@ export interface RenderRequestComponentOptions {
     socket: Socket;
 }
 export type RenderRequestComponentType = (options: RenderRequestComponentOptions) => HTMLElement;
+/**
+ * @component RenderRequestComponent
+ * @description Component to render and manage individual requests in a list. Each request can be responded to with specified actions (e.g., approve, deny).
+ *
+ * @selector app-render-request-component
+ * @standalone true
+ * @imports [CommonModule, FontAwesomeModule]
+ * @templateUrl ./render-request-component.component.html
+ * @styleUrls ./render-request-component.component.css
+ *
+ * @example
+ * ```html
+ * <app-render-request-component
+ *   [request]="request"
+ *   [requestList]="requestList"
+ *   [roomName]="roomName"
+ *   [socket]="socket"
+ *   [onRequestItemPress]="handleRequestPress"
+ *   [updateRequestList]="updateRequestList">
+ * </app-render-request-component>
+ * ```
+ */
 export declare class RenderRequestComponent {
     request: Request;
     requestList: Request[];

package/dist/lib/components/requests-components/requests-modal/requests-modal.component.d.ts

@@ -64,6 +64,23 @@ export type RequestsModalType = (options: RenderRequestComponentOptions) => HTML
  * @method handleModalClose - Handles the modal close action.
  * @method handleFilterChange - Handles the filter change event.
  * @param {Event} event - The filter change event.
+ * @example
+ * ```html
+ * <app-requests-modal
+ *   [isRequestsModalVisible]="isModalVisible"
+ *   [requestCounter]="requestCounter"
+ *   [requestList]="requests"
+ *   [roomName]="roomName"
+ *   [socket]="socket"
+ *   [backgroundColor]="'#83c0e9'"
+ *   [position]="'topRight'"
+ *   [parameters]="requestParams"
+ *   (onRequestClose)="handleModalClose()"
+ *   (onRequestFilterChange)="handleFilterChange($event)"
+ *   (onRequestItemPress)="handleRequestPress($event)"
+ *   [updateRequestList]="updateRequestList">
+ * </app-requests-modal>
+ * ```
  */
 export declare class RequestsModal implements OnInit, OnChanges {
     private respondToRequestsService;

package/dist/lib/components/screenboard-components/screenboard/screenboard.component.d.ts

@@ -118,6 +118,16 @@ export type ScreenboardType = (options: ScreenboardOptions) => void;
  * @method isPointNearLine - Checks if a point is near a line.
  * @method toggleToolbar - Toggles the visibility of the toolbar.
  * @method toggleAnnotate - Toggles the annotation mode.
+ *
+ * @example
+ * ```html
+ * <app-screenboard
+ *  [customWidth]="customWidth"
+ * [customHeight]="customHeight"
+ * [parameters]="screenboardParameters"
+ * [showAspect]="showAspect"
+ * ></app-screenboard>
+ * ```
  */
 export declare class Screenboard implements OnInit, AfterViewInit, OnDestroy, OnChanges {
     customWidth: number;

package/dist/lib/components/screenboard-components/screenboard-modal/screenboard-modal.component.d.ts

@@ -74,6 +74,17 @@ export type ScreenboardModalType = (options: ScreenboardModalOptions) => HTMLEle
  * @method handleScreenTransport - Method to handle screen transport logic.
  * @method stopAnnotation - Method to stop the screen annotation.
  * @method stopAllTracks - Method to stop all media tracks.
+ * @returns {HTMLElement} The screenboard modal component.
+ * @example
+ * ```html
+ * <app-screenboard-modal
+ *  [parameters]="screenboardModalParams"
+ * [isVisible]="isModalVisible"
+ * [onClose]="closeModal"
+ * [position]="'topRight'"
+ * [backgroundColor]="'#83c0e9'">
+ * </app-screenboard-modal>
+ * ```
  */
 export declare class ScreenboardModal implements OnInit, OnDestroy, OnChanges, AfterViewInit {
     parameters: ScreenboardModalParameters;

package/dist/lib/components/waiting-components/waiting-room-modal.component.d.ts

@@ -23,6 +23,65 @@ export interface WaitingRoomModalOptions {
     onWaitingRoomItemPress?: RespondToWaitingType;
 }
 export type WaitingRoomModalType = (options: WaitingRoomModalOptions) => HTMLElement;
+/**
+ * Component representing a modal for managing participants in a waiting room.
+ *
+ * @component
+ * @selector app-waiting-room-modal
+ * @standalone true
+ * @imports CommonModule, FontAwesomeModule, FormsModule
+ * @templateUrl ./waiting-room-modal.component.html
+ * @styleUrls ['./waiting-room-modal.component.css']
+ *
+ * @property {boolean} isWaitingModalVisible - Visibility state of the modal.
+ * @property {number} waitingRoomCounter - Counter for the number of participants in the waiting room.
+ * @property {WaitingRoomParticipant[]} waitingRoomList - List of participants in the waiting room.
+ * @property {string} roomName - Name of the room.
+ * @property {Socket} socket - Socket instance for communication.
+ * @property {string} position - Position of the modal on the screen.
+ * @property {string} backgroundColor - Background color of the modal.
+ * @property {WaitingRoomModalParameters} parameters - Parameters for the waiting room modal.
+ * @property {function} onWaitingRoomClose - Function to call when the modal is closed.
+ * @property {function} onWaitingRoomFilterChange - Function to call when the filter value changes.
+ * @property {function} updateWaitingList - Function to update the waiting list.
+ * @property {function} onWaitingRoomItemPress - Function to call when an item in the waiting room is pressed.
+ *
+ * @property {IconDefinition} faTimes - FontAwesome icon for the close button.
+ * @property {IconDefinition} faCheck - FontAwesome icon for the check button.
+ * @property {WaitingRoomParticipant[]} waitingRoomList_s - Filtered list of participants in the waiting room.
+ * @property {number} waitingRoomCounter_s - Counter for the filtered list of participants in the waiting room.
+ * @property {boolean} reRender - Flag to trigger re-rendering of the component.
+ *
+ * @method ngOnInit - Lifecycle hook that is called after data-bound properties are initialized.
+ * @method ngOnChanges - Lifecycle hook that is called when any data-bound property of a directive changes.
+ * @method updateParameters - Updates the parameters for the waiting room modal.
+ * @method handleModalClose - Handles the closing of the modal.
+ * @method handleFilterChange - Handles the change in the filter input.
+ * @method handleItemPress - Handles the pressing of an item in the waiting room.
+ *
+ * @getter modalContainerStyle - Returns the style object for the modal container.
+ * @getter modalContentStyle - Returns the style object for the modal content.
+ * @getter inputStyle - Returns the style object for the input field.
+ *
+ * @example
+ * ```html
+ * <app-waiting-room-modal
+ *  [isWaitingModalVisible]="true"
+ * [waitingRoomCounter]="waitingRoomCounter"
+ * [waitingRoomList]="waitingRoomList"
+ * [roomName]="roomName"
+ * [socket]="socket"
+ * [position]="'topRight'"
+ * [backgroundColor]="'#83c0e9'"
+ * [parameters]="waitingRoomModalParams"
+ * [onWaitingRoomClose]="closeWaitingRoomModal"
+ * [onWaitingRoomFilterChange]="filterWaitingRoom"
+ * [updateWaitingList]="updateWaitingList"
+ * [onWaitingRoomItemPress]="handleWaitingRoomItemPress"
+ * ></app-waiting-room-modal>
+ * ```
+ *
+ */
 export declare class WaitingRoomModal implements OnChanges, OnInit {
     private respondToWaitingService;
     constructor(respondToWaitingService: RespondToWaiting);

package/dist/lib/components/whiteboard-components/configure-whiteboard-modal/configure-whiteboard-modal.component.d.ts

@@ -43,6 +43,27 @@ export interface ConfigureWhiteboardModalOptions {
     parameters: ConfigureWhiteboardModalParameters;
 }
 export type ConfigureWhiteboardModalType = (options: ConfigureWhiteboardModalOptions) => HTMLElement;
+/**
+ * @component ConfigureWhiteboardModal
+ * @description A modal component to configure and manage whiteboard settings and participants.
+ *
+ * @selector app-configure-whiteboard-modal
+ * @standalone true
+ * @imports [CommonModule, FontAwesomeModule]
+ * @templateUrl ./configure-whiteboard-modal.component.html
+ * @styleUrls ./configure-whiteboard-modal.component.css
+ *
+ * @example
+ * ```html
+ * <app-configure-whiteboard-modal
+ *   [isVisible]="isWhiteboardModalVisible"
+ *   [parameters]="whiteboardParameters"
+ *   [backgroundColor]="'#83c0e9'"
+ *   [position]="'topRight'"
+ *   (onConfigureWhiteboardClose)="handleCloseModal()">
+ * </app-configure-whiteboard-modal>
+ * ```
+ */
 export declare class ConfigureWhiteboardModal implements OnInit, OnChanges {
     isVisible: boolean;
     parameters: ConfigureWhiteboardModalParameters;

package/dist/lib/components/whiteboard-components/whiteboard/whiteboard.component.d.ts

@@ -200,6 +200,55 @@
  * @param {number} y1 - Y coordinate of the polygon start.
  * @param {number} x2 - X coordinate of the polygon end.
  * @param {number} y2 - Y coordinate of the polygon end.
+ *
+ * @example
+ * ```html
+ * <app-whiteboard
+ *  [customWidth]="1280"
+ * [customHeight]="720"
+ * [parameters]="{
+ *  socket: socket,
+ * showAlert: showAlert,
+ * islevel: islevel,
+ * roomName: roomName,
+ * shapes: shapes,
+ * useImageBackground: useImageBackground,
+ * redoStack: redoStack,
+ * undoStack: undoStack,
+ * whiteboardStarted: whiteboardStarted,
+ * whiteboardEnded: whiteboardEnded,
+ * whiteboardUsers: whiteboardUsers,
+ * participants: participants,
+ * participantsAll: participantsAll,
+ * screenId: screenId,
+ * recordStarted: recordStarted,
+ * recordStopped: recordStopped,
+ * recordPaused: recordPaused,
+ * recordResumed: recordResumed,
+ * recordingMediaOptions: recordingMediaOptions,
+ * member: member,
+ * shareScreenStarted: shareScreenStarted,
+ * canvasWhiteboard: canvasWhiteboard,
+ * targetResolution: targetResolution,
+ * targetResolutionHost: targetResolutionHost,
+ * updateShapes: updateShapes,
+ * updateUseImageBackground: updateUseImageBackground,
+ * updateRedoStack: updateRedoStack,
+ * updateUndoStack: updateUndoStack,
+ * updateWhiteboardStarted: updateWhiteboardStarted,
+ * updateWhiteboardEnded: updateWhiteboardEnded,
+ * updateWhiteboardUsers: updateWhiteboardUsers,
+ * updateParticipants: updateParticipants,
+ * updateScreenId: updateScreenId,
+ * updateShareScreenStarted: updateShareScreenStarted,
+ * updateCanvasWhiteboard: updateCanvasWhiteboard,
+ * onScreenChanges: onScreenChanges,
+ * captureCanvasStream: captureCanvasStream,
+ * getUpdatedAllParams: getUpdatedAllParams
+ * }"
+ * [showAspect]="true"
+ * ></app-whiteboard>
+ * ```
  */
 import { ElementRef, OnDestroy, OnInit, OnChanges, SimpleChanges } from '@angular/core';
 import { Socket } from 'socket.io-client';

package/dist/lib/consumers/add-videos-grid.service.d.ts

@@ -28,6 +28,55 @@ export interface AddVideosGridOptions {
     parameters: AddVideosGridParameters;
 }
 export type AddVideosGridType = (options: AddVideosGridOptions) => Promise<void>;
+/**
+ * @service AddVideosGrid
+ * @description Service to manage and update video and audio components on a grid in the user interface. This service helps organize and configure participants and streams into different grid layouts.
+ *
+ * @method addVideosGrid
+ * Adds video and audio cards to the main and alternate grids based on the parameters and configuration options provided.
+ *
+ * @param {AddVideosGridOptions} options - Configuration options for setting up the grid.
+ * @param {(Stream | Participant)[]} options.mainGridStreams - Streams or participants to display on the main grid.
+ * @param {(Stream | Participant)[]} options.altGridStreams - Streams or participants to display on the alternate grid.
+ * @param {number} options.numtoadd - The number of items to add to the grid.
+ * @param {number} options.numRows - The number of rows for the main grid.
+ * @param {number} options.numCols - The number of columns for the main grid.
+ * @param {number} options.actualRows - The actual rows currently displayed.
+ * @param {number} options.lastrowcols - The number of columns in the last row of the grid.
+ * @param {boolean} options.removeAltGrid - Whether to remove the alternate grid layout.
+ * @param {AddVideosGridParameters} options.parameters - Additional parameters for updating the grid, controlling appearance, and handling events.
+ *
+ * @returns {Promise<void>} A promise that resolves once the grid layout is updated.
+ *
+ * @example
+ * ```typescript
+ * await addVideosGridService.addVideosGrid({
+ *   mainGridStreams: [...],
+ *   altGridStreams: [...],
+ *   numtoadd: 4,
+ *   numRows: 2,
+ *   numCols: 2,
+ *   actualRows: 2,
+ *   lastrowcols: 2,
+ *   removeAltGrid: false,
+ *   parameters: {
+ *     eventType: 'webinar',
+ *     updateAddAltGrid: (value) => {},
+ *     ref_participants: participantsList,
+ *     islevel: '1',
+ *     videoAlreadyOn: true,
+ *     localStreamVideo: localStream,
+ *     keepBackground: true,
+ *     virtualStream: virtualStream,
+ *     forceFullDisplay: false,
+ *     otherGridStreams: otherStreamsArray,
+ *     updateOtherGridStreams: (newStreams) => {},
+ *     updateMiniCardsGrid: (params) => {},
+ *     getUpdatedAllParams: () => ({ /* updated parameters * / }),
+ *   },
+ * });
+ * ```
+ */
 export declare class AddVideosGrid {
     addVideosGrid: ({ mainGridStreams, altGridStreams, numtoadd, numRows, numCols, actualRows, lastrowcols, removeAltGrid, parameters, }: AddVideosGridOptions) => Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AddVideosGrid, never>;

package/dist/lib/consumers/auto-adjust.service.d.ts

@@ -7,6 +7,32 @@ export interface AutoAdjustOptions {
     shared: boolean;
 }
 export type AutoAdjustType = (options: AutoAdjustOptions) => Promise<number[]>;
+/**
+ * @service AutoAdjust
+ * @description Service to auto-adjust layout values based on the event type, number of participants, and sharing conditions. Useful for dynamically adjusting UI elements in different event settings.
+ *
+ * @method autoAdjust
+ * Dynamically calculates and adjusts layout values (e.g., grid columns) based on conditions such as event type, participant count, and sharing status.
+ *
+ * @param {AutoAdjustOptions} options - Configuration options for the auto-adjustment.
+ * @param {number} options.n - Number of participants in the event.
+ * @param {EventType} options.eventType - Type of event (e.g., 'broadcast', 'chat', 'conference').
+ * @param {boolean} options.shareScreenStarted - Indicates whether screen sharing is active.
+ * @param {boolean} options.shared - Indicates if another resource is currently shared.
+ *
+ * @returns {Promise<number[]>} A promise resolving to an array of two adjusted layout values.
+ *
+ * @example
+ * ```typescript
+ * const [primaryLayout, secondaryLayout] = await autoAdjustService.autoAdjust({
+ *   n: 5,
+ *   eventType: 'conference',
+ *   shareScreenStarted: false,
+ *   shared: false,
+ * });
+ * console.log(primaryLayout, secondaryLayout); // Adjusted layout values based on inputs
+ * ```
+ */
 export declare class AutoAdjust {
     /**
      * Adjusts values based on the provided options.

package/dist/lib/consumers/calculate-rows-and-columns.service.d.ts

@@ -3,6 +3,24 @@ export interface CalculateRowsAndColumnsOptions {
     n: number;
 }
 export type CalculateRowsAndColumnsType = (options: CalculateRowsAndColumnsOptions) => [number, number];
+/**
+ * @service CalculateRowsAndColumns
+ * @description Service to calculate the optimal number of rows and columns needed to display a given number of items in a grid. Useful for dynamically determining grid layout in responsive designs.
+ *
+ * @method calculateRowsAndColumns
+ * Calculates the optimal number of rows and columns to display a specified number of items in a compact grid format.
+ *
+ * @param {CalculateRowsAndColumnsOptions} options - Configuration options for row and column calculation.
+ * @param {number} options.n - The number of items to display in the grid.
+ *
+ * @returns {[number, number]} A tuple where the first value is the number of rows and the second is the number of columns.
+ *
+ * @example
+ * ```typescript
+ * const [rows, cols] = calculateRowsAndColumnsService.calculateRowsAndColumns({ n: 10 });
+ * console.log(rows, cols); // Outputs optimized rows and columns for displaying 10 items
+ * ```
+ */
 export declare class CalculateRowsAndColumns {
     /**
      * Calculates the number of rows and columns needed to display a given number of items in a grid.

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.