mediasfu-angular 1.0.0 → 1.0.2

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.

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

@@ -14,6 +14,39 @@ export interface ResumePauseStreamsOptions {
     parameters: ResumePauseStreamsParameters;
 }
 export type ResumePauseStreamsType = (options: ResumePauseStreamsOptions) => Promise<void>;
+/**
+ * Resumes or pauses streams based on the provided parameters.
+ *
+ * This method processes the current participant states and the active display names to determine
+ * which audio and video streams should be resumed or paused. It communicates with the server
+ * to resume streams as necessary.
+ *
+ * @param {ResumePauseStreamsOptions} options - The options for resuming or pausing streams.
+ * @param {Object} options.parameters - The parameters for the function.
+ * @param {Array<Participant>} options.parameters.participants - The list of participants in the session.
+ * @param {Array<string>} options.parameters.dispActiveNames - The list of active display names.
+ * @param {Array<Transport>} options.parameters.consumerTransports - The list of consumer transports.
+ * @param {string} [options.parameters.screenId] - The screen producer ID if applicable.
+ * @param {string} options.parameters.islevel - The level of the user (e.g., participant or host).
+ *
+ * @returns {Promise<void>} A promise that resolves when the streams have been resumed or paused.
+ *
+ * @throws Will throw an error if there is an issue during the process of resuming or pausing streams.
+ *
+ * @example
+ * ```typescript
+ * await resumePauseStreams({
+ *   parameters: {
+ *     participants: [...], // Array of participants
+ *     dispActiveNames: ['Alice', 'Bob'], // Active display names
+ *     consumerTransports: [...], // Array of consumer transports
+ *     screenId: 'screen123', // Screen producer ID
+ *     islevel: '1', // User level
+ *     getUpdatedAllParams: myGetUpdatedFunction, // Function to get updated params
+ *   },
+ * });
+ * ```
+ */
 export declare class ResumePauseStreams {
     /**
      * Resumes or pauses streams based on the provided parameters.

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

@@ -17,6 +17,42 @@ export interface ResumeSendTransportAudioOptions {
     parameters: ResumeSendTransportAudioParameters;
 }
 export type ResumeSendTransportAudioType = (options: ResumeSendTransportAudioOptions) => Promise<void>;
+/**
+ * Resumes the send transport for audio and updates the UI and audio producer state accordingly.
+ *
+ * This method is essential for resuming audio streaming after it has been paused.
+ * It updates the application state and UI to reflect the current audio status.
+ *
+ * @param {ResumeSendTransportAudioOptions} options - The options for resuming the send transport.
+ * @param {Object} options.parameters - The parameters required for resuming the send transport.
+ * @param {Producer} options.parameters.audioProducer - The audio producer to be resumed.
+ * @param {string} options.parameters.islevel - The level of the user (e.g., host).
+ * @param {string} options.parameters.hostLabel - The label of the host.
+ * @param {boolean} options.parameters.lock_screen - Indicates if the screen is locked.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is shared.
+ * @param {Function} options.parameters.updateAudioProducer - Function to update the audio producer state.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video is already on.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window state.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ *
+ * @returns {Promise<void>} A promise that resolves when the send transport is resumed and the UI is updated.
+ *
+ * @throws {Error} Throws an error if there is an issue during the process of resuming the audio send transport.
+ *
+ * @example
+ * await resumeSendTransportAudio({
+ *   parameters: {
+ *     audioProducer: myAudioProducer,
+ *     islevel: '2',
+ *     hostLabel: 'Host',
+ *     lock_screen: false,
+ *     shared: false,
+ *     updateAudioProducer: (producer) => { /* update producer state *\/ },
+ *     updateUpdateMainWindow: (state) => { /* update main window state *\/ },
+ *     prepopulateUserMedia: myPrepopulateFunction,
+ *   },
+ * });
+ */
 export declare class ResumeSendTransportAudio {
     /**
      * Resumes the send transport for audio and updates the UI and audio producer state accordingly.

package/dist/lib/consumers/signal-new-consumer-transport.service.d.ts

@@ -19,44 +19,44 @@ export interface SignalNewConsumerTransportOptions {
     parameters: SignalNewConsumerTransportParameters;
 }
 export type SignalNewConsumerTransportType = (options: SignalNewConsumerTransportOptions) => Promise<string[] | void>;
+/**
+   * Signals the creation of a new consumer transport.
+   *
+   * @param {Object} options - The options for signaling a new consumer transport.
+   * @param {string} options.remoteProducerId - The ID of the remote producer.
+   * @param {boolean} options.islevel - Indicates the level of the consumer.
+   * @param {any} options.nsock - The socket instance for communication.
+   * @param {SignalNewConsumerTransportOptions} options.parameters - The parameters for the transport.
+   *
+   * @returns {Promise<string[] | void>} A promise that resolves to an array of consuming transports or void.
+   *
+   * @throws Will throw an error if the signaling process fails.
+   *
+   * @example
+   * const options = {
+   *   remoteProducerId: 'producer-id',
+   *   islevel: true,
+   *   nsock: socketInstance,
+   *   parameters: {
+   *     device: mediaDevice,
+   *     consumingTransports: [],
+   *     lock_screen: false,
+   *     updateConsumingTransports: updateFunction,
+   *     connectRecvTransport: connectFunction,
+   *     reorderStreams: reorderFunction,
+   *     getUpdatedAllParams: getUpdatedParamsFunction,
+   *   },
+   * };
+   *
+   * signalNewConsumerTransport(options)
+   *   .then(consumingTransports => {
+   *     console.log('Consuming Transports:', consumingTransports);
+   *   })
+   *   .catch(error => {
+   *     console.error('Error signaling new consumer transport:', error);
+   *   });
+   */
 export declare class SignalNewConsumerTransport {
-    /**
-     * Signals the creation of a new consumer transport.
-     *
-     * @param {Object} options - The options for signaling a new consumer transport.
-     * @param {string} options.remoteProducerId - The ID of the remote producer.
-     * @param {boolean} options.islevel - Indicates the level of the consumer.
-     * @param {any} options.nsock - The socket instance for communication.
-     * @param {SignalNewConsumerTransportOptions} options.parameters - The parameters for the transport.
-     *
-     * @returns {Promise<string[] | void>} A promise that resolves to an array of consuming transports or void.
-     *
-     * @throws Will throw an error if the signaling process fails.
-     *
-     * @example
-     * const options = {
-     *   remoteProducerId: 'producer-id',
-     *   islevel: true,
-     *   nsock: socketInstance,
-     *   parameters: {
-     *     device: mediaDevice,
-     *     consumingTransports: [],
-     *     lock_screen: false,
-     *     updateConsumingTransports: updateFunction,
-     *     connectRecvTransport: connectFunction,
-     *     reorderStreams: reorderFunction,
-     *     getUpdatedAllParams: getUpdatedParamsFunction,
-     *   },
-     * };
-     *
-     * signalNewConsumerTransport(options)
-     *   .then(consumingTransports => {
-     *     console.log('Consuming Transports:', consumingTransports);
-     *   })
-     *   .catch(error => {
-     *     console.error('Error signaling new consumer transport:', error);
-     *   });
-     */
     signalNewConsumerTransport: ({ remoteProducerId, islevel, nsock, parameters, }: SignalNewConsumerTransportOptions) => Promise<string[] | void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SignalNewConsumerTransport, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SignalNewConsumerTransport>;

package/dist/lib/consumers/socket-receive-methods/join-consume-room.service.d.ts

@@ -24,6 +24,39 @@ interface JoinConsumeRoomResponse {
     rtpCapabilities?: RtpCapabilities;
 }
 export type JoinConsumeRoomType = (options: JoinConsumeRoomOptions) => Promise<JoinConsumeRoomResponse>;
+/**
+ * @service JoinConsumeRoom
+ * @description Service to join a media consumption room, setup device, and manage piped transports.
+ *
+ * @method joinConsumeRoom
+ * Joins a consumption room by sending a request to the server and performing necessary device and transport setup.
+ *
+ * @param {JoinConsumeRoomOptions} options - Options for joining the consumption room.
+ * @param {Socket} options.remote_sock - The remote socket used for joining the room.
+ * @param {string} options.apiToken - API token for authentication.
+ * @param {string} options.apiUserName - API username for authentication.
+ * @param {JoinConsumeRoomParameters} options.parameters - Parameters required for the function.
+ *
+ * @returns {Promise<JoinConsumeRoomResponse>} A promise that resolves with the result of the join request.
+ *
+ * @example
+ * ```typescript
+ * const joinConsumeRoomResponse = await joinConsumeRoomService.joinConsumeRoom({
+ *   remote_sock: mySocket,
+ *   apiToken: 'apiToken123',
+ *   apiUserName: 'myUser',
+ *   parameters: {
+ *     roomName: 'room1',
+ *     islevel: '2',
+ *     member: 'JohnDoe',
+ *     device: null,
+ *     updateDevice: updateDeviceFunction,
+ *     receiveAllPipedTransports: receiveAllPipedTransportsFunction,
+ *     createDeviceClient: createDeviceClientFunction,
+ *   }
+ * });
+ * ```
+ */
 export declare class JoinConsumeRoom {
     private JoinConRoomService;
     constructor(JoinConRoomService: JoinConRoom);

package/dist/lib/consumers/socket-receive-methods/new-pipe-producer.service.d.ts

@@ -28,6 +28,45 @@ export interface NewPipeProducerOptions {
     parameters: NewPipeProducerParameters;
 }
 export type NewPipeProducerType = (options: NewPipeProducerOptions) => Promise<void>;
+/**
+ * @service NewPipeProducer
+ * @description Service to manage new pipe producer events, update state, and handle screen orientation for optimal experience.
+ *
+ * @method newPipeProducer
+ * Handles the setup of a new pipe producer and manages user notifications or orientation changes as needed.
+ *
+ * @param {NewPipeProducerOptions} options - Options for setting up a new pipe producer.
+ * @param {string} options.producerId - Unique ID for the new producer.
+ * @param {string} options.islevel - Level designation for the producer.
+ * @param {Socket} options.nsock - The socket used for communication.
+ * @param {NewPipeProducerParameters} options.parameters - Parameters to configure the new pipe producer.
+ *
+ * @returns {Promise<void>} A promise that completes when the new pipe producer is set up.
+ *
+ * @example
+ * ```typescript
+ * await newPipeProducerService.newPipeProducer({
+ *   producerId: 'producer123',
+ *   islevel: '2',
+ *   nsock: mySocket,
+ *   parameters: {
+ *     first_round: true,
+ *     shareScreenStarted: false,
+ *     shared: false,
+ *     landScaped: false,
+ *     showAlert: alertFunction,
+ *     isWideScreen: true,
+ *     updateFirst_round: updateFirstRoundFunction,
+ *     updateLandScaped: updateLandScapedFunction,
+ *     device: myDevice,
+ *     consumingTransports: [],
+ *     connectRecvTransport: connectRecvTransportFunction,
+ *     reorderStreams: reorderStreamsFunction,
+ *     getUpdatedAllParams: getUpdatedParamsFunction,
+ *   }
+ * });
+ * ```
+ */
 export declare class NewPipeProducer {
     private signalNewConsumerTransportService;
     constructor(signalNewConsumerTransportService: SignalNewConsumerTransport);

package/dist/lib/consumers/socket-receive-methods/producer-closed.service.d.ts

@@ -13,6 +13,33 @@ export interface ProducerClosedOptions {
     parameters: ProducerClosedParameters;
 }
 export type ProducerClosedType = (options: ProducerClosedOptions) => Promise<void>;
+/**
+ * @service ProducerClosed
+ * @description Service to manage the closing of a producer, including resizing video elements and updating consumer transports.
+ *
+ * @method producerClosed
+ * Closes a specific producer by its ID, adjusts any associated video elements, and updates the list of consumer transports.
+ *
+ * @param {ProducerClosedOptions} options - Options for closing the specified producer.
+ * @param {string} options.remoteProducerId - Unique ID for the producer to close.
+ * @param {ProducerClosedParameters} options.parameters - Parameters to configure the producer closure and related updates.
+ *
+ * @returns {Promise<void>} A promise that resolves when the producer has been closed and relevant updates have been made.
+ *
+ * @example
+ * ```typescript
+ * await producerClosedService.producerClosed({
+ *   remoteProducerId: 'producer123',
+ *   parameters: {
+ *     consumerTransports: currentTransports,
+ *     screenId: 'screen123',
+ *     updateConsumerTransports: updateTransportList,
+ *     closeAndResize: closeAndResizeFunction,
+ *     getUpdatedAllParams: getUpdatedParamsFunction,
+ *   }
+ * });
+ * ```
+ */
 export declare class ProducerClosed {
     /**
      * Handles the closing of a producer and resizes video elements.

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

@@ -14,6 +14,46 @@ export interface StartShareScreenOptions {
     parameters: StartShareScreenParameters;
 }
 export type StartShareScreenType = (options: StartShareScreenOptions) => Promise<void>;
+/**
+ * StartShareScreen - Service to initiate screen sharing with configurable options for different environments.
+ *
+ * This service initiates the screen sharing process, handling both successful and failed attempts
+ * and updating the shared state accordingly.
+ *
+ * @class
+ * @name StartShareScreen
+ * @example
+ * ```typescript
+ * const startShareScreenService = new StartShareScreen();
+ * await startShareScreenService.startShareScreen({
+ *   parameters: {
+ *     shared: false,
+ *     showAlert: (alert) => console.log(alert.message),
+ *     updateShared: (shared) => console.log('Shared state:', shared),
+ *     onWeb: true,
+ *     targetWidth: 1920,
+ *     targetHeight: 1080,
+ *     streamSuccessScreen: async ({ stream }) => {
+ *       // Handle the successful stream here
+ *       console.log('Stream started:', stream);
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * @param {StartShareScreenOptions} options - The options for starting screen sharing.
+ * @param {Object} options.parameters - The parameters controlling screen sharing behavior.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is currently shared.
+ * @param {Function} options.parameters.showAlert - Function to display alerts.
+ * @param {Function} options.parameters.updateShared - Function to update the shared state.
+ * @param {boolean} options.parameters.onWeb - Indicates if the app is running in a web environment.
+ * @param {number} [options.parameters.targetWidth=1280] - Optional width setting for shared screen resolution.
+ * @param {number} [options.parameters.targetHeight=720] - Optional height setting for shared screen resolution.
+ * @param {Function} options.parameters.streamSuccessScreen - Function to handle successful screen sharing.
+ *
+ * @method startShareScreen - Initiates the screen sharing process based on the provided parameters.
+ * @returns {Promise<void>} Resolves when the screen sharing process is complete or fails.
+ */
 export declare class StartShareScreen {
     /**
      * Starts the screen sharing process.

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

@@ -39,6 +39,61 @@ export interface StopShareScreenOptions {
     parameters: StopShareScreenParameters;
 }
 export type StopShareScreenType = (options: StopShareScreenOptions) => Promise<void>;
+/**
+ * Stops the screen sharing process and updates the relevant parameters and states.
+ *
+ * This method updates the internal state to reflect that screen sharing has ended,
+ * cleans up local media tracks, and reorders the streams in the application.
+ *
+ * @param {StopShareScreenOptions} options - The options for stopping the screen share.
+ * @param {Object} options.parameters - The parameters required for stopping the screen share.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is currently shared.
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if the screen sharing has started.
+ * @param {boolean} options.parameters.shareEnded - Indicates if the screen sharing has ended.
+ * @param {boolean} options.parameters.updateMainWindow - Indicates if the main window needs to be updated.
+ * @param {boolean} options.parameters.defer_receive - Indicates if receiving is deferred.
+ * @param {string} options.parameters.hostLabel - The label of the host.
+ * @param {boolean} options.parameters.lock_screen - Indicates if the screen is locked.
+ * @param {boolean} options.parameters.forceFullDisplay - Indicates if full display is forced.
+ * @param {boolean} options.parameters.firstAll - Indicates if it is the first all.
+ * @param {boolean} options.parameters.first_round - Indicates if it is the first round.
+ * @param {MediaStream} options.parameters.localStreamScreen - The local screen stream.
+ * @param {string} options.parameters.eventType - The type of event (e.g., "conference").
+ * @param {boolean} options.parameters.prevForceFullDisplay - Indicates if full display was previously forced.
+ * @param {boolean} options.parameters.annotateScreenStream - Indicates if the screen stream is annotated.
+ * @param {Function} options.parameters.updateShared - Function to update the shared state.
+ * @param {Function} options.parameters.updateShareScreenStarted - Function to update the share screen started state.
+ * @param {Function} options.parameters.updateShareEnded - Function to update the share ended state.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window state.
+ * @param {Function} options.parameters.updateDefer_receive - Function to update the defer receive state.
+ * @param {Function} options.parameters.updateLock_screen - Function to update the lock screen state.
+ * @param {Function} options.parameters.updateForceFullDisplay - Function to update the force full display state.
+ * @param {Function} options.parameters.updateFirstAll - Function to update the first all state.
+ * @param {Function} options.parameters.updateFirst_round - Function to update the first round state.
+ * @param {Function} options.parameters.updateLocalStreamScreen - Function to update the local screen stream.
+ * @param {Function} options.parameters.updateMainHeightWidth - Function to update the main height and width.
+ * @param {Function} options.parameters.updateAnnotateScreenStream - Function to update the annotate screen stream state.
+ * @param {Function} options.parameters.updateIsScreenboardModalVisible - Function to update the screenboard modal visibility.
+ * @param {Function} options.parameters.disconnectSendTransportScreen - Function to disconnect the send transport screen.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ * @param {Function} options.parameters.reorderStreams - Function to reorder streams.
+ * @param {Function} options.parameters.getVideos - Function to get videos.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen sharing process is stopped.
+ *
+ * @throws {Error} Throws an error if there is an issue during the screen share stopping process.
+ *
+ * @example
+ * await stopShareScreen({
+ *   parameters: {
+ *     socket: mySocket,
+ *     shared: true,
+ *     shareScreenStarted: true,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class StopShareScreen {
     /**
      * Stops the screen sharing process and updates the relevant parameters and states.