mediasfu-shared 1.0.6 → 1.2.0

package/dist/consumers/socketReceiveMethods/newPipeProducer.d.ts

@@ -0,0 +1,119 @@
+import { Socket } from 'socket.io-client';
+import { ReorderStreamsParameters, ReorderStreamsType, SignalNewConsumerTransportParameters, ConnectRecvTransportParameters, ConnectRecvTransportType, ShowAlert } from '../../types/types';
+import { Device } from 'mediasoup-client/types';
+export interface TranslationMeta {
+    speakerId: string;
+    speakerName: string;
+    language: string;
+    originalProducerId?: string;
+    isSpeakerControlled?: boolean;
+}
+export interface NewPipeProducerParameters extends ReorderStreamsParameters, SignalNewConsumerTransportParameters, ConnectRecvTransportParameters {
+    first_round: boolean;
+    shareScreenStarted: boolean;
+    shared: boolean;
+    landScaped: boolean;
+    showAlert?: ShowAlert;
+    isWideScreen: boolean;
+    updateFirst_round: (firstRound: boolean) => void;
+    updateLandScaped: (landScaped: boolean) => void;
+    device: Device | null;
+    consumingTransports: string[];
+    lock_screen: boolean;
+    updateConsumingTransports: (transports: string[]) => void;
+    connectRecvTransport: ConnectRecvTransportType;
+    reorderStreams: ReorderStreamsType;
+    getUpdatedAllParams: () => NewPipeProducerParameters;
+    startConsumingTranslation?: (producerId: string, speakerId: string, language: string, originalProducerId?: string, nsock?: Socket) => Promise<void>;
+    translationSubscriptions?: Map<string, {
+        speakerId: string;
+        language: string;
+    }>;
+    speakerTranslationStates?: Map<string, {
+        speakerId: string;
+        speakerName: string;
+        inputLanguage: string;
+        outputLanguage: string;
+        originalProducerId: string;
+        enabled: boolean;
+    }>;
+    listenerTranslationOverrides?: Map<string, {
+        speakerId: string;
+        wantOriginal: boolean;
+        preferredLanguage?: string;
+    }>;
+    listenerTranslationPreferences?: {
+        perSpeaker: Map<string, {
+            speakerId: string;
+            language: string | null;
+            wantOriginal: boolean;
+        }>;
+        globalLanguage: string | null;
+    };
+    [key: string]: any;
+}
+export interface NewPipeProducerOptions {
+    producerId: string;
+    islevel: string;
+    nsock: Socket;
+    parameters: NewPipeProducerParameters;
+    isTranslation?: boolean;
+    translationMeta?: TranslationMeta;
+}
+export type NewPipeProducerType = (options: NewPipeProducerOptions) => Promise<void>;
+/**
+ * Handles the creation of a new pipe producer by signaling for a new consumer transport and updating the necessary parameters.
+ *
+ * @function
+ * @async
+ * @param {NewPipeProducerOptions} options - The options for the new pipe producer.
+ * @param {string} options.producerId - The ID of the producer to be consumed.
+ * @param {string} options.islevel - The level status of the participant.
+ * @param {Socket} options.nsock - The socket instance for real-time communication.
+ * @param {NewPipeProducerParameters} options.parameters - Additional parameters required for the producer.
+ * @param {boolean} options.parameters.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {boolean} options.parameters.shared - Indicates if sharing is active.
+ * @param {boolean} options.parameters.landScaped - Indicates if the device is in landscape mode.
+ * @param {ShowAlert} options.parameters.showAlert - Function to show alerts to the user.
+ * @param {boolean} options.parameters.isWideScreen - Indicates if the device is a widescreen.
+ * @param {Function} options.parameters.updateFirst_round - Function to update the first round status.
+ * @param {Function} options.parameters.updateLandScaped - Function to update the landscape status.
+ * @returns {Promise<void>} A promise that resolves when the operation is complete.
+ * @throws {Error} Will throw an error if the operation fails to signal the new consumer transport.
+ *
+ * @example
+ * import { newPipeProducer } from 'mediasfu-reactjs';
+ * import { io } from 'socket.io-client';
+ *
+ * const parameters = {
+ *   shareScreenStarted: true,
+ *   shared: true,
+ *   landScaped: false,
+ *   showAlert: (alert) => console.log(alert.message),
+ *   isWideScreen: false,
+ *   updateFirst_round: (firstRound) => console.log('First round updated:', firstRound),
+ *   updateLandScaped: (landScaped) => console.log('Landscape status updated:', landScaped),
+ * };
+ *
+ * const producerId = 'producer-123';
+ * const islevel = '2';
+ * const nsock = io("http://localhost:3000");
+ *
+ * async function init() {
+ *   try {
+ *     await newPipeProducer({
+ *       producerId,
+ *       islevel,
+ *       nsock,
+ *       parameters,
+ *     });
+ *     console.log('New pipe producer created successfully');
+ *   } catch (error) {
+ *     console.error('Error creating new pipe producer:', error);
+ *   }
+ * }
+ *
+ * init();
+ */
+export declare const newPipeProducer: ({ producerId, islevel, nsock, parameters, isTranslation, translationMeta, }: NewPipeProducerOptions) => Promise<void>;
+//# sourceMappingURL=newPipeProducer.d.ts.map

