mediasfu-angular 1.0.1 → 1.0.2

package/dist/lib/consumers/prepopulate-user-media.service.d.ts

@@ -51,6 +51,105 @@ export type PrepopulateUserMediaType = (options: {
     component: any;
     inputs: any;
 }[] | void>;
+/**
+ * Prepopulates the user media based on the provided options.
+ *
+ * This method prepares the UI components for the user's media based on the event type and participant information.
+ * It manages the display of video and audio cards, mini cards, and handles screen sharing scenarios.
+ *
+ * @param {PrepopulateUserMediaOptions} options - The options for prepopulating user media.
+ * @param {string} options.name - The name of the user.
+ * @param {PrepopulateUserMediaParameters} options.parameters - The parameters for prepopulating user media.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Array<Participant>} options.parameters.participants - List of participants.
+ * @param {Array<Stream>} options.parameters.allVideoStreams - List of all video streams.
+ * @param {string} options.parameters.islevel - The level of the user.
+ * @param {string} options.parameters.member - The member name.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is shared.
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {string} options.parameters.eventType - The type of event (e.g., "broadcast", "chat", "conference").
+ * @param {string} options.parameters.screenId - The ID of the screen.
+ * @param {boolean} options.parameters.forceFullDisplay - Indicates if full display is forced.
+ * @param {Function} options.parameters.updateMainWindow - Function to update the main window.
+ * @param {boolean} options.parameters.mainScreenFilled - Indicates if the main screen is filled.
+ * @param {boolean} options.parameters.adminOnMainScreen - Indicates if admin is on the main screen.
+ * @param {string} options.parameters.mainScreenPerson - The person on the main screen.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video is already on.
+ * @param {boolean} options.parameters.audioAlreadyOn - Indicates if the audio is already on.
+ * @param {Array<Stream>} options.parameters.oldAllStreams - List of old all streams.
+ * @param {Function} options.parameters.checkOrientation - Function to check orientation.
+ * @param {boolean} options.parameters.screenForceFullDisplay - Indicates if screen force full display is enabled.
+ * @param {Stream} options.parameters.localStreamScreen - The local screen stream.
+ * @param {Array<Stream>} options.parameters.remoteScreenStream - List of remote screen streams.
+ * @param {Stream} options.parameters.localStreamVideo - The local video stream.
+ * @param {number} options.parameters.mainHeightWidth - The main height and width.
+ * @param {boolean} options.parameters.isWideScreen - Indicates if the screen is wide.
+ * @param {boolean} options.parameters.localUIMode - Indicates if local UI mode is enabled.
+ * @param {boolean} options.parameters.whiteboardStarted - Indicates if whiteboard has started.
+ * @param {boolean} options.parameters.whiteboardEnded - Indicates if whiteboard has ended.
+ * @param {Stream} options.parameters.virtualStream - The virtual stream.
+ * @param {boolean} options.parameters.keepBackground - Indicates if background should be kept.
+ * @param {Stream} options.parameters.annotateScreenStream - The annotate screen stream.
+ * @param {Function} options.parameters.updateMainScreenPerson - Function to update the main screen person.
+ * @param {Function} options.parameters.updateMainScreenFilled - Function to update if the main screen is filled.
+ * @param {Function} options.parameters.updateAdminOnMainScreen - Function to update if admin is on the main screen.
+ * @param {Function} options.parameters.updateMainHeightWidth - Function to update the main height and width.
+ * @param {Function} options.parameters.updateScreenForceFullDisplay - Function to update screen force full display.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window update status.
+ * @param {Function} options.parameters.updateMainGridStream - Function to update the main grid stream.
+ *
+ * @returns {Promise<{ component: any; inputs: any }[] | void>} A promise that resolves with the components and inputs or void.
+ *
+ * @throws {Error} Throws an error if there is an issue preparing and populating the main screen.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   name: 'John Doe',
+ *   parameters: {
+ *     getUpdatedAllParams: () => { },
+ *     participants: [],
+ *     allVideoStreams: [],
+ *     islevel: '1',
+ *     member: 'John',
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     eventType: 'conference',
+ *     screenId: 'screen123',
+ *     forceFullDisplay: false,
+ *     updateMainWindow: false,
+ *     mainScreenFilled: false,
+ *     adminOnMainScreen: false,
+ *     mainScreenPerson: '',
+ *     videoAlreadyOn: false,
+ *     audioAlreadyOn: false,
+ *     oldAllStreams: [],
+ *     checkOrientation: () => 'landscape',
+ *     screenForceFullDisplay: false,
+ *     localStreamScreen: null,
+ *     remoteScreenStream: [],
+ *     localStreamVideo: null,
+ *     mainHeightWidth: 100,
+ *     isWideScreen: true,
+ *     localUIMode: false,
+ *     whiteboardStarted: false,
+ *     whiteboardEnded: false,
+ *     virtualStream: null,
+ *     keepBackground: false,
+ *     annotateScreenStream: false,
+ *     updateMainScreenPerson: (person) => { console.log(updated) },
+ *     updateMainScreenFilled: (filled) => { console.log(updated) },
+ *     updateAdminOnMainScreen: (admin) => { console.log(updated) },
+ *     updateMainHeightWidth: (heightWidth) => { console.log(updated) },
+ *     updateScreenForceFullDisplay: (force) => { console.log(updated) },
+ *     updateUpdateMainWindow: (update) => { console.log(updated) },
+ *     updateMainGridStream: (components) => { console.log(updated) },
+ *   },
+ * };
+ *
+ * await prepopulateUserMedia(options);
+ * ```
+ */
 export declare class PrepopulateUserMedia {
     /**
      * Prepopulates the user media based on the provided options.

package/dist/lib/consumers/process-consumer-transports-audio.service.d.ts

@@ -10,6 +10,35 @@ export interface ProcessConsumerTransportsAudioOptions {
     parameters: ProcessConsumerTransportsAudioParameters;
 }
 export type ProcessConsumerTransportsAudioType = (options: ProcessConsumerTransportsAudioOptions) => Promise<void>;
+/**
+ * Processes consumer transports for audio streams by pausing and resuming them based on their current state and the provided streams.
+ *
+ * This method checks the state of each audio consumer transport and either pauses or resumes it depending on the presence of its producer ID in the provided list of streams.
+ * It uses a sleep function to introduce a delay between the pause and resume operations to ensure smooth transitions.
+ *
+ * @param {ProcessConsumerTransportsAudioOptions} options - The options for processing consumer transports.
+ * @param {Array<Transport>} options.consumerTransports - The list of consumer transports to process.
+ * @param {Array<(Stream | Participant)>} options.lStreams - The list of local streams to check against.
+ * @param {ProcessConsumerTransportsAudioParameters} options.parameters - Additional parameters for processing.
+ * @param {Function} options.parameters.sleep - A function to pause execution for a specified duration.
+ *
+ * @returns {Promise<void>} A promise that resolves when the processing is complete.
+ *
+ * @throws {Error} Will throw an error if there is an issue processing the consumer transports.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   consumerTransports: [,
+ *   lStreams: [],
+ *   parameters: {
+ *     sleep: async ({ ms }) => new Promise(resolve => setTimeout(resolve, ms)),
+ *   },
+ * };
+ *
+ * await processConsumerTransportsAudio(options);
+ * ```
+ */
 export declare class ProcessConsumerTransportsAudio {
     /**
      * Processes consumer transports for audio streams by pausing and resuming them based on their current state and the provided streams.

package/dist/lib/consumers/process-consumer-transports.service.d.ts

@@ -14,6 +14,43 @@ export interface ProcessConsumerTransportsOptions {
     parameters: ProcessConsumerTransportsParameters;
 }
 export type ProcessConsumerTransportsType = (options: ProcessConsumerTransportsOptions) => Promise<void>;
+/**
+ * Processes consumer transports by pausing and resuming them based on certain conditions.
+ *
+ * This method checks the state of each consumer transport and determines whether to pause or resume
+ * based on the validity of the producer ID in relation to the provided streams.
+ * It utilizes a sleep function to introduce a delay before pausing the transports.
+ *
+ * @param {ProcessConsumerTransportsOptions} options - The options for processing consumer transports.
+ * @param {Array<Transport>} options.consumerTransports - The list of consumer transports to process.
+ * @param {Array<Stream | Participant>} options.lStreams_ - The list of local streams.
+ * @param {ProcessConsumerTransportsParameters} options.parameters - The parameters for processing, including:
+ *   - {Array<Stream>} options.parameters.remoteScreenStream - The list of remote screen streams.
+ *   - {Array<Stream | Participant>} options.parameters.oldAllStreams - The list of old streams.
+ *   - {Array<Stream | Participant>} options.parameters.newLimitedStreams - The list of new limited streams.
+ *   - {Function} options.parameters.sleep - A function to pause execution for a specified duration.
+ *   - {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ *
+ * @returns {Promise<void>} A promise that resolves when the processing is complete.
+ *
+ * @throws {Error} Will throw an error if there is an issue processing consumer transports.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   consumerTransports: [],
+ *   lStreams_: [],
+ *   parameters: {
+ *     remoteScreenStream: [],
+ *     oldAllStreams: [],
+ *     newLimitedStreams: [],
+ *     sleep: async ({ ms }) => new Promise(resolve => setTimeout(resolve, ms)),
+ *   },
+ * };
+ *
+ * await processConsumerTransports(options);
+ * ```
+ */
 export declare class ProcessConsumerTransports {
     /**
      * Processes consumer transports by pausing and resuming them based on certain conditions.

package/dist/lib/consumers/re-port.service.d.ts

@@ -23,6 +23,54 @@ export interface RePortOptions {
     parameters: RePortParameters;
 }
 export type RePortType = (options: RePortOptions) => Promise<void>;
+/**
+ * RePort function that handles the reporting logic based on the provided parameters.
+ *
+ * This method checks the current state of the recording process and updates the screen states
+ * accordingly. It also compares active names and screen states based on the provided parameters.
+ *
+ * @param {RePortOptions} options - The options for the rePort function.
+ * @param {boolean} [options.restart=false] - Flag indicating whether to restart the process.
+ * @param {RePortParameters} options.parameters - The parameters object containing various states and functions.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {string} options.parameters.islevel - The current level of the process.
+ * @param {string} options.parameters.mainScreenPerson - The person on the main screen.
+ * @param {boolean} options.parameters.adminOnMainScreen - Flag indicating if admin is on the main screen.
+ * @param {boolean} options.parameters.mainScreenFilled - Flag indicating if the main screen is filled.
+ * @param {boolean} options.parameters.recordStarted - Flag indicating if recording has started.
+ * @param {boolean} options.parameters.recordStopped - Flag indicating if recording has stopped.
+ * @param {boolean} options.parameters.recordPaused - Flag indicating if recording is paused.
+ * @param {boolean} options.parameters.recordResumed - Flag indicating if recording has resumed.
+ * @param {Array<ScreenState>} options.parameters.screenStates - Array of current screen states.
+ * @param {Function} options.parameters.updateScreenStates - Function to update the current screen states.
+ * @param {Function} options.parameters.updatePrevScreenStates - Function to update the previous screen states.
+ * @param {Function} options.parameters.compareActiveNames - Function to compare active names.
+ * @param {Function} options.parameters.compareScreenStates - Function to compare screen states.
+ *
+ * @returns {Promise<void>} A promise that resolves when the reporting process is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue during the reporting process.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   restart: false,
+ *   parameters: {
+ *     islevel: '1',
+ *     mainScreenPerson: 'John Doe',
+ *     adminOnMainScreen: false,
+ *     mainScreenFilled: true,
+ *     recordStarted: true,
+ *     screenStates: [],
+ *     updateScreenStates: (states) => { console.log(updated) },
+ *     compareActiveNames: async (opts) => {  },
+ *     compareScreenStates: async (opts) => {  },
+ *   },
+ * };
+ *
+ * await rePort(options);
+ * ```
+ */
 export declare class RePort {
     /**
      * RePort function that handles the reporting logic based on the provided parameters.

package/dist/lib/consumers/re-update-inter.service.d.ts

@@ -38,6 +38,88 @@ export interface ReUpdateInterOptions {
     parameters: ReUpdateInterParameters;
 }
 export type ReUpdateInterType = (options: ReUpdateInterOptions) => Promise<void>;
+/**
+ * Updates the interaction state based on the provided options and parameters.
+ *
+ * This method handles the updating of participant interactions based on the event type, screen sharing status,
+ * and various other parameters. It manages the addition and removal of streams in the context of screen sharing
+ * and video/audio management.
+ *
+ * @param {ReUpdateInterOptions} options - The options for updating the interaction.
+ * @param {string} options.name - The name of the participant.
+ * @param {boolean} [options.add=false] - Whether to add the participant to the interaction.
+ * @param {boolean} [options.force=false] - Whether to force the update.
+ * @param {number} [options.average=127] - The average value used for determining reorder intervals.
+ * @param {ReUpdateInterParameters} options.parameters - The parameters for updating the interaction.
+ * @param {number} options.parameters.screenPageLimit - The screen page limit.
+ * @param {number} options.parameters.itemPageLimit - The item page limit.
+ * @param {number} options.parameters.reorderInterval - The reorder interval.
+ * @param {number} options.parameters.fastReorderInterval - The fast reorder interval.
+ * @param {string} options.parameters.eventType - The type of event (e.g., "broadcast", "chat", "conference").
+ * @param {Array<Participant>} options.parameters.participants - The list of participants.
+ * @param {Array<Stream | Participant>} options.parameters.allVideoStreams - The list of all video streams.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is shared.
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {string} options.parameters.adminNameStream - The admin name stream.
+ * @param {string} options.parameters.screenShareNameStream - The screen share name stream.
+ * @param {boolean} options.parameters.updateMainWindow - Whether to update the main window.
+ * @param {boolean} options.parameters.sortAudioLoudness - Whether to sort audio by loudness.
+ * @param {number} options.parameters.lastReorderTime - The last reorder time.
+ * @param {Array<Stream | Participant>} options.parameters.newLimitedStreams - The list of new limited streams.
+ * @param {Array<string>} options.parameters.newLimitedStreamsIDs - The list of new limited stream IDs.
+ * @param {Array<string>} options.parameters.oldSoundIds - The list of old sound IDs.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window.
+ * @param {Function} options.parameters.updateSortAudioLoudness - Function to update the audio loudness sorting.
+ * @param {Function} options.parameters.updateLastReorderTime - Function to update the last reorder time.
+ * @param {Function} options.parameters.updateNewLimitedStreams - Function to update the new limited streams.
+ * @param {Function} options.parameters.updateNewLimitedStreamsIDs - Function to update the new limited stream IDs.
+ * @param {Function} options.parameters.updateOldSoundIds - Function to update the old sound IDs.
+ * @param {Function} options.parameters.onScreenChanges - Function to handle screen changes.
+ * @param {Function} options.parameters.reorderStreams - Function to reorder streams.
+ * @param {Function} options.parameters.changeVids - Function to change videos.
+ *
+ * @returns {Promise<void>} A promise that resolves when the interaction update is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue during the interaction update.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   name: 'John Doe',
+ *   add: true,
+ *   parameters: {
+ *     screenPageLimit: 5,
+ *     itemPageLimit: 10,
+ *     reorderInterval: 1000,
+ *     fastReorderInterval: 500,
+ *     eventType: 'conference',
+ *     participants: [...],
+ *     allVideoStreams: [...],
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     adminNameStream: 'Admin',
+ *     screenShareNameStream: 'ScreenShare',
+ *     updateMainWindow: true,
+ *     sortAudioLoudness: false,
+ *     lastReorderTime: Date.now(),
+ *     newLimitedStreams: [],
+ *     newLimitedStreamsIDs: [],
+ *     oldSoundIds: [],
+ *     updateUpdateMainWindow: (value) => { console.log(updated) },
+ *     updateSortAudioLoudness: (value) => { console.log(updated) },
+ *     updateLastReorderTime: (value) => { console.log(updated) },
+ *     updateNewLimitedStreams: (streams) => { console.log(updated) },
+ *     updateNewLimitedStreamsIDs: (ids) => { console.log(updated) },
+ *     updateOldSoundIds: (ids) => { console.log(updated) },
+ *     onScreenChanges: async (opts) => {  },
+ *     reorderStreams: async (opts) => {  },
+ *     changeVids: async (opts) => {  },
+ *   },
+ * };
+ *
+ * await reUpdateInter(options);
+ * ```
+ */
 export declare class ReUpdateInter {
     /**
      * Updates the interaction state based on the provided options and parameters.

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

@@ -20,6 +20,56 @@ export interface ReadjustOptions {
     parameters: ReadjustParameters;
 }
 export type ReadjustType = (options: ReadjustOptions) => Promise<void>;
+/**
+ * Adjusts the layout parameters based on the provided options.
+ *
+ * This method calculates the layout dimensions and updates the main window size based on the current event type,
+ * the number of participants, and whether screen sharing is active. It also manages the state transitions
+ * to ensure that the UI reflects the correct configuration based on user interactions.
+ *
+ * @param {ReadjustOptions} options - The options for readjusting the layout.
+ * @param {number} options.n - The number of participants or elements.
+ * @param {number} options.state - The current state of the layout.
+ * @param {Object} options.parameters - The parameters for the layout adjustment.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {string} options.parameters.eventType - The type of event (e.g., "broadcast", "chat", "conference").
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {boolean} options.parameters.shared - Indicates if content is being shared.
+ * @param {number} options.parameters.mainHeightWidth - The main height and width value.
+ * @param {number} options.parameters.prevMainHeightWidth - The previous main height and width value.
+ * @param {string} options.parameters.hostLabel - The label for the host.
+ * @param {boolean} options.parameters.first_round - Indicates if it is the first round.
+ * @param {boolean} options.parameters.lock_screen - Indicates if the screen is locked.
+ * @param {Function} options.parameters.updateMainHeightWidth - Function to update the main height and width.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ *
+ * @returns {Promise<void>} A promise that resolves when the layout adjustment is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue updating the grid sizes.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   n: 5,
+ *   state: 0,
+ *   parameters: {
+ *     getUpdatedAllParams: () => updatedParams,
+ *     eventType: 'conference',
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     mainHeightWidth: 100,
+ *     prevMainHeightWidth: 100,
+ *     hostLabel: 'Host Name',
+ *     first_round: false,
+ *     lock_screen: false,
+ *     updateMainHeightWidth: (value) => { console.log(updated) },
+ *     prepopulateUserMedia: async ({ name, parameters }) => {  },
+ *   },
+ * };
+ *
+ * await readjust(options);
+ * ```
+ */
 export declare class Readjust {
     /**
      * Adjusts the layout parameters based on the provided options.

package/dist/lib/consumers/receive-all-piped-transports.service.d.ts

@@ -12,6 +12,37 @@ export interface ReceiveAllPipedTransportsOptions {
     parameters: ReceiveAllPipedTransportsParameters;
 }
 export type ReceiveAllPipedTransportsType = (options: ReceiveAllPipedTransportsOptions) => Promise<void>;
+/**
+ * Receives all piped transports by emitting an event to the server and processing the response.
+ *
+ * This method communicates with the server to request piped transports for a specific room and member.
+ * It checks if any producers exist and, if so, iterates through different levels to retrieve piped producers.
+ *
+ * @param {ReceiveAllPipedTransportsOptions} options - The options for receiving all piped transports.
+ * @param {Socket} options.nsock - The socket instance used for communication.
+ * @param {ReceiveAllPipedTransportsParameters} options.parameters - The parameters for the operation.
+ * @param {string} options.parameters.roomName - The name of the room.
+ * @param {string} options.parameters.member - The member identifier.
+ * @param {GetPipedProducersAltType} options.parameters.getPipedProducersAlt - The function to get piped producers for a given level.
+ *
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ *
+ * @throws Will log an error message if the operation fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   nsock: socketInstance,
+ *   parameters: {
+ *     roomName: 'Room1',
+ *     member: 'Member1',
+ *     getPipedProducersAlt: getPipedProducersAltFunction,
+ *   },
+ * };
+ *
+ * await receiveAllPipedTransports(options);
+ * ```
+ */
 export declare class ReceiveAllPipedTransports {
     /**
      * Receives all piped transports by emitting an event to the server and processing the response.

package/dist/lib/consumers/receive-room-messages.service.d.ts

@@ -7,6 +7,33 @@ export interface ReceiveRoomMessagesOptions {
     updateMessages: (messages: Message[]) => void;
 }
 export type ReceiveRoomMessagesType = (options: ReceiveRoomMessagesOptions) => Promise<void>;
+/**
+ * Asynchronously retrieves and updates messages for a specified room from the server.
+ *
+ * This method communicates with the server to request messages for a specific room and updates the messages array accordingly.
+ *
+ * @param {ReceiveRoomMessagesOptions} options - The function parameters.
+ * @param {Socket} options.socket - The socket instance used for communication.
+ * @param {string} options.roomName - The name of the room to retrieve messages for.
+ * @param {function} options.updateMessages - Function to update the messages array with the retrieved messages.
+ *
+ * @returns {Promise<void>} A promise that resolves when the messages have been successfully retrieved and updated.
+ *
+ * @throws Will log an error message if an error occurs during the process of retrieving messages.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   socket: socketInstance,
+ *   roomName: 'Room1',
+ *   updateMessages: (messages) => {
+ *     // Logic to update messages
+ *   },
+ * };
+ *
+ * await receiveRoomMessages(options);
+ * ```
+ */
 export declare class ReceiveRoomMessages {
     /**
      * Asynchronously retrieves and updates messages for a specified room from the server.

package/dist/lib/consumers/reorder-streams.service.d.ts

@@ -31,6 +31,64 @@ export interface ReorderStreamsOptions {
     parameters: ReorderStreamsParameters;
 }
 export type ReorderStreamsType = (options: ReorderStreamsOptions) => Promise<void>;
+/**
+ * Reorders the video streams based on the provided options and updates the UI accordingly.
+ *
+ * This method handles the logic for reordering streams in a video conferencing application,
+ * managing the addition and arrangement of streams based on various conditions such as
+ * participant roles, screen sharing status, and current streams.
+ *
+ * @param {ReorderStreamsOptions} options - The options for reordering streams.
+ * @param {boolean} [options.add=false] - Whether to add new streams or not.
+ * @param {boolean} [options.screenChanged=false] - Whether the screen has changed or not.
+ * @param {ReorderStreamsParameters} options.parameters - The parameters required for reordering streams.
+ * @param {Array<Stream | Participant>} options.parameters.allVideoStreams - Array of all video streams.
+ * @param {Array<Participant>} options.parameters.participants - Array of participants.
+ * @param {Array<Stream | Participant>} options.parameters.oldAllStreams - Array of old streams.
+ * @param {string} [options.parameters.screenId] - ID of the screen.
+ * @param {string} [options.parameters.adminVidID] - ID of the admin video.
+ * @param {Array<Stream | Participant>} options.parameters.newLimitedStreams - Array of new limited streams.
+ * @param {Array<string>} options.parameters.newLimitedStreamsIDs - Array of new limited stream IDs.
+ * @param {Array<string>} options.parameters.activeSounds - Array of active sounds.
+ * @param {string} [options.parameters.screenShareIDStream] - ID of the screen share stream.
+ * @param {string} [options.parameters.screenShareNameStream] - Name of the screen share stream.
+ * @param {string} [options.parameters.adminIDStream] - ID of the admin stream.
+ * @param {string} [options.parameters.adminNameStream] - Name of the admin stream.
+ * @param {Function} options.parameters.updateNewLimitedStreams - Function to update new limited streams.
+ * @param {Function} options.parameters.updateNewLimitedStreamsIDs - Function to update new limited stream IDs.
+ * @param {Function} options.parameters.updateActiveSounds - Function to update active sounds.
+ * @param {Function} options.parameters.updateScreenShareIDStream - Function to update screen share ID stream.
+ * @param {Function} options.parameters.updateScreenShareNameStream - Function to update screen share name stream.
+ * @param {Function} options.parameters.updateAdminIDStream - Function to update admin ID stream.
+ * @param {Function} options.parameters.updateAdminNameStream - Function to update admin name stream.
+ * @param {Function} options.parameters.updateYouYouStream - Function to update YouYou stream.
+ * @param {Function} options.parameters.changeVids - Function to reflect changes on the UI.
+ *
+ * @returns {Promise<void>} A promise that resolves when the reordering is complete.
+ *
+ * @throws Will throw an error if there is an issue during the reordering process.
+ *
+ * @example
+ * ```typescript
+ * await reorderStreams({
+ *   add: true,
+ *   screenChanged: false,
+ *   parameters: {
+ *     allVideoStreams: [...],
+ *     participants: [...],
+ *     oldAllStreams: [...],
+ *     newLimitedStreams: [],
+ *     newLimitedStreamsIDs: [],
+ *     activeSounds: [],
+ *     updateNewLimitedStreams: (streams) => { console.log(updated) },
+ *     updateNewLimitedStreamsIDs: (ids) => { console.log(updated) },
+ *     updateActiveSounds: (sounds) => { console.log(updated) },
+ *     changeVids: async (options) => { },
+ *     // ...other parameters
+ *   },
+ * });
+ * ```
+ */
 export declare class ReorderStreams {
     /**
      * Reorders the video streams based on the provided options and updates the UI accordingly.

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

@@ -15,6 +15,40 @@ export interface RequestScreenShareOptions {
     parameters: RequestScreenShareParameters;
 }
 export type RequestScreenShareType = (options: RequestScreenShareOptions) => Promise<void>;
+/**
+ * Requests to start screen sharing.
+ *
+ * This method initiates a screen sharing request and handles the response
+ * from the server to determine if screen sharing is allowed. It also configures
+ * the target resolution for the screen share based on the user's input and
+ * parameters.
+ *
+ * @param {RequestScreenShareOptions} options - The options for requesting screen share.
+ * @param {Object} options.parameters - The parameters for the screen share request.
+ * @param {Socket} options.parameters.socket - The socket instance to communicate with the server.
+ * @param {Function} [options.parameters.showAlert] - Optional function to show alerts to the user.
+ * @param {boolean} options.parameters.localUIMode - Indicates if the user is in local UI mode.
+ * @param {string} [options.parameters.targetResolution] - The target resolution for screen sharing.
+ * @param {string} [options.parameters.targetResolutionHost] - The target resolution for the host screen.
+ * @param {Function} options.parameters.startShareScreen - Function to start screen sharing.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen share request is processed.
+ *
+ * @throws {Error} Throws an error if there is an issue during the screen share request process.
+ *
+ * @example
+ * ```typescript
+ * await requestScreenShare({
+ *   parameters: {
+ *     socket: mySocket,
+ *     localUIMode: false,
+ *     targetResolution: 'fhd',
+ *     startShareScreen: myStartShareScreenFunction,
+ *     showAlert: myShowAlertFunction,
+ *   },
+ * });
+ * ```
+ */
 export declare class RequestScreenShare {
     /**
      * Requests to start screen sharing.

package/dist/lib/consumers/resume-pause-audio-streams.service.d.ts

@@ -22,6 +22,57 @@ export interface ResumePauseAudioStreamsOptions {
     parameters: ResumePauseAudioStreamsParameters;
 }
 export type ResumePauseAudioStreamsType = (options: ResumePauseAudioStreamsOptions) => Promise<void>;
+/**
+ * Resumes or pauses audio streams based on the provided options.
+ *
+ * This method checks the current state of participants in breakout rooms and
+ * updates the audio streams accordingly. It can add or remove audio streams
+ * based on the participant's current status (in a breakout room or not)
+ * and the event type (e.g., conference, webinar).
+ *
+ * @param {ResumePauseAudioStreamsOptions} options - The options for resuming or pausing audio streams.
+ * @param {number} [options.breakRoom=-1] - The ID of the break room. Defaults to -1 if not specified.
+ * @param {boolean} [options.inBreakRoom=false] - Indicates if the participant is in a break room. Defaults to false.
+ * @param {ResumePauseAudioStreamsParameters} options.parameters - The parameters required for processing audio streams.
+ * @param {Array<BreakoutParticipant[]>} options.parameters.breakoutRooms - Array of breakout rooms.
+ * @param {Array<Participant>} options.parameters.ref_participants - Array of reference participants.
+ * @param {Array<Stream | Participant>} options.parameters.allAudioStreams - Array of all audio streams.
+ * @param {Array<Participant>} options.parameters.participants - Array of participants.
+ * @param {string} options.parameters.islevel - The level of the participant.
+ * @param {EventType} options.parameters.eventType - The type of event (e.g., conference, webinar).
+ * @param {Array<Transport>} options.parameters.consumerTransports - Array of consumer transports.
+ * @param {Array<BreakoutParticipant>} options.parameters.limitedBreakRoom - Array of participants in the limited break room.
+ * @param {number} options.parameters.hostNewRoom - The ID of the host's new room.
+ * @param {string} options.parameters.member - The name of the member.
+ * @param {Function} options.parameters.updateLimitedBreakRoom - Function to update the limited break room.
+ * @param {Function} options.parameters.processConsumerTransportsAudio - Function to process audio transports.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio streams have been processed.
+ *
+ * @throws Will log an error message if there is an issue processing the audio streams.
+ *
+ * @example
+ * ```typescript
+ * await resumePauseAudioStreams({
+ *   breakRoom: 1,
+ *   inBreakRoom: true,
+ *   parameters: {
+ *     breakoutRooms: [],
+ *     ref_participants: [],
+ *     allAudioStreams: [],
+ *     participants: [],
+ *     islevel: '1',
+ *     eventType: 'conference',
+ *     consumerTransports: [],
+ *     limitedBreakRoom: [],
+ *     hostNewRoom: 2,
+ *     member: 'JohnDoe',
+ *     updateLimitedBreakRoom: myUpdateFunction,
+ *     processConsumerTransportsAudio: myProcessFunction,
+ *   },
+ * });
+ * ```
+ */
 export declare class ResumePauseAudioStreams {
     /**
      * Resumes or pauses audio streams based on the provided options.