mediasfu-angular 1.0.1 → 1.0.2

package/dist/lib/consumers/create-send-transport.service.d.ts

@@ -20,6 +20,52 @@ export interface CreateSendTransportOptions {
     parameters: CreateSendTransportParameters;
 }
 export type CreateSendTransportType = (options: CreateSendTransportOptions) => Promise<void>;
+/**
+ * Creates a WebRTC send transport and sets up event handlers for the transport.
+ *
+ * @param {CreateSendTransportOptions} options - The options for creating the send transport.
+ * @param {'audio' | 'video' | 'screen' | 'all'} options.option - The type of transport to create.
+ * @param {CreateSendTransportParameters} options.parameters - The parameters required for creating the transport.
+ * @param {string} options.parameters.islevel - Indicates the level of the transport.
+ * @param {string} options.parameters.member - The member name associated with the transport.
+ * @param {Socket} options.parameters.socket - The socket instance for communication.
+ * @param {Device | null} options.parameters.device - The WebRTC device instance.
+ * @param {boolean} options.parameters.transportCreated - Flag indicating if the transport is created.
+ * @param {Transport | null} options.parameters.producerTransport - The producer transport instance.
+ * @param {Function} options.parameters.updateProducerTransport - Function to update the producer transport.
+ * @param {Function} options.parameters.updateTransportCreated - Function to update the transport creation state.
+ * @param {Function} options.parameters.connectSendTransport - Function to connect the send transport.
+ *
+ * @returns {Promise<void>} A promise that resolves when the send transport is created and configured.
+ *
+ * @throws Will throw an error if there is an issue creating the send transport.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   option: 'audio',
+ *   parameters: {
+ *     islevel: '2',
+ *     member: 'currentMember',
+ *     socket: socketInstance,
+ *     device: deviceInstance,
+ *     transportCreated: false,
+ *     producerTransport: null,
+ *     updateProducerTransport: (transport) => { console.log(updated) },
+ *     updateTransportCreated: (state) => { console.log(updated) },
+ *     connectSendTransport: connectSendTransportFunction,
+ *   },
+ * };
+ *
+ * createSendTransportService.createSendTransport(options)
+ *   .then(() => {
+ *     console.log('Send transport created successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error creating send transport:', error);
+ *   });
+ * ```
+ */
 export declare class CreateSendTransport {
     /**
      * Creates a WebRTC send transport and sets up event handlers for the transport.

package/dist/lib/consumers/disconnect-send-transport-audio.service.d.ts

@@ -21,6 +21,56 @@ export interface DisconnectSendTransportAudioOptions {
     parameters: DisconnectSendTransportAudioParameters;
 }
 export type DisconnectSendTransportAudioType = (options: DisconnectSendTransportAudioOptions) => Promise<void>;
+/**
+ * Disconnects the send transport for audio by pausing the audio producer and updating the UI accordingly.
+ *
+ * @param {DisconnectSendTransportAudioOptions} options - The options required to disconnect the send transport for audio.
+ * @param {Object} options.parameters - The parameters required for the disconnection.
+ * @param {Producer | null} options.parameters.audioProducer - The audio producer to be paused.
+ * @param {Socket} options.parameters.socket - The socket connection to notify the server.
+ * @param {boolean} options.parameters.videoAlreadyOn - Flag indicating if the video is already on.
+ * @param {string} options.parameters.islevel - The level of the user.
+ * @param {boolean} options.parameters.lock_screen - Flag indicating if the screen is locked.
+ * @param {boolean} options.parameters.shared - Flag indicating if the screen is shared.
+ * @param {Function} options.parameters.updateMainWindow - Function to update the main window state.
+ * @param {string} options.parameters.hostLabel - The label of the host.
+ * @param {string} options.parameters.roomName - The name of the room.
+ * @param {Function} options.parameters.updateAudioProducer - Function to update the audio producer state.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window update state.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ *
+ * @returns {Promise<void>} A promise that resolves when the send transport for audio is disconnected.
+ *
+ * @throws Will throw an error if the operation fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   parameters: {
+ *     audioProducer,
+ *     socket,
+ *     videoAlreadyOn: false,
+ *     islevel: '1',
+ *     lock_screen: false,
+ *     shared: false,
+ *     updateMainWindow: false,
+ *     hostLabel: 'Host',
+ *     roomName: 'Room 101',
+ *     updateAudioProducer: (producer) => { console.log(updated) },
+ *     updateUpdateMainWindow: (state) => { console.log(updated) },
+ *     prepopulateUserMedia: async ({ name, parameters }) => { },
+ *   },
+ * };
+ *
+ * disconnectSendTransportAudioService.disconnectSendTransportAudio(options)
+ *   .then(() => {
+ *     console.log('Audio transport disconnected successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error disconnecting audio transport:', error);
+ *   });
+ * ```
+ */
 export declare class DisconnectSendTransportAudio {
     /**
      * Disconnects the send transport for audio by pausing the audio producer and updating the UI accordingly.

package/dist/lib/consumers/disconnect-send-transport-screen.service.d.ts

@@ -13,6 +13,45 @@ export interface DisconnectSendTransportScreenOptions {
     parameters: DisconnectSendTransportScreenParameters;
 }
 export type DisconnectSendTransportScreenType = (options: DisconnectSendTransportScreenOptions) => Promise<void>;
+/**
+ * Disconnects the send transport for screen sharing.
+ *
+ * This function closes the screen producer, updates the state, and notifies the server
+ * about the closure and pausing of screen sharing.
+ *
+ * @param {DisconnectSendTransportScreenOptions} options - The options for disconnecting the send transport.
+ * @param {Object} options.parameters - The parameters required for disconnection.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Producer | null} options.parameters.screenProducer - The screen producer to be closed.
+ * @param {Socket} options.parameters.socket - The socket connection to notify the server.
+ * @param {string} options.parameters.roomName - The name of the room.
+ * @param {Function} options.parameters.updateScreenProducer - Function to update the screen producer state.
+ *
+ * @returns {Promise<void>} A promise that resolves when the disconnection process is complete.
+ *
+ * @throws {Error} If an error occurs during the disconnection process.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   parameters: {
+ *     screenProducer,
+ *     socket,
+ *     roomName: 'Room 101',
+ *     updateScreenProducer: (producer) => { console.log(updated) },
+ *     getUpdatedAllParams: () => ({}),
+ *   },
+ * };
+ *
+ * disconnectSendTransportScreenService.disconnectSendTransportScreen(options)
+ *   .then(() => {
+ *     console.log('Screen transport disconnected successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error disconnecting screen transport:', error);
+ *   });
+ * ```
+ */
 export declare class DisconnectSendTransportScreen {
     /**
      * Disconnects the send transport for screen sharing.

package/dist/lib/consumers/disconnect-send-transport-video.service.d.ts

@@ -18,6 +18,51 @@ export interface DisconnectSendTransportVideoOptions {
     parameters: DisconnectSendTransportVideoParameters;
 }
 export type DisconnectSendTransportVideoType = (options: DisconnectSendTransportVideoOptions) => Promise<void>;
+/**
+ * Disconnects the send transport for video, closes the video producer, and updates the state.
+ *
+ * @param {DisconnectSendTransportVideoOptions} options - The options required for disconnecting the send transport.
+ * @param {Object} options.parameters - The parameters for the disconnection.
+ * @param {Producer} options.parameters.videoProducer - The video producer to be closed.
+ * @param {Socket} options.parameters.socket - The socket instance for communication.
+ * @param {string} options.parameters.islevel - The participant's level.
+ * @param {string} options.parameters.roomName - The name of the room.
+ * @param {boolean} options.parameters.lock_screen - Flag indicating if the screen is locked.
+ * @param {boolean} options.parameters.updateMainWindow - Flag to update the main window.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window state.
+ * @param {Function} options.parameters.updateVideoProducer - Function to update the video producer state.
+ * @param {Function} options.parameters.reorderStreams - Function to reorder streams.
+ *
+ * @returns {Promise<void>} A promise that resolves when the disconnection process is complete.
+ *
+ * @throws {Error} Throws an error if the disconnection process fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   parameters: {
+ *     videoProducer,
+ *     socket,
+ *     islevel: '1',
+ *     roomName: 'Room 101',
+ *     lock_screen: false,
+ *     updateMainWindow: false,
+ *     updateUpdateMainWindow: (state) => { console.log(updated) },
+ *     updateVideoProducer: (producer) => { console.log(updated) },
+ *     reorderStreams: (params) => { },
+ *     getUpdatedAllParams: () => ({}),
+ *   },
+ * };
+ *
+ * disconnectSendTransportVideoService.disconnectSendTransportVideo(options)
+ *   .then(() => {
+ *     console.log('Video transport disconnected successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error disconnecting video transport:', error);
+ *   });
+ * ```
+ */
 export declare class DisconnectSendTransportVideo {
     /**
      * Disconnects the send transport for video, closes the video producer, and updates the state.

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

@@ -68,6 +68,98 @@ export interface DispStreamsOptions {
     inBreakRoom?: boolean;
 }
 export type DispStreamsType = (options: DispStreamsOptions) => Promise<void>;
+/**
+ * Function to display streams based on various parameters and conditions.
+ *
+ * @param {DispStreamsOptions} options - The options object.
+ * @param {Array<(Stream | Participant)>} options.lStreams - List of streams to display.
+ * @param {number} options.ind - Index of the current stream.
+ * @param {boolean} [options.auto=false] - Flag to indicate if the function should run automatically.
+ * @param {boolean} [options.ChatSkip=false] - Flag to indicate if chat should be skipped.
+ * @param {string|null} [options.forChatID=null] - ID for chat reference.
+ * @param {DispStreamsParameters} options.parameters - Parameters object containing various settings and functions.
+ * @param {number} [options.breakRoom=-1] - Break room number.
+ * @param {boolean} [options.inBreakRoom=false] - Flag to indicate if in break room.
+ *
+ * @returns {Promise<void>} A promise that resolves when the function completes.
+ *
+ * @async
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   lStreams: [...], // Your streams data here
+ *   ind: 0,
+ *   auto: true,
+ *   ChatSkip: false,
+ *   parameters: {
+ *     consumerTransports: [],
+ *     streamNames: [],
+ *     audStreamNames: [],
+ *     participants: [],
+ *     ref_participants: [],
+ *     recordingDisplayType: 'video',
+ *     recordingVideoOptimized: false,
+ *     meetingDisplayType: 'video',
+ *     meetingVideoOptimized: false,
+ *     currentUserPage: 1,
+ *     hostLabel: 'Host',
+ *     mainHeightWidth: 100,
+ *     prevMainHeightWidth: 100,
+ *     prevDoPaginate: false,
+ *     doPaginate: false,
+ *     firstAll: false,
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     shareEnded: false,
+ *     oldAllStreams: [],
+ *     updateMainWindow: false,
+ *     remoteProducerId: null,
+ *     activeNames: [],
+ *     dispActiveNames: [],
+ *     p_dispActiveNames: [],
+ *     nForReadjustRecord: 0,
+ *     first_round: false,
+ *     lock_screen: false,
+ *     chatRefStreams: [],
+ *     eventType: 'normal',
+ *     islevel: '1',
+ *     localStreamVideo: null,
+ *     breakOutRoomStarted: false,
+ *     breakOutRoomEnded: false,
+ *     keepBackground: false,
+ *     virtualStream: null,
+ *     updateActiveNames: (names) => {},
+ *     updateDispActiveNames: (names) => {},
+ *     updateLStreams: (streams) => {},
+ *     updateChatRefStreams: (streams) => {},
+ *     updateNForReadjustRecord: (n) => {},
+ *     updateUpdateMainWindow: (value) => {},
+ *     updateShowMiniView: (value) => {},
+ *     prepopulateUserMedia: async () => {},
+ *     rePort: async () => {},
+ *     processConsumerTransports: async () => {},
+ *     resumePauseStreams: async () => {},
+ *     readjust: async () => {},
+ *     addVideosGrid: async () => {},
+ *     getEstimate: async () => {},
+ *     checkGrid: async () => {},
+ *     resumePauseAudioStreams: async () => {},
+ *     getUpdatedAllParams: () => options.parameters,
+ *   },
+ *   breakRoom: -1,
+ *   inBreakRoom: false,
+ * };
+ *
+ * dispStreamsService.dispStreams(options)
+ *   .then(() => {
+ *     console.log('Streams displayed successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error displaying streams:', error);
+ *   });
+ * ```
+ */
 export declare class DispStreams {
     /**
      * Function to display streams based on various parameters and conditions.

package/dist/lib/consumers/generate-page-content.service.d.ts

@@ -17,6 +17,53 @@ export interface GeneratePageContentOptions {
     inBreakRoom?: boolean;
 }
 export type GeneratePageContentType = (options: GeneratePageContentOptions) => Promise<void>;
+/**
+ * Generates the content for a specific page.
+ *
+ * @param {GeneratePageContentOptions} options - The options for generating page content.
+ * @param {number | string} options.page - The page number to generate content for.
+ * @param {GeneratePageContentParameters} options.parameters - The parameters required for generating content.
+ * @param {Array<(Participant | Stream)[]>} options.parameters.paginatedStreams - The streams to be paginated.
+ * @param {number} options.parameters.currentUserPage - The current page of the user.
+ * @param {Function} options.parameters.updateMainWindow - Function to update the main window flag.
+ * @param {Function} options.parameters.updateCurrentUserPage - Function to update the current user page.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window update flag.
+ * @param {Function} options.parameters.dispStreams - Function to display streams for the specified page.
+ * @param {number} [options.breakRoom=-1] - The break room identifier.
+ * @param {boolean} [options.inBreakRoom=false] - Flag indicating if the user is in a break room.
+ *
+ * @returns {Promise<void>} A promise that resolves when the content generation is complete.
+ *
+ * @throws {Error} Throws an error if content generation fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   page: 1,
+ *   parameters: {
+ *     paginatedStreams: [
+ *       // Page 0 streams
+ *       [stream1, stream2],
+ *       // Page 1 streams
+ *       [stream3, stream4],
+ *     ],
+ *     currentUserPage: 0,
+ *     updateMainWindow: false,
+ *     updateCurrentUserPage: (page) => { console.log(`Current page updated to: ${page}`); },
+ *     updateUpdateMainWindow: (flag) => { console.log(`Main window update flag: ${flag}`); },
+ *     dispStreams: async ({ lStreams, ind }) => {
+ *       console.log(`Displaying streams for page ${ind}:`, lStreams);
+ *     },
+ *     getUpdatedAllParams: () => options.parameters,
+ *   },
+ *   breakRoom: -1,
+ *   inBreakRoom: false,
+ * };
+ *
+ * const generatePageContentService = new GeneratePageContent();
+ * await generatePageContentService.generatePageContent(options);
+ * ```
+ */
 export declare class GeneratePageContent {
     /**
      * Generates the content for a specific page.

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.