package/dist/consumers/socketReceiveMethods/newPipeProducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"newPipeProducer.d.ts","sourceRoot":"","sources":["../../../src/consumers/socketReceiveMethods/newPipeProducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,oCAAoC,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC5L,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAErD,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AACD,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB,EAAE,oCAAoC,EAAE,8BAA8B;IAE/I,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IACjD,gBAAgB,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,WAAW,EAAE,OAAO,CAAC;IACrB,yBAAyB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IAG1D,oBAAoB,EAAE,wBAAwB,CAAC;IAC/C,cAAc,EAAE,kBAAkB,CAAC;IACnC,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;IAErD,yBAAyB,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpJ,wBAAwB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAChF,wBAAwB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,kBAAkB,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAChL,4BAA4B,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrH,8BAA8B,CAAC,EAAE;QAC/B,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAAC,YAAY,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QAC/F,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAEpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,yBAAyB,CAAC;IACtC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAGD,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAGrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,eAAO,MAAM,eAAe,GAAU,6EAOnC,sBAAsB,KAAG,OAAO,CAAC,IAAI,CAoIvC,CAAC"}

package/dist/consumers/socketReceiveMethods/producerClosed.d.ts

@@ -0,0 +1,53 @@
+import { Transport, CloseAndResizeParameters, CloseAndResizeType } from '../../types/types';
+export interface ProducerClosedParameters extends CloseAndResizeParameters {
+    consumerTransports: Transport[];
+    screenId?: string;
+    updateConsumerTransports: (transports: Transport[]) => void;
+    closeAndResize: CloseAndResizeType;
+    getUpdatedAllParams: () => ProducerClosedParameters;
+    [key: string]: any;
+}
+export interface ProducerClosedOptions {
+    remoteProducerId: string;
+    parameters: ProducerClosedParameters;
+}
+export type ProducerClosedType = (options: ProducerClosedOptions) => Promise<void>;
+/**
+ * Handles the closure of a producer identified by its remote producer ID.
+ * This function will clean up the consumer transports and resize the video outputs.
+ *
+ * @function
+ * @async
+ * @param {ProducerClosedOptions} options - The options for closing the producer.
+ * @param {string} options.remoteProducerId - The ID of the remote producer to close.
+ * @param {ProducerClosedParameters} options.parameters - Additional parameters for the operation.
+ * @param {Transport[]} options.parameters.consumerTransports - The list of consumer transports associated with the producer.
+ * @param {Function} options.parameters.closeAndResize - Function to handle the closing and resizing of video streams.
+ * @param {string} [options.parameters.screenId] - The ID of the screen producer (if applicable).
+ * @param {Function} options.parameters.updateConsumerTransports - Function to update the state of consumer transports.
+ * @returns {Promise<void>} A promise that resolves when the producer has been successfully closed.
+ * @throws Will throw an error if there is an issue closing the consumer transport or the producer.
+ *
+ * @example
+ * import { producerClosed } from 'mediasfu-reactjs';
+ *
+ * const options = {
+ *   remoteProducerId: 'producerId',
+ *   parameters: {
+ *     consumerTransports: [], // Array of consumer transports
+ *     closeAndResize: (params) => console.log('Close and resize called', params),
+ *     screenId: 'screenId',
+ *     updateConsumerTransports: (transports) => console.log('Updated transports:', transports),
+ *   },
+ * };
+ *
+ * producerClosed(options)
+ *   .then(() => {
+ *     console.log('Producer closed successfully');
+ *   })
+ *   .catch((error) => {
+ *     console.error('Error closing producer:', error);
+ *   });
+ */
+export declare const producerClosed: ({ remoteProducerId, parameters, }: ProducerClosedOptions) => Promise<void>;
+//# sourceMappingURL=producerClosed.d.ts.map

