mediasfu-angular 1.0.1 → 1.0.2

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.

package/dist/lib/consumers/stream-success-audio-switch.service.d.ts

@@ -46,6 +46,59 @@ export interface StreamSuccessAudioSwitchOptions {
     parameters: StreamSuccessAudioSwitchParameters;
 }
 export type StreamSuccessAudioSwitchType = (options: StreamSuccessAudioSwitchOptions) => Promise<void>;
+/**
+ * Handles the switching of the audio stream upon successful stream connection.
+ *
+ * This method updates the audio producer, manages the transport connections,
+ * and ensures that the UI reflects the current audio state after switching devices.
+ *
+ * @param {StreamSuccessAudioSwitchOptions} options - The options for the stream success audio switch.
+ * @param {MediaStream} options.stream - The new media stream with the switched audio device.
+ * @param {Object} options.parameters - The parameters required for the audio switch.
+ * @param {Producer | null} options.parameters.audioProducer - The current audio producer.
+ * @param {Socket} options.parameters.socket - The socket connection.
+ * @param {string} options.parameters.roomName - The name of the room for the connection.
+ * @param {MediaStream | null} options.parameters.localStream - The local media stream.
+ * @param {MediaStream | null} options.parameters.localStreamAudio - The local audio stream.
+ * @param {ProducerOptions} options.parameters.audioParams - The audio parameters for the producer.
+ * @param {boolean} options.parameters.audioPaused - Indicates if the audio is currently paused.
+ * @param {boolean} options.parameters.audioAlreadyOn - Indicates if the audio was already active.
+ * @param {boolean} options.parameters.transportCreated - Indicates if the transport has been created.
+ * @param {ProducerCodecOptions} [options.parameters.audioParamse] - Additional audio parameters.
+ * @param {string} options.parameters.defAudioID - The default audio device ID.
+ * @param {string} options.parameters.userDefaultAudioInputDevice - The user default audio input device.
+ * @param {string} options.parameters.hostLabel - The label of the host for the session.
+ * @param {boolean} options.parameters.updateMainWindow - Indicates if the main window needs to be updated.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video stream is active.
+ * @param {string} options.parameters.islevel - The level of the user in the session.
+ * @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 {Function} options.parameters.updateLocalStream - Function to update the local stream.
+ * @param {Function} options.parameters.updateAudioParams - Function to update the audio parameters.
+ * @param {Function} options.parameters.updateDefAudioID - Function to update the default audio device ID.
+ * @param {Function} options.parameters.updateUserDefaultAudioInputDevice - Function to update the user default audio input device.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window state.
+ * @param {Function} options.parameters.sleep - Function to pause execution for a specified time.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ * @param {Function} options.parameters.createSendTransport - Function to create a send transport for audio.
+ * @param {Function} options.parameters.connectSendTransportAudio - Function to connect the send transport for audio.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio switch is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue during the audio stream switch process.
+ *
+ * @example
+ * await streamSuccessAudioSwitch({
+ *   stream: newStream,
+ *   parameters: {
+ *     audioProducer: currentAudioProducer,
+ *     socket: socketInstance,
+ *     roomName: 'exampleRoom',
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class StreamSuccessAudioSwitch {
     /**
      * Handles the switching of the audio stream upon successful stream connection.

package/dist/lib/consumers/stream-success-audio.service.d.ts

@@ -48,6 +48,67 @@ export interface StreamSuccessAudioOptions {
     parameters: StreamSuccessAudioParameters;
 }
 export type StreamSuccessAudioType = (options: StreamSuccessAudioOptions) => Promise<void>;
+/**
+ * Handles the successful streaming of audio by setting up the necessary transports and updating the relevant states.
+ *
+ * This method updates the local media stream with the new audio track, manages the transport connection,
+ * and updates the participants' states to reflect changes in audio settings.
+ *
+ * @param {StreamSuccessAudioOptions} options - The options for streaming success audio.
+ * @param {MediaStream} options.stream - The media stream containing the audio track.
+ * @param {StreamSuccessAudioParameters} options.parameters - The parameters required for setting up the audio stream.
+ * @param {Socket} options.parameters.socket - The socket connection for real-time communication.
+ * @param {Participant[]} options.parameters.participants - The list of participants in the session.
+ * @param {MediaStream | null} options.parameters.localStream - The local media stream that includes video and audio tracks.
+ * @param {boolean} options.parameters.transportCreated - Indicates if the audio transport has been created.
+ * @param {boolean} options.parameters.transportCreatedAudio - Indicates if the audio transport has been created.
+ * @param {boolean} options.parameters.audioAlreadyOn - Indicates if the audio is already active.
+ * @param {boolean} options.parameters.micAction - Indicates the microphone action state.
+ * @param {ProducerOptions} options.parameters.audioParams - The current audio parameters for the producer.
+ * @param {MediaStream | null} options.parameters.localStreamAudio - The local audio stream.
+ * @param {string} options.parameters.defAudioID - The default audio device ID for the stream.
+ * @param {string} options.parameters.userDefaultAudioInputDevice - The user default audio input device.
+ * @param {ProducerOptions} options.parameters.params - Additional parameters for the producer.
+ * @param {ProducerOptions} [options.parameters.audioParamse] - Additional audio parameters.
+ * @param {ProducerOptions} options.parameters.aParams - Producer parameters for the audio.
+ * @param {string} options.parameters.hostLabel - The label of the host for this session.
+ * @param {string} options.parameters.islevel - The participant's level (e.g., admin, regular user).
+ * @param {string} options.parameters.member - The member name for identification.
+ * @param {boolean} options.parameters.updateMainWindow - Indicates if the main window needs to be updated.
+ * @param {boolean} options.parameters.lock_screen - Indicates if the screen is locked for participants.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is currently shared.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video stream is currently active.
+ * @param {ShowAlert} [options.parameters.showAlert] - Optional function to show alert messages.
+ * @param {Function} options.parameters.updateParticipants - Function to update the list of participants.
+ * @param {Function} options.parameters.updateTransportCreated - Function to update the audio transport created status.
+ * @param {Function} options.parameters.updateTransportCreatedAudio - Function to update the audio transport created status.
+ * @param {Function} options.parameters.updateAudioAlreadyOn - Function to update the audio active status.
+ * @param {Function} options.parameters.updateMicAction - Function to update the microphone action state.
+ * @param {Function} options.parameters.updateAudioParams - Function to update the audio parameters.
+ * @param {Function} options.parameters.updateLocalStream - Function to update the local stream.
+ * @param {Function} options.parameters.updateLocalStreamAudio - Function to update the local audio stream.
+ * @param {Function} options.parameters.updateDefAudioID - Function to update the default audio device ID.
+ * @param {Function} options.parameters.updateUserDefaultAudioInputDevice - Function to update the default audio input device.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window status.
+ * @param {Function} options.parameters.createSendTransport - Function to create a send transport for audio.
+ * @param {Function} options.parameters.connectSendTransportAudio - Function to connect the send transport for audio.
+ * @param {Function} options.parameters.resumeSendTransportAudio - Function to resume the send transport for audio.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media based on current settings.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio streaming setup is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue during the audio stream setup.
+ *
+ * @example
+ * await streamSuccessAudio({
+ *   stream: newAudioStream,
+ *   parameters: {
+ *     socket: socketInstance,
+ *     participants: participantList,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class StreamSuccessAudio {
     /**
      * Handles the successful streaming of audio by setting up the necessary transports and updating the relevant states.

package/dist/lib/consumers/stream-success-screen.service.d.ts

@@ -36,6 +36,56 @@ export interface StreamSuccessScreenOptions {
     parameters: StreamSuccessScreenParameters;
 }
 export type StreamSuccessScreenType = (options: StreamSuccessScreenOptions) => Promise<void>;
+/**
+ * Handles the successful initiation of screen sharing.
+ *
+ * This method sets up the necessary transport connections for screen sharing,
+ * updates relevant application states, and notifies participants of the screen
+ * sharing status.
+ *
+ * @param {StreamSuccessScreenOptions} options - The options for the screen sharing success handler.
+ * @param {MediaStream} options.stream - The media stream to be shared.
+ * @param {StreamSuccessScreenParameters} options.parameters - The parameters required for screen sharing.
+ * @param {Socket} options.parameters.socket - The socket instance for real-time communication.
+ * @param {boolean} options.parameters.transportCreated - Flag indicating if the transport is already created.
+ * @param {MediaStream | null} options.parameters.localStreamScreen - The local screen media stream.
+ * @param {boolean} options.parameters.screenAlreadyOn - Flag indicating if the screen is already being shared.
+ * @param {boolean} options.parameters.screenAction - Flag indicating if the screen share action is requested.
+ * @param {boolean} options.parameters.transportCreatedScreen - Flag indicating if the screen transport is created.
+ * @param {string} options.parameters.hostLabel - The label of the host for this session.
+ * @param {string} options.parameters.eventType - The type of event (e.g., conference).
+ * @param {ShowAlert} [options.parameters.showAlert] - Optional function to show alert messages.
+ * @param {boolean} options.parameters.annotateScreenStream - Flag indicating if screen annotation is enabled.
+ * @param {Function} options.parameters.updateTransportCreatedScreen - Function to update the screen transport creation state.
+ * @param {Function} options.parameters.updateScreenAlreadyOn - Function to update the screen sharing state.
+ * @param {Function} options.parameters.updateScreenAction - Function to update the screen action state.
+ * @param {Function} options.parameters.updateTransportCreated - Function to update the transport creation state.
+ * @param {Function} options.parameters.updateLocalStreamScreen - Function to update the local screen stream.
+ * @param {Function} options.parameters.updateShared - Function to update the shared state.
+ * @param {Function} options.parameters.updateIsScreenboardModalVisible - Function to update the screenboard modal visibility.
+ * @param {Function} options.parameters.sleep - Function to pause execution for a specified time.
+ * @param {Function} options.parameters.createSendTransport - Function to create a send transport for screen sharing.
+ * @param {Function} options.parameters.connectSendTransportScreen - Function to connect the send transport for screen sharing.
+ * @param {Function} options.parameters.disconnectSendTransportScreen - Function to disconnect the send transport for screen sharing.
+ * @param {Function} options.parameters.stopShareScreen - Function to stop the screen sharing process.
+ * @param {Function} options.parameters.reorderStreams - Function to reorder streams based on current state.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media based on current settings.
+ * @param {Function} options.parameters.rePort - Function to reinitialize ports if needed.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen sharing setup is complete.
+ *
+ * @throws {Error} Throws an error if there is an issue during the screen sharing setup.
+ *
+ * @example
+ * await streamSuccessScreen({
+ *   stream: newScreenStream,
+ *   parameters: {
+ *     socket: socketInstance,
+ *     localStreamScreen: null,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class StreamSuccessScreen {
     /**
      * Handles the successful initiation of screen sharing.

package/dist/lib/consumers/stream-success-video.service.d.ts

@@ -57,6 +57,64 @@ export interface StreamSuccessVideoOptions {
     parameters: StreamSuccessVideoParameters;
 }
 export type StreamSuccessVideoType = (options: StreamSuccessVideoOptions) => Promise<void>;
+/**
+ * Streams a video successfully by managing the local stream, updating parameters, and handling video transport.
+ *
+ * This method initiates the video streaming process by updating the local video stream with the new stream,
+ * creating or connecting to the video transport, and notifying participants of the streaming status.
+ *
+ * @param {StreamSuccessVideoOptions} options - The options for streaming the video.
+ * @param {MediaStream} options.stream - The media stream to be used for the video.
+ * @param {StreamSuccessVideoParameters} options.parameters - The parameters required for streaming.
+ * @param {Socket} options.parameters.socket - The socket instance for real-time communication.
+ * @param {Participant[]} options.parameters.participants - The list of participants in the session.
+ * @param {MediaStream | null} options.parameters.localStream - The local media stream.
+ * @param {boolean} options.parameters.transportCreated - Indicates if the transport has already been created.
+ * @param {boolean} options.parameters.transportCreatedVideo - Indicates if the video transport has been created.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video is already on.
+ * @param {boolean} options.parameters.videoAction - Indicates if a video action is being performed.
+ * @param {ProducerOptions} options.parameters.videoParams - The parameters for the video producer.
+ * @param {MediaStream | null} options.parameters.localStreamVideo - The local video stream.
+ * @param {string} options.parameters.defVideoID - The default video device ID.
+ * @param {string} options.parameters.userDefaultVideoInputDevice - The user's default video input device.
+ * @param {ProducerOptions} options.parameters.params - Additional parameters for the producer.
+ * @param {ProducerOptions} options.parameters.videoParamse - Additional parameters for the video.
+ * @param {string} options.parameters.islevel - The level of the user (e.g., host, participant).
+ * @param {string} options.parameters.member - The member's name in the session.
+ * @param {boolean} options.parameters.updateMainWindow - Indicates if the main window should be updated.
+ * @param {boolean} options.parameters.lock_screen - Indicates if the screen is locked.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is shared.
+ * @param {boolean} options.parameters.videoAlreadyOn - Indicates if the video is already on.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {Function} options.parameters.updateParticipants - Function to update the participants list.
+ * @param {Function} options.parameters.updateTransportCreatedVideo - Function to update the transport creation state.
+ * @param {Function} options.parameters.updateVideoAlreadyOn - Function to update the video status.
+ * @param {Function} options.parameters.updateVideoAction - Function to update the video action state.
+ * @param {Function} options.parameters.updateLocalStream - Function to update the local stream.
+ * @param {Function} options.parameters.updateLocalStreamVideo - Function to update the local video stream.
+ * @param {Function} options.parameters.updateUserDefaultVideoInputDevice - Function to update the default video input device.
+ * @param {Function} options.parameters.updateCurrentFacingMode - Function to update the current facing mode.
+ * @param {Function} options.parameters.updateDefVideoID - Function to update the default video device ID.
+ * @param {Function} options.parameters.updateAllowed - Function to update the allowed state.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window state.
+ * @param {Function} options.parameters.createSendTransport - Function to create a send transport for video.
+ * @param {Function} options.parameters.connectSendTransportVideo - Function to connect the send transport for video.
+ * @param {Function} options.parameters.resumeSendTransportAudio - Function to resume audio transport.
+ *
+ * @returns {Promise<void>} A promise that resolves when the video has been successfully streamed.
+ *
+ * @throws {Error} Throws an error if there is an issue with streaming the video.
+ *
+ * @example
+ * await streamSuccessVideo({
+ *   stream: newVideoStream,
+ *   parameters: {
+ *     socket: socketInstance,
+ *     localStream: null,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class StreamSuccessVideo {
     /**
      * Streams a video successfully by managing the local stream, updating parameters, and handling video transport.