mediasfu-angular 1.0.0 → 1.0.2

package/dist/lib/consumers/get-estimate.service.d.ts

@@ -18,6 +18,56 @@ export interface GetEstimateOptions {
     parameters: GetEstimateParameters;
 }
 export type GetEstimateType = (options: GetEstimateOptions) => [number, number, number];
+/**
+ * Estimates the number of rows and columns for a given set of parameters.
+ *
+ * @param {GetEstimateOptions} options - The options for the estimation.
+ * @param {number} options.n - The number of items to estimate for.
+ * @param {GetEstimateParameters} options.parameters - The parameters for the estimation.
+ * @param {number} options.parameters.fixedPageLimit - The fixed page limit.
+ * @param {number} options.parameters.screenPageLimit - The screen page limit.
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {boolean} [options.parameters.shared=false] - Indicates if sharing is active.
+ * @param {EventType} options.parameters.eventType - The type of event (e.g., "chat", "conference").
+ * @param {boolean} options.parameters.removeAltGrid - Indicates if the alternate grid should be removed.
+ * @param {boolean} options.parameters.isWideScreen - Indicates if the screen is wide.
+ * @param {boolean} options.parameters.isMediumScreen - Indicates if the screen is medium-sized.
+ * @param {Function} options.parameters.updateRemoveAltGrid - Function to update the removeAltGrid parameter.
+ * @param {CalculateRowsAndColumnsType} options.parameters.calculateRowsAndColumns - Function to calculate rows and columns.
+ *
+ * @returns {[number, number, number]} An array containing:
+ * - Estimated number of items,
+ * - Estimated number of rows,
+ * - Estimated number of columns.
+ *
+ * @throws Will log an error message if an error occurs during estimation.
+ *
+ * @example
+ * ```typescript
+ * const estimateOptions = {
+ *   n: 20,
+ *   parameters: {
+ *     fixedPageLimit: 10,
+ *     screenPageLimit: 15,
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     eventType: 'conference',
+ *     removeAltGrid: false,
+ *     isWideScreen: true,
+ *     isMediumScreen: false,
+ *     updateRemoveAltGrid: (value) => console.log(`Remove Alt Grid: ${value}`),
+ *     calculateRowsAndColumns: ({ n }) => {
+ *       const sqrt = Math.sqrt(n);
+ *       return [Math.ceil(sqrt), Math.floor(sqrt)];
+ *     },
+ *   },
+ * };
+ *
+ * const estimateService = new GetEstimate();
+ * const [estimatedItems, estimatedRows, estimatedCols] = estimateService.getEstimate(estimateOptions);
+ * console.log(`Estimated Items: ${estimatedItems}, Rows: ${estimatedRows}, Columns: ${estimatedCols}`);
+ * ```
+ */
 export declare class GetEstimate {
     /**
      * Estimates the number of rows and columns for a given set of parameters.

package/dist/lib/consumers/get-piped-producers-alt.service.d.ts

@@ -12,6 +12,39 @@ export interface GetPipedProducersAltOptions {
     parameters: GetPipedProducersAltParameters;
 }
 export type GetPipedProducersAltType = (options: GetPipedProducersAltOptions) => Promise<void>;
+/**
+ * Retrieves piped producers and signals new consumer transport for each retrieved producer.
+ *
+ * @param {GetPipedProducersAltOptions} options - The options for retrieving piped producers.
+ * @param {Socket} options.nsock - The WebSocket instance used for communication.
+ * @param {string} options.islevel - A flag indicating the level of the request.
+ * @param {GetPipedProducersAltParameters} options.parameters - Additional parameters for the request.
+ * @param {string} options.parameters.member - The member identifier.
+ * @param {SignalNewConsumerTransportType} options.parameters.signalNewConsumerTransport - A function to signal new consumer transport.
+ *
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ *
+ * @throws {Error} If an error occurs during the process of retrieving producers.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   nsock: socketInstance,
+ *   islevel: '2',
+ *   parameters: {
+ *     member: 'user123',
+ *     signalNewConsumerTransport: async ({ nsock, remoteProducerId, islevel, parameters }) => {
+ *       // Implementation to signal new consumer transport
+ *       console.log(`Signaling new consumer transport for producer: ${remoteProducerId}`);
+ *     },
+ *   },
+ * };
+ *
+ * const getPipedProducersService = new GetPipedProducersAlt();
+ * await getPipedProducersService.getPipedProducersAlt(options);
+ * console.log('Piped producers retrieved successfully.');
+ * ```
+ */
 export declare class GetPipedProducersAlt {
     /**
      * Retrieves piped producers and signals new consumer transport for each retrieved producer.

package/dist/lib/consumers/get-producers-piped.service.d.ts

@@ -12,6 +12,39 @@ export interface GetProducersPipedOptions {
     parameters: GetProducersPipedParameters;
 }
 export type GetProducersPipedType = (options: GetProducersPipedOptions) => Promise<void>;
+/**
+ * Retrieves piped producers and signals new consumer transport for each retrieved producer.
+ *
+ * @param {GetProducersPipedOptions} options - The options for getting piped producers.
+ * @param {Socket} options.nsock - The WebSocket instance used for communication.
+ * @param {string} options.islevel - A flag indicating the level of the operation.
+ * @param {GetProducersPipedParameters} options.parameters - Additional parameters for the operation.
+ * @param {string} options.parameters.member - The member identifier.
+ * @param {SignalNewConsumerTransportType} options.parameters.signalNewConsumerTransport - The function to signal new consumer transport.
+ *
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ *
+ * @throws {Error} If an error occurs during the process of retrieving producers.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   nsock: socketInstance,
+ *   islevel: '2',
+ *   parameters: {
+ *     member: 'user123',
+ *     signalNewConsumerTransport: async ({ remoteProducerId, islevel, nsock, parameters }) => {
+ *       // Implementation to signal new consumer transport
+ *       console.log(`Signaling new consumer transport for producer: ${remoteProducerId}`);
+ *     },
+ *   },
+ * };
+ *
+ * const getProducersPipedService = new GetProducersPiped();
+ * await getProducersPipedService.getProducersPiped(options);
+ * console.log('Piped producers retrieved successfully.');
+ * ```
+ */
 export declare class GetProducersPiped {
     /**
      * Retrieves piped producers and signals new consumer transport for each retrieved producer.

package/dist/lib/consumers/get-videos.service.d.ts

@@ -9,6 +9,39 @@ export interface GetVideosOptions {
     updateOldAllStreams: (streams: (Stream | Participant)[]) => void;
 }
 export type GetVideosType = (options: GetVideosOptions) => Promise<void>;
+/**
+ * Asynchronously processes and updates video streams by filtering out the admin's video stream.
+ *
+ * @param {GetVideosOptions} options - The options for getting videos.
+ * @param {Participant[]} options.participants - The list of participants.
+ * @param {Stream[]} options.allVideoStreams - The list of all video streams.
+ * @param {(Stream | Participant)[]} options.oldAllStreams - The list of old video streams.
+ * @param {string} [options.adminVidID] - The ID of the admin's video stream.
+ * @param {Function} options.updateAllVideoStreams - Function to update the state variable for all video streams.
+ * @param {Function} options.updateOldAllStreams - Function to update the state variable for old video streams.
+ * @returns {Promise<void>} A promise that resolves when the video streams have been processed and updated.
+ *
+ * @throws {Error} If an error occurs during the process of updating video streams.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   participants: participantList,
+ *   allVideoStreams: currentVideoStreams,
+ *   oldAllStreams: previousVideoStreams,
+ *   updateAllVideoStreams: (streams) => {
+ *     console.log('Updated all video streams:', streams);
+ *   },
+ *   updateOldAllStreams: (streams) => {
+ *     console.log('Updated old video streams:', streams);
+ *   },
+ * };
+ *
+ * const getVideosService = new GetVideos();
+ * await getVideosService.getVideos(options);
+ * console.log('Video streams processed successfully.');
+ * ```
+ */
 export declare class GetVideos {
     /**
      * Asynchronously processes and updates video streams by filtering out the admin's video stream.

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

@@ -6,6 +6,28 @@ export interface MixStreamsOptions {
     ref_participants: (Stream | Participant)[];
 }
 export type MixStreamsType = (options: MixStreamsOptions) => Promise<(Stream | Participant)[]>;
+/**
+ * Mixes video and audio streams and participants based on specified parameters.
+ *
+ * @param {MixStreamsOptions} options - The options for mixing streams.
+ * @param {Array<Stream | Participant>} options.alVideoStreams - The list of audio and video streams to mix.
+ * @param {Array<Participant>} options.non_alVideoStreams - The list of non-audio and video streams to mix.
+ * @param {Array<Stream | Participant>} options.ref_participants - The list of reference participants to mix.
+ * @returns {Promise<Array<Stream | Participant>>} A promise that resolves with the mixed streams.
+ *
+ * @throws Will throw an error if there is an issue mixing the streams.
+ *
+ * @example
+ * ```typescript
+ * const mixedStreams = await mixStreams({
+ *   alVideoStreams: [stream1, stream2],
+ *   non_alVideoStreams: [participant1, participant2],
+ *   ref_participants: [participant1, participant2],
+ * });
+ *
+ * console.log('Mixed streams:', mixedStreams);
+ * ```
+ */
 export declare class MixStreams {
     /**
      * Mixes video and audio streams and participants based on specified parameters.

package/dist/lib/consumers/on-screen-changes.service.d.ts

@@ -17,6 +17,46 @@ export interface OnScreenChangesOptions {
     parameters: OnScreenChangesParameters;
 }
 export type OnScreenChangesType = (options: OnScreenChangesOptions) => Promise<void>;
+/**
+ * Handles changes in screen events such as broadcast, chat, and conference.
+ *
+ * @param {OnScreenChangesOptions} options - The options for handling screen changes.
+ * @param {boolean} [options.changed=false] - Indicates if the screen has changed.
+ * @param {OnScreenChangesParameters} options.parameters - The parameters for handling screen changes.
+ * @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 the screen is shared.
+ * @param {boolean} options.parameters.addForBasic - Flag to add basic controls.
+ * @param {Function} options.parameters.updateMainHeightWidth - Function to update the main height and width.
+ * @param {Function} options.parameters.updateAddForBasic - Function to update the addForBasic flag.
+ * @param {number} options.parameters.itemPageLimit - The limit for item pages.
+ * @param {Function} options.parameters.updateItemPageLimit - Function to update the item page limit.
+ * @param {Function} options.parameters.reorderStreams - Function to reorder streams.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen changes have been handled.
+ *
+ * @throws {Error} Throws an error if there is an issue handling screen changes.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   changed: true,
+ *   parameters: {
+ *     eventType: 'broadcast',
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     addForBasic: false,
+ *     updateMainHeightWidth: (value) => { console.log(updated) },
+ *     updateAddForBasic: (value) => { console.log(updated) },
+ *     itemPageLimit: 1,
+ *     updateItemPageLimit: (value) => { console.log(updated) },
+ *     reorderStreams: async (params) => { },
+ *   },
+ * };
+ *
+ * await onScreenChanges(options);
+ * ```
+ */
 export declare class OnScreenChanges {
     /**
      * Handles changes in screen events such as broadcast, chat, and conference.

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.