package/dist/consumers/socketReceiveMethods/producerClosed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"producerClosed.d.ts","sourceRoot":"","sources":["../../../src/consumers/socketReceiveMethods/producerClosed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5F,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,kBAAkB,EAAE,SAAS,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wBAAwB,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,IAAI,CAAC;IAG5D,cAAc,EAAE,kBAAkB,CAAC;IACnC,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;IACpD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAEpB;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,wBAAwB,CAAC;CACtC;AAGD,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,cAAc,GAAU,mCAGlC,qBAAqB,KAAG,OAAO,CAAC,IAAI,CAoDtC,CAAC"}

package/dist/consumers/startShareScreen.d.ts

@@ -0,0 +1,58 @@
+import { StreamSuccessScreenType, StreamSuccessScreenParameters, ShowAlert } from '../types/types';
+export interface StartShareScreenParameters extends StreamSuccessScreenParameters {
+    shared: boolean;
+    showAlert?: ShowAlert;
+    updateShared: (shared: boolean) => void;
+    mediaDevices: MediaDevices;
+    onWeb: boolean;
+    targetWidth?: number;
+    targetHeight?: number;
+    streamSuccessScreen: StreamSuccessScreenType;
+    [key: string]: any;
+}
+export interface StartShareScreenOptions {
+    parameters: StartShareScreenParameters;
+}
+export type StartShareScreenType = (options: StartShareScreenOptions) => Promise<void>;
+/**
+ * Starts the screen sharing process.
+ *
+ * @param {StartShareScreenOptions} options - The options for starting screen sharing.
+ * @param {Object} options.parameters - The parameters for screen sharing.
+ * @param {boolean} options.parameters.shared - Indicates if the screen is currently being shared.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {Function} options.parameters.updateShared - Function to update the shared state.
+ * @param {MediaDevices} options.parameters.mediaDevices - The media devices available for screen sharing.
+ * @param {boolean} options.parameters.onWeb - Indicates if the application is running on a web platform.
+ * @param {number} [options.parameters.targetWidth] - The target width for screen sharing.
+ * @param {number} [options.parameters.targetHeight] - The target height for screen sharing.
+ * @param {Function} options.parameters.streamSuccessScreen - Function to handle successful screen sharing.
+ *
+ * @returns {Promise<void>} A promise that resolves when the screen sharing process is complete.
+ *
+ * @throws Will log an error message if there is an issue starting the screen share.
+ *
+ * @example
+ * const options = {
+ *   parameters: {
+ *     shared: false,
+ *     showAlert: showAlertFunction,
+ *     updateShared: updateSharedFunction,
+ *     mediaDevices: navigator.mediaDevices,
+ *     onWeb: true,
+ *     targetWidth: 1280,
+ *     targetHeight: 720,
+ *     streamSuccessScreen: streamSuccessFunction,
+ *   },
+ * };
+ *
+ * startShareScreen(options)
+ *   .then(() => {
+ *     console.log('Screen sharing started successfully');
+ *   })
+ *   .catch(error => {
+ *     console.error('Error starting screen share:', error);
+ *   });
+ */
+export declare function startShareScreen({ parameters }: StartShareScreenOptions): Promise<void>;
+//# sourceMappingURL=startShareScreen.d.ts.map

package/dist/consumers/startShareScreen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"startShareScreen.d.ts","sourceRoot":"","sources":["../../src/consumers/startShareScreen.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACnG,MAAM,WAAW,0BAA2B,SAAQ,6BAA6B;IAC/E,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,YAAY,EAAE,YAAY,CAAC;IAC3B,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,0BAA0B,CAAC;CACxC;AAGD,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,wBAAsB,gBAAgB,CAAC,EAAE,UAAU,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CA0D7F"}

package/dist/consumers/stopShareScreen.d.ts

@@ -0,0 +1,127 @@
+import { DisconnectSendTransportScreenType, PrepopulateUserMediaType, ReorderStreamsType, GetVideosType, DisconnectSendTransportScreenParameters, PrepopulateUserMediaParameters, ReorderStreamsParameters, EventType } from '../types/types';
+export interface StopShareScreenParameters extends DisconnectSendTransportScreenParameters, PrepopulateUserMediaParameters, ReorderStreamsParameters {
+    shared: boolean;
+    shareScreenStarted: boolean;
+    shareEnded: boolean;
+    updateMainWindow: boolean;
+    defer_receive: boolean;
+    hostLabel: string;
+    lock_screen: boolean;
+    forceFullDisplay: boolean;
+    firstAll: boolean;
+    first_round: boolean;
+    localStreamScreen: MediaStream | null;
+    eventType: EventType;
+    prevForceFullDisplay: boolean;
+    annotateScreenStream: boolean;
+    updateShared: (shared: boolean) => void;
+    updateShareScreenStarted: (shareScreenStarted: boolean) => void;
+    updateShareEnded: (shareEnded: boolean) => void;
+    updateUpdateMainWindow: (updateMainWindow: boolean) => void;
+    updateDefer_receive: (defer_receive: boolean) => void;
+    updateLock_screen: (lock_screen: boolean) => void;
+    updateForceFullDisplay: (forceFullDisplay: boolean) => void;
+    updateFirstAll: (firstAll: boolean) => void;
+    updateFirst_round: (first_round: boolean) => void;
+    updateLocalStreamScreen: (localStreamScreen: MediaStream | null) => void;
+    updateMainHeightWidth: (mainHeightWidth: number) => void;
+    updateAnnotateScreenStream: (annotateScreenStream: boolean) => void;
+    updateIsScreenboardModalVisible: (isVisible: boolean) => void;
+    disconnectSendTransportScreen: DisconnectSendTransportScreenType;
+    prepopulateUserMedia: PrepopulateUserMediaType;
+    reorderStreams: ReorderStreamsType;
+    getVideos: GetVideosType;
+    getUpdatedAllParams: () => StopShareScreenParameters;
+    [key: string]: any;
+}
+export interface StopShareScreenOptions {
+    parameters: StopShareScreenParameters;
+}
+export type StopShareScreenType = (options: StopShareScreenOptions) => Promise<void>;
+/**
+ * Stops the screen sharing process and updates the relevant parameters and states.
+ *
+ * @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.
+ * @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.
+ *
+ * @example
+ * const options = {
+ *   parameters: {
+ *     shared: true,
+ *     shareScreenStarted: true,
+ *     shareEnded: false,
+ *     updateMainWindow: true,
+ *     defer_receive: false,
+ *     hostLabel: "Host",
+ *     lock_screen: false,
+ *     forceFullDisplay: false,
+ *     firstAll: false,
+ *     first_round: false,
+ *     localStreamScreen: localStream, // MediaStream object
+ *     eventType: "conference",
+ *     prevForceFullDisplay: false,
+ *     annotateScreenStream: false,
+ *     updateShared: updateSharedFunction,
+ *     updateShareScreenStarted: updateShareScreenStartedFunction,
+ *     updateShareEnded: updateShareEndedFunction,
+ *     updateUpdateMainWindow: updateUpdateMainWindowFunction,
+ *     updateDefer_receive: updateDefer_receiveFunction,
+ *     updateLock_screen: updateLock_screenFunction,
+ *     updateForceFullDisplay: updateForceFullDisplayFunction,
+ *     updateFirstAll: updateFirstAllFunction,
+ *     updateFirst_round: updateFirst_roundFunction,
+ *     updateLocalStreamScreen: updateLocalStreamScreenFunction,
+ *     updateMainHeightWidth: updateMainHeightWidthFunction,
+ *     updateAnnotateScreenStream: updateAnnotateScreenStreamFunction,
+ *     updateIsScreenboardModalVisible: updateIsScreenboardModalVisibleFunction,
+ *     disconnectSendTransportScreen: disconnectSendTransportScreenFunction,
+ *     prepopulateUserMedia: prepopulateUserMediaFunction,
+ *     reorderStreams: reorderStreamsFunction,
+ *     getVideos: getVideosFunction,
+ *   },
+ * };
+ *
+ * stopShareScreen(options)
+ *   .then(() => {
+ *     console.log('Screen sharing stopped successfully');
+ *   })
+ *   .catch(error => {
+ *     console.error('Error stopping screen share:', error);
+ *   });
+ */
+export declare function stopShareScreen({ parameters }: StopShareScreenOptions): Promise<void>;
+//# sourceMappingURL=stopShareScreen.d.ts.map

package/dist/consumers/stopShareScreen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stopShareScreen.d.ts","sourceRoot":"","sources":["../../src/consumers/stopShareScreen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,aAAa,EAAE,uCAAuC,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC9O,MAAM,WAAW,yBAA0B,SAAQ,uCAAuC,EAAE,8BAA8B,EAAE,wBAAwB;IAClJ,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,WAAW,GAAG,IAAI,CAAC;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,oBAAoB,EAAE,OAAO,CAAC;IAE9B,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,wBAAwB,EAAE,CAAC,kBAAkB,EAAE,OAAO,KAAK,IAAI,CAAC;IAChE,gBAAgB,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5D,mBAAmB,EAAE,CAAC,aAAa,EAAE,OAAO,KAAK,IAAI,CAAC;IACtD,iBAAiB,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5D,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5C,iBAAiB,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,uBAAuB,EAAE,CAAC,iBAAiB,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IACzE,qBAAqB,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,0BAA0B,EAAE,CAAC,oBAAoB,EAAE,OAAO,KAAK,IAAI,CAAC;IACpE,+BAA+B,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAG9D,6BAA6B,EAAE,iCAAiC,CAAC;IACjE,oBAAoB,EAAE,wBAAwB,CAAC;IAC/C,cAAc,EAAE,kBAAkB,CAAC;IACnC,SAAS,EAAE,aAAa,CAAC;IAEzB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;IACrD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,yBAAyB,CAAC;CACvC;AAGD,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG;AAEH,wBAAsB,eAAe,CAAC,EAAE,UAAU,EAAE,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyG3F"}

package/dist/consumers/streamSuccessAudio.d.ts

@@ -0,0 +1,149 @@
+import { Socket } from 'socket.io-client';
+import { ProducerOptions } from 'mediasoup-client/types';
+import { Participant, PrepopulateUserMediaParameters, ShowAlert, CreateSendTransportParameters, ConnectSendTransportAudioParameters, ResumeSendTransportAudioParameters, PrepopulateUserMediaType, CreateSendTransportType, ConnectSendTransportAudioType, ResumeSendTransportAudioType } from '../types/types';
+export interface StreamSuccessAudioParameters extends CreateSendTransportParameters, ConnectSendTransportAudioParameters, ResumeSendTransportAudioParameters, PrepopulateUserMediaParameters {
+    socket: Socket;
+    participants: Participant[];
+    localStream: MediaStream | null;
+    transportCreated: boolean;
+    transportCreatedAudio: boolean;
+    audioAlreadyOn: boolean;
+    micAction: boolean;
+    audioParams: ProducerOptions;
+    localStreamAudio: MediaStream | null;
+    defAudioID: string;
+    userDefaultAudioInputDevice: string;
+    params: ProducerOptions;
+    audioParamse?: ProducerOptions;
+    aParams: ProducerOptions;
+    hostLabel: string;
+    islevel: string;
+    member: string;
+    updateMainWindow: boolean;
+    lock_screen: boolean;
+    shared: boolean;
+    videoAlreadyOn: boolean;
+    showAlert?: ShowAlert;
+    updateParticipants: (participants: Participant[]) => void;
+    updateTransportCreated: (transportCreated: boolean) => void;
+    updateTransportCreatedAudio: (transportCreatedAudio: boolean) => void;
+    updateAudioAlreadyOn: (audioAlreadyOn: boolean) => void;
+    updateMicAction: (micAction: boolean) => void;
+    updateAudioParams: (audioParams: ProducerOptions) => void;
+    updateLocalStream: (localStream: MediaStream | null) => void;
+    updateLocalStreamAudio: (localStreamAudio: MediaStream | null) => void;
+    updateDefAudioID: (defAudioID: string) => void;
+    updateUserDefaultAudioInputDevice: (userDefaultAudioInputDevice: string) => void;
+    updateUpdateMainWindow: (updateMainWindow: boolean) => void;
+    createSendTransport: CreateSendTransportType;
+    connectSendTransportAudio: ConnectSendTransportAudioType;
+    resumeSendTransportAudio: ResumeSendTransportAudioType;
+    prepopulateUserMedia: PrepopulateUserMediaType;
+    getUpdatedAllParams: () => StreamSuccessAudioParameters;
+    [key: string]: any;
+}
+export interface StreamSuccessAudioOptions {
+    stream: MediaStream;
+    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.
+ *
+ * @param {StreamSuccessAudioOptions} options - The options for streaming success audio.
+ * @param {MediaStream} options.stream - The media stream containing the audio track.
+ * @param {Object} options.parameters - The parameters required for setting up the audio stream.
+ * @param {Socket} options.parameters.socket - The socket connection for communication.
+ * @param {Array<Participant>} options.parameters.participants - The list of participants.
+ * @param {MediaStream | null} options.parameters.localStream - The local media stream.
+ * @param {boolean} options.parameters.transportCreated - Flag indicating if the transport is created.
+ * @param {boolean} options.parameters.transportCreatedAudio - Flag indicating if the audio transport is created.
+ * @param {boolean} options.parameters.audioAlreadyOn - Flag indicating if the audio is already on.
+ * @param {boolean} options.parameters.micAction - Flag indicating the microphone action.
+ * @param {ProducerOptions} options.parameters.audioParams - The audio parameters.
+ * @param {MediaStream | null} options.parameters.localStreamAudio - The local audio stream.
+ * @param {string} options.parameters.defAudioID - The default audio device ID.
+ * @param {string} options.parameters.userDefaultAudioInputDevice - The user default audio input device.
+ * @param {ProducerOptions} options.parameters.params - Additional parameters.
+ * @param {ProducerOptions} options.parameters.audioParamse - Additional audio parameters.
+ * @param {ProducerOptions} options.parameters.aParams - Additional parameters for audio.
+ * @param {string} options.parameters.hostLabel - The label of the host.
+ * @param {string} options.parameters.islevel - The level of the user.
+ * @param {string} options.parameters.member - The member name.
+ * @param {boolean} options.parameters.updateMainWindow - Flag indicating if the main window should be updated.
+ * @param {boolean} options.parameters.lock_screen - Flag indicating if the screen is locked.
+ * @param {boolean} options.parameters.shared - Flag indicating if the screen is shared.
+ * @param {boolean} options.parameters.videoAlreadyOn - Flag indicating if the video is already on.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {Function} options.parameters.updateParticipants - Function to update participants.
+ * @param {Function} options.parameters.updateTransportCreated - Function to update transport created flag.
+ * @param {Function} options.parameters.updateTransportCreatedAudio - Function to update audio transport created flag.
+ * @param {Function} options.parameters.updateAudioAlreadyOn - Function to update audio already on flag.
+ * @param {Function} options.parameters.updateMicAction - Function to update microphone action flag.
+ * @param {Function} options.parameters.updateAudioParams - Function to update audio parameters.
+ * @param {Function} options.parameters.updateLocalStream - Function to update local stream.
+ * @param {Function} options.parameters.updateLocalStreamAudio - Function to update local audio stream.
+ * @param {Function} options.parameters.updateDefAudioID - Function to update default audio device ID.
+ * @param {Function} options.parameters.updateUserDefaultAudioInputDevice - Function to update user default audio input device.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update main window flag.
+ * @param {Function} options.parameters.createSendTransport - Function to create send transport.
+ * @param {Function} options.parameters.connectSendTransportAudio - Function to connect send transport audio.
+ * @param {Function} options.parameters.resumeSendTransportAudio - Function to resume send transport audio.
+ * @param {Function} options.parameters.prepopulateUserMedia - Function to prepopulate user media.
+ *
+ * @returns {Promise<void>} A promise that resolves when the audio streaming setup is complete.
+ *
+ * @example
+ * const options = {
+ *   stream: localStream, // MediaStream object containing the audio track
+ *   parameters: {
+ *     socket: socketInstance,
+ *     participants: participantList,
+ *     localStream: null,
+ *     transportCreated: false,
+ *     transportCreatedAudio: false,
+ *     audioAlreadyOn: false,
+ *     micAction: false,
+ *     audioParams: {},
+ *     localStreamAudio: null,
+ *     defAudioID: "",
+ *     userDefaultAudioInputDevice: "",
+ *     params: {},
+ *     audioParamse: {},
+ *     aParams: {},
+ *     hostLabel: "Host",
+ *     islevel: "1",
+ *     member: "user1",
+ *     updateMainWindow: true,
+ *     lock_screen: false,
+ *     shared: false,
+ *     videoAlreadyOn: false,
+ *     showAlert: alertFunction,
+ *     updateParticipants: updateParticipantsFunction,
+ *     updateTransportCreated: updateTransportCreatedFunction,
+ *     updateTransportCreatedAudio: updateTransportCreatedAudioFunction,
+ *     updateAudioAlreadyOn: updateAudioAlreadyOnFunction,
+ *     updateMicAction: updateMicActionFunction,
+ *     updateAudioParams: updateAudioParamsFunction,
+ *     updateLocalStream: updateLocalStreamFunction,
+ *     updateLocalStreamAudio: updateLocalStreamAudioFunction,
+ *     updateDefAudioID: updateDefAudioIDFunction,
+ *     updateUserDefaultAudioInputDevice: updateUserDefaultAudioInputDeviceFunction,
+ *     updateUpdateMainWindow: updateUpdateMainWindowFunction,
+ *     createSendTransport: createSendTransportFunction,
+ *     connectSendTransportAudio: connectSendTransportAudioFunction,
+ *     resumeSendTransportAudio: resumeSendTransportAudioFunction,
+ *     prepopulateUserMedia: prepopulateUserMediaFunction,
+ *   },
+ * };
+ *
+ * streamSuccessAudio(options)
+ *   .then(() => {
+ *     console.log('Audio streaming setup successfully');
+ *   })
+ *   .catch(error => {
+ *     console.error('Error setting up audio streaming:', error);
+ *   });
+ */
+export declare const streamSuccessAudio: ({ stream, parameters, }: StreamSuccessAudioOptions) => Promise<void>;
+//# sourceMappingURL=streamSuccessAudio.d.ts.map

package/dist/consumers/streamSuccessAudio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamSuccessAudio.d.ts","sourceRoot":"","sources":["../../src/consumers/streamSuccessAudio.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,8BAA8B,EAAE,SAAS,EAAE,6BAA6B,EAAE,mCAAmC,EAAE,kCAAkC,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AAChT,MAAM,WAAW,4BAA6B,SAAQ,6BAA6B,EAAE,mCAAmC,EAAE,kCAAkC,EAAE,8BAA8B;IAC1L,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,eAAe,CAAC;IAC7B,gBAAgB,EAAE,WAAW,GAAG,IAAI,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B,EAAE,MAAM,CAAC;IACpC,MAAM,EAAE,eAAe,CAAC;IACxB,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,kBAAkB,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;IAC1D,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5D,2BAA2B,EAAE,CAAC,qBAAqB,EAAE,OAAO,KAAK,IAAI,CAAC;IACtE,oBAAoB,EAAE,CAAC,cAAc,EAAE,OAAO,KAAK,IAAI,CAAC;IACxD,eAAe,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IAC9C,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,CAAC;IAC1D,iBAAiB,EAAE,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IAC7D,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IACvE,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,iCAAiC,EAAE,CAAC,2BAA2B,EAAE,MAAM,KAAK,IAAI,CAAC;IACjF,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAC;IAG5D,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,yBAAyB,EAAE,6BAA6B,CAAC;IACzD,wBAAwB,EAAE,4BAA4B,CAAC;IACvD,oBAAoB,EAAE,wBAAwB,CAAC;IAE/C,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;IACxD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiGG;AAEH,eAAO,MAAM,kBAAkB,GAAU,yBAGtC,yBAAyB,KAAG,OAAO,CAAC,IAAI,CAsI1C,CAAC"}