mediasfu-angular 1.0.1 → 2.0.0

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

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

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

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

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

@@ -9,15 +9,50 @@ export interface ReceiveAllPipedTransportsParameters extends GetPipedProducersAl
 }
 export interface ReceiveAllPipedTransportsOptions {
     nsock: Socket;
+    community?: boolean;
     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 {boolean} options.community - Whether the room is a community edition room.
+ * @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,
+ *   community: true,
+ *   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.
      *
      * @param {ReceiveAllPipedTransportsOptions} options - The options for receiving all piped transports.
      * @param {any} options.nsock - The socket instance used for communication.
+     * @param {boolean} options.community - Whether the room is a community edition room.
      * @param {Object} 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.
@@ -27,7 +62,7 @@ export declare class ReceiveAllPipedTransports {
      *
      * @throws Will log an error message if the operation fails.
      */
-    receiveAllPipedTransports: ({ nsock, parameters, }: ReceiveAllPipedTransportsOptions) => Promise<void>;
+    receiveAllPipedTransports: ({ nsock, community, parameters, }: ReceiveAllPipedTransportsOptions) => Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReceiveAllPipedTransports, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ReceiveAllPipedTransports>;
 }

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

@@ -3,39 +3,108 @@ import { PrepopulateUserMediaParameters, PrepopulateUserMediaType } from '../@ty
 import * as i0 from "@angular/core";
 export interface ResumeSendTransportAudioParameters extends PrepopulateUserMediaParameters {
     audioProducer: Producer | null;
+    localAudioProducer?: Producer | null;
     islevel: string;
     hostLabel: string;
     lock_screen: boolean;
     shared: boolean;
     videoAlreadyOn: boolean;
     updateAudioProducer: (audioProducer: Producer | null) => void;
+    updateLocalAudioProducer?: (localAudioProducer: Producer | null) => void;
     updateUpdateMainWindow: (updateMainWindow: boolean) => void;
     prepopulateUserMedia: PrepopulateUserMediaType;
+    prepopulateLocalUserMedia?: PrepopulateUserMediaType;
     [key: string]: any;
 }
 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 function supports both a primary and a local audio producer, delegating the local logic to a separate function.
+ *
+ * @param {ResumeSendTransportAudioOptions} options - The options for resuming the send transport.
+ * @param {ResumeSendTransportAudioParameters} options.parameters - The parameters for resuming the send transport.
+ * @param {Producer} options.parameters.audioProducer - The primary audio producer to resume.
+ * @param {Producer} [options.parameters.localAudioProducer] - The local audio producer to resume.
+ * @param {string} options.parameters.islevel - The level of the audio producer.
+ * @param {string} options.parameters.hostLabel - The label for 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 {boolean} options.parameters.videoAlreadyOn - Indicates if the video is already on.
+ * @param {Function} options.parameters.updateAudioProducer - Function to update the audio producer state.
+ * @param {Function} [options.parameters.updateLocalAudioProducer] - Function to update the local audio producer state.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window.
+ * @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
+ * ```typescript
+ * await resumeSendTransportAudio({
+ *   parameters: {
+ *     audioProducer: producer,
+ *     localAudioProducer: localProducer,
+ *     islevel: '1',
+ *     hostLabel: 'Host',
+ *     lock_screen: false,
+ *     shared: false,
+ *     updateAudioProducer: updateProducerFunction,
+ *     updateLocalAudioProducer: updateLocalProducerFunction,
+ *     videoAlreadyOn: false,
+ *     updateUpdateMainWindow: updateWindowFunction,
+ *     prepopulateUserMedia: prepopulateFunction,
+ *     prepopulateLocalUserMedia: prepopulateLocalFunction,
+ *   },
+ * });
+ * ```
+ */
 export declare class ResumeSendTransportAudio {
+    resumeLocalSendTransportAudio({ parameters, }: ResumeSendTransportAudioOptions): Promise<void>;
     /**
      * Resumes the send transport for audio and updates the UI and audio producer state accordingly.
      *
+     * This function supports both a primary and a local audio producer, delegating the local logic to a separate function.
+     *
      * @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.
-     * @param {string} options.parameters.hostLabel - The label of the host.
+     * @param {ResumeSendTransportAudioParameters} options.parameters - The parameters for resuming the send transport.
+     * @param {Producer} options.parameters.audioProducer - The primary audio producer to resume.
+     * @param {Producer} [options.parameters.localAudioProducer] - The local audio producer to resume.
+     * @param {string} options.parameters.islevel - The level of the audio producer.
+     * @param {string} options.parameters.hostLabel - The label for 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.updateAudioProducer - Function to update the audio producer state.
+     * @param {Function} [options.parameters.updateLocalAudioProducer] - Function to update the local audio producer state.
+     * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window.
      * @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
+     * ```typescript
+     * await resumeSendTransportAudio({
+     *   parameters: {
+     *     audioProducer: producer,
+     *     localAudioProducer: localProducer,
+     *     islevel: '1',
+     *     hostLabel: 'Host',
+     *     lock_screen: false,
+     *     shared: false,
+     *     updateAudioProducer: updateProducerFunction,
+     *     updateLocalAudioProducer: updateLocalProducerFunction,
+     *     videoAlreadyOn: false,
+     *     updateUpdateMainWindow: updateWindowFunction,
+     *     prepopulateUserMedia: prepopulateFunction,
+     *     prepopulateLocalUserMedia: prepopulateLocalFunction,
+     *   },
+     * });
+     * ```
      */
     resumeSendTransportAudio({ parameters }: ResumeSendTransportAudioOptions): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ResumeSendTransportAudio, never>;

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>;