mediasfu-angular 1.0.0 → 1.0.2

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.

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

@@ -16,6 +16,39 @@ export interface SwitchUserAudioOptions {
     parameters: SwitchUserAudioParameters;
 }
 export type SwitchUserAudioType = (options: SwitchUserAudioOptions) => Promise<void>;
+/**
+ * Switches the user's audio input device based on the provided audio preference.
+ *
+ * This method checks for audio permissions, attempts to access the specified audio input device,
+ * and updates the application's state accordingly. If the audio input device cannot be accessed,
+ * it will revert to the previous audio input device.
+ *
+ * @param {SwitchUserAudioOptions} options - The options for switching the user's audio input device.
+ * @param {string} options.audioPreference - The preferred audio input device ID.
+ * @param {SwitchUserAudioParameters} options.parameters - Additional parameters required for switching the audio input device.
+ * @param {string} options.parameters.prevAudioInputDevice - The previous audio input device ID.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {boolean} options.parameters.hasAudioPermission - Flag indicating if the user has granted audio permission.
+ * @param {Function} options.parameters.updateUserDefaultAudioInputDevice - Function to update the user's default audio input device.
+ * @param {Function} options.parameters.streamSuccessAudioSwitch - Function to handle successful audio stream switch.
+ * @param {Function} options.parameters.requestPermissionAudio - Function to request audio permission from the user.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check if media permission is granted.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio input device has been successfully switched.
+ *
+ * @throws Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.
+ *
+ * @example
+ * await switchUserAudio({
+ *   audioPreference: 'new-audio-device-id',
+ *   parameters: {
+ *     prevAudioInputDevice: 'previous-device-id',
+ *     hasAudioPermission: true,
+ *     updateUserDefaultAudioInputDevice: updateDeviceFunction,
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class SwitchUserAudio {
     /**
      * Switches the user's audio input device based on the provided audio preference.

package/dist/lib/consumers/switch-user-video-alt.service.d.ts

@@ -22,6 +22,38 @@ export interface SwitchUserVideoAltOptions {
     parameters: SwitchUserVideoAltParameters;
 }
 export type SwitchUserVideoAltType = (options: SwitchUserVideoAltOptions) => Promise<void>;
+/**
+ * Switches the user's video stream based on the provided video preference and other parameters.
+ *
+ * This method manages the process of switching the user's video input device,
+ * checking permissions, and updating the relevant application state.
+ * If the specified device is not accessible, it attempts to find an alternative.
+ *
+ * @param {SwitchUserVideoAltOptions} options - The options for switching the user's video.
+ * @param {string} options.videoPreference - The preferred video input device ID.
+ * @param {boolean} options.checkoff - A flag indicating whether to turn off the video before switching.
+ * @param {SwitchUserVideoAltParameters} options.parameters - The parameters required for switching the video.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages to the user.
+ * @param {boolean} options.parameters.hasCameraPermission - Flag indicating if the user has granted camera permission.
+ * @param {Function} options.parameters.updateVideoSwitching - Function to update the video switching state.
+ * @param {Function} options.parameters.requestPermissionCamera - Function to request camera permission from the user.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check if media permissions are granted.
+ *
+ * @returns {Promise<void>} A promise that resolves when the video switching is complete.
+ *
+ * @throws Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.
+ *
+ * @example
+ * await switchUserVideoAlt({
+ *   videoPreference: 'user',
+ *   checkoff: false,
+ *   parameters: {
+ *     hasCameraPermission: true,
+ *     updateVideoSwitching: (state) => { /* update state *\/ },
+ *     // other parameters...
+ *   },
+ * });
+ */
 export declare class SwitchUserVideoAlt {
     private ClickVideoService;
     constructor(ClickVideoService: ClickVideo);

package/dist/lib/consumers/switch-user-video.service.d.ts

@@ -24,6 +24,53 @@ export interface SwitchUserVideoOptions {
     parameters: SwitchUserVideoParameters;
 }
 export type SwitchUserVideoType = (options: SwitchUserVideoOptions) => Promise<void>;
+/**
+ * Switches the user's video input device based on the provided options.
+ *
+ * This method checks permissions, enumerates available devices, and updates the
+ * video stream based on user preferences. It also manages UI updates and alerts.
+ *
+ * @param {SwitchUserVideoOptions} options - The options for switching the user's video.
+ * @param {string} options.videoPreference - The preferred video input device ID.
+ * @param {boolean} options.checkoff - Flag indicating whether to turn off the video.
+ * @param {SwitchUserVideoParameters} options.parameters - Additional parameters required for switching the video.
+ * @param {boolean} options.parameters.audioOnlyRoom - Indicates if the room is audio-only.
+ * @param {number} options.parameters.frameRate - The desired frame rate for the video.
+ * @param {Object} options.parameters.vidCons - Video constraints such as width and height.
+ * @param {string} options.parameters.prevVideoInputDevice - The previous video input device ID.
+ * @param {Function} options.parameters.showAlert - Function to show alerts to the user.
+ * @param {boolean} options.parameters.hasCameraPermission - Indicates if the user has camera permission.
+ * @param {Function} options.parameters.updateVideoSwitching - Function to update video switching state.
+ * @param {Function} options.parameters.updateUserDefaultVideoInputDevice - Function to update the default video input device.
+ * @param {Function} options.parameters.requestPermissionCamera - Function to request camera permission.
+ * @param {Function} options.parameters.streamSuccessVideo - Function to handle successful video stream.
+ * @param {Function} options.parameters.sleep - Function to pause execution for a specified duration.
+ * @param {Function} options.parameters.checkMediaPermission - Function to check media permissions.
+ *
+ * @returns {Promise<void>} A promise that resolves when the video input device has been successfully switched.
+ *
+ * @throws {Error} Throws an error if switching the video input device fails.
+ *
+ * @example
+ * await switchUserVideo({
+ *   videoPreference: 'user',
+ *   checkoff: false,
+ *   parameters: {
+ *     audioOnlyRoom: false,
+ *     frameRate: 30,
+ *     vidCons: { width: 1280, height: 720 },
+ *     prevVideoInputDevice: 'device-id',
+ *     showAlert: myShowAlertFunction,
+ *     hasCameraPermission: true,
+ *     updateVideoSwitching: myUpdateFunction,
+ *     updateUserDefaultVideoInputDevice: myUpdateFunction,
+ *     requestPermissionCamera: myRequestPermissionFunction,
+ *     streamSuccessVideo: myStreamSuccessFunction,
+ *     sleep: mySleepFunction,
+ *     checkMediaPermission: true,
+ *   },
+ * });
+ */
 export declare class SwitchUserVideo {
     private ClickVideoService;
     constructor(ClickVideoService: ClickVideo);

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

@@ -26,6 +26,44 @@ export interface TriggerOptions {
     parameters: TriggerParameters;
 }
 export type TriggerType = (options: TriggerOptions) => Promise<void>;
+/**
+ * Triggers an update to the screen client based on the provided parameters.
+ *
+ * This function handles various conditions to determine the main screen person,
+ * adjusts the screen states, and emits an update to the screen client via socket.
+ *
+ * @param {TriggerOptions} options - The options for triggering the update.
+ * @param {string[]} options.ref_ActiveNames - Reference to the active names.
+ * @param {TriggerParameters} options.parameters - The parameters for the trigger.
+ * @returns {Promise<void>} A promise that resolves when the trigger is complete.
+ *
+ * @throws Will throw an error if the updateScreenClient operation fails.
+ *
+ * @example
+ * ```typescript
+ * await trigger({
+ *   ref_ActiveNames: ["user1", "user2"],
+ *   parameters: {
+ *     socket: socketInstance,
+ *     roomName: "room1",
+ *     screenStates: [{ mainScreenPerson: "user1", mainScreenFilled: true, adminOnMainScreen: false }],
+ *     participants: [{ name: "admin", islevel: "2" }],
+ *     updateDateState: 0,
+ *     lastUpdate: null,
+ *     nForReadjust: 0,
+ *     eventType: "conference",
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     whiteboardStarted: false,
+ *     whiteboardEnded: false,
+ *     updateUpdateDateState: (date) => {},
+ *     updateLastUpdate: (date) => {},
+ *     updateNForReadjust: (n) => {},
+ *     autoAdjust: async ({ n, parameters }) => [n, 0],
+ *   },
+ * });
+ * ```
+ */
 export declare class Trigger {
     /**
      * Triggers an update to the screen client based on the provided parameters.

package/dist/lib/consumers/update-mini-cards-grid.service.d.ts

@@ -23,6 +23,60 @@ export interface UpdateMiniCardsGridOptions {
     parameters: UpdateMiniCardsGridParameters;
 }
 export type UpdateMiniCardsGridType = (options: UpdateMiniCardsGridOptions) => Promise<void>;
+/**
+ * Updates the mini cards grid based on the specified rows and columns.
+ *
+ * This method calculates the dimensions for the mini cards based on the provided
+ * rows and columns, as well as the container sizes. It also considers pagination
+ * settings and updates the grid sizes accordingly. The method can update either
+ * the default grid or an alternative grid based on the `defal` parameter.
+ *
+ * @param {UpdateMiniCardsGridOptions} options - The options for updating the mini cards grid.
+ * @param {number} options.rows - The number of rows in the grid.
+ * @param {number} options.cols - The number of columns in the grid.
+ * @param {boolean} [options.defal=true] - Flag indicating whether to update the default grid or an alternative grid.
+ * @param {number} [options.actualRows=2] - The actual number of rows in the grid.
+ * @param {UpdateMiniCardsGridParameters} options.parameters - Additional parameters needed for the function.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Function} options.parameters.updateGridRows - Function to update the grid rows.
+ * @param {Function} options.parameters.updateGridCols - Function to update the grid columns.
+ * @param {Function} options.parameters.updateAltGridRows - Function to update the alternative grid rows.
+ * @param {Function} options.parameters.updateAltGridCols - Function to update the alternative grid columns.
+ * @param {Function} options.parameters.updateGridSizes - Function to update the grid sizes.
+ * @param {GridSizes} options.parameters.gridSizes - Object containing grid width and height.
+ * @param {string} options.parameters.paginationDirection - The direction of pagination ('horizontal' or 'vertical').
+ * @param {number} options.parameters.paginationHeightWidth - The height or width of pagination.
+ * @param {boolean} options.parameters.doPaginate - Flag indicating whether pagination is enabled.
+ * @param {ComponentSizes} options.parameters.componentSizes - Object containing container width and height.
+ * @param {EventType} options.parameters.eventType - The type of event ('chat', etc.).
+ *
+ * @returns {Promise<void>} - A Promise that resolves after updating the mini cards grid.
+ *
+ * @example
+ * ```typescript
+ * const gridOptions = {
+ *   rows: 3,
+ *   cols: 4,
+ *   parameters: {
+ *     getUpdatedAllParams: () => updatedParams,
+ *     updateGridRows: (rows) => console.log(`Grid Rows Updated: ${rows}`),
+ *     updateGridCols: (cols) => console.log(`Grid Cols Updated: ${cols}`),
+ *     updateAltGridRows: (rows) => console.log(`Alt Grid Rows Updated: ${rows}`),
+ *     updateAltGridCols: (cols) => console.log(`Alt Grid Cols Updated: ${cols}`),
+ *     updateGridSizes: (sizes) => console.log(`Grid Sizes Updated: ${JSON.stringify(sizes)}`),
+ *     gridSizes: { gridWidth: 100, gridHeight: 100 },
+ *     paginationDirection: 'horizontal',
+ *     paginationHeightWidth: 50,
+ *     doPaginate: true,
+ *     componentSizes: { otherWidth: 800, otherHeight: 600 },
+ *     eventType: 'chat',
+ *   },
+ * };
+ *
+ * const miniCardGridService = new UpdateMiniCardsGrid();
+ * miniCardGridService.updateMiniCardsGrid(gridOptions);
+ * ```
+ */
 export declare class UpdateMiniCardsGrid {
     /**
      * Updates the mini cards grid based on the specified rows and columns.

package/dist/lib/consumers/update-participant-audio-decibels.service.d.ts

@@ -7,6 +7,51 @@ export interface UpdateParticipantAudioDecibelsOptions {
     updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
 }
 export type UpdateParticipantAudioDecibelsType = (options: UpdateParticipantAudioDecibelsOptions) => void;
+/**
+ * Updates or adds a participant's audio decibel data in the array.
+ *
+ * This method checks if a participant's name exists in the audio decibels array.
+ * If it does, it updates the participant's `averageLoudness`; otherwise, it adds a new entry.
+ * After modification, it calls `updateAudioDecibels` to apply the changes to the array.
+ *
+ * @param {UpdateParticipantAudioDecibelsOptions} options - The options for updating participant audio decibels.
+ * @param {string} options.name - The name of the participant.
+ * @param {number} options.averageLoudness - The current average loudness of the participant.
+ * @param {AudioDecibels[]} options.audioDecibels - The array of current audio decibel entries.
+ * @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
+ *
+ * @returns {void} - This function does not return a value.
+ *
+ * @example
+ * ```typescript
+ * const audioDecibels = [
+ *   { name: 'Alice', averageLoudness: -10 },
+ *   { name: 'Bob', averageLoudness: -12 },
+ * ];
+ *
+ * const updateAudioDecibels = (newDecibels) => {
+ *   console.log('Updated audio decibels:', newDecibels);
+ * };
+ *
+ * const updateService = new UpdateParticipantAudioDecibels();
+ *
+ * // Update existing participant
+ * updateService.updateParticipantAudioDecibels({
+ *   name: 'Alice',
+ *   averageLoudness: -8,
+ *   audioDecibels,
+ *   updateAudioDecibels,
+ * });
+ *
+ * // Add a new participant
+ * updateService.updateParticipantAudioDecibels({
+ *   name: 'Charlie',
+ *   averageLoudness: -15,
+ *   audioDecibels,
+ *   updateAudioDecibels,
+ * });
+ * ```
+ */
 export declare class UpdateParticipantAudioDecibels {
     /**
      * Updates the audio decibels for a participant.

package/dist/lib/methods/background-methods/launch-background.service.d.ts

@@ -4,6 +4,31 @@ export interface LaunchBackgroundOptions {
     isBackgroundModalVisible: boolean;
 }
 export type LaunchBackgroundType = (options: LaunchBackgroundOptions) => void;
+/**
+ * Toggles the visibility of the background modal.
+ *
+ * This method updates the visibility state of the background modal by calling
+ * the provided update function with the negation of the current visibility state.
+ *
+ * @param {LaunchBackgroundOptions} options - The options object containing necessary variables and functions.
+ * @param {Function} options.updateIsBackgroundModalVisible - Function to update the visibility state of the background modal.
+ * @param {boolean} options.isBackgroundModalVisible - Current visibility state of the background modal.
+ *
+ * @returns {void}
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   updateIsBackgroundModalVisible: (isVisible) => {
+ *     console.log(`Background modal is now ${isVisible ? 'visible' : 'hidden'}.`);
+ *   },
+ *   isBackgroundModalVisible: false,
+ * };
+ *
+ * const launchBackgroundService = new LaunchBackground();
+ * launchBackgroundService.launchBackground(options);
+ * ```
+ */
 export declare class LaunchBackground {
     /**
      * Toggles the visibility of the background modal.