mediasfu-shared 1.0.6 → 1.2.0

package/dist/consumers/receiveAllPipedTransports.d.ts

@@ -0,0 +1,44 @@
+import { Socket } from 'socket.io-client';
+import { GetPipedProducersAltType, GetPipedProducersAltParameters } from '../types/types';
+export interface ReceiveAllPipedTransportsParameters extends GetPipedProducersAltParameters {
+    roomName: string;
+    member: string;
+    getPipedProducersAlt: GetPipedProducersAltType;
+    [key: string]: any;
+}
+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.
+ *
+ * @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 {Function} 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
+ * await receiveAllPipedTransports({
+ *   nsock: socketInstance,
+ *   community: false,
+ *   parameters: {
+ *     roomName: 'Room1',
+ *     member: 'Member1',
+ *     getPipedProducersAlt: getPipedProducersAltFunction,
+ *   },
+ * });
+ * ```
+ */
+export declare const receiveAllPipedTransports: ({ nsock, community, parameters }: ReceiveAllPipedTransportsOptions) => Promise<void>;
+//# sourceMappingURL=receiveAllPipedTransports.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"receiveAllPipedTransports.d.ts","sourceRoot":"","sources":["../../src/consumers/receiveAllPipedTransports.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,wBAAwB,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAE1F,MAAM,WAAW,mCAAoC,SAAQ,8BAA8B;IACzF,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IAGf,oBAAoB,EAAE,wBAAwB,CAAC;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,gCAAgC;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,mCAAmC,CAAC;CACjD;AAGD,MAAM,MAAM,6BAA6B,GAAG,CAAC,OAAO,EAAE,gCAAgC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,eAAO,MAAM,yBAAyB,GAAU,kCAAwC,gCAAgC,KAAG,OAAO,CAAC,IAAI,CAyBtI,CAAC"}

package/dist/consumers/receiveRoomMessages.d.ts

@@ -0,0 +1,31 @@
+import { Socket } from 'socket.io-client';
+import { Message } from '../types/types';
+export interface ReceiveRoomMessagesOptions {
+    socket: Socket;
+    roomName: string;
+    updateMessages: (messages: Message[]) => void;
+}
+export type ReceiveRoomMessagesType = (options: ReceiveRoomMessagesOptions) => Promise<void>;
+/**
+ * Retrieves messages from a specified room and updates the message state.
+ *
+ * @param {ReceiveRoomMessagesOptions} options - The options for receiving room messages.
+ * @param {Socket} options.socket - The socket instance used for communication.
+ * @param {string} options.roomName - The name of the room from which to retrieve messages.
+ * @param {Function} options.updateMessages - Function to update the state with retrieved messages.
+ *
+ * @returns {Promise<void>} A promise that resolves when the messages have been retrieved and updated.
+ *
+ * @throws Will log an error message if there is an issue retrieving the messages.
+ *
+ * @example
+ * ```typescript
+ * await receiveRoomMessages({
+ *   socket: socketInstance,
+ *   roomName: 'Room1',
+ *   updateMessages: (messages) => console.log(messages),
+ * });
+ * ```
+ */
+export declare function receiveRoomMessages({ socket, roomName, updateMessages, }: ReceiveRoomMessagesOptions): Promise<void>;
+//# sourceMappingURL=receiveRoomMessages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"receiveRoomMessages.d.ts","sourceRoot":"","sources":["../../src/consumers/receiveRoomMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CAC/C;AAGD,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE7F;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EACN,QAAQ,EACR,cAAc,GACf,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAe5C"}

package/dist/consumers/reorderStreams.d.ts

@@ -0,0 +1,98 @@
+import { Participant, Stream } from '../types/types';
+interface ReorderStreamLike {
+    producerId?: string | null;
+}
+interface ReorderParticipantLike {
+    name: string;
+    islevel?: string | null;
+    videoID?: string | null;
+    ScreenID?: string | null;
+}
+type ChangeVidsInvoker = (options: {
+    screenChanged?: boolean;
+    parameters: any;
+}) => Promise<void>;
+type StreamCollectionUpdater<TEntry> = {
+    bivarianceHack: (streams: TEntry[]) => void;
+}["bivarianceHack"];
+export interface ReorderStreamsParameters<TStream extends ReorderStreamLike = Stream, TParticipant extends ReorderParticipantLike = Participant, TChangeVidsParameters = unknown> {
+    allVideoStreams: (TStream | TParticipant)[];
+    participants: TParticipant[];
+    oldAllStreams: (TStream | TParticipant)[];
+    screenId?: string;
+    adminVidID?: string;
+    newLimitedStreams: (TStream | TParticipant)[];
+    newLimitedStreamsIDs: string[];
+    activeSounds: string[];
+    screenShareIDStream?: string;
+    screenShareNameStream?: string;
+    adminIDStream?: string;
+    adminNameStream?: string;
+    updateNewLimitedStreams: StreamCollectionUpdater<TStream | TParticipant>;
+    updateNewLimitedStreamsIDs: (ids: string[]) => void;
+    updateActiveSounds: (sounds: string[]) => void;
+    updateScreenShareIDStream: (id: string) => void;
+    updateScreenShareNameStream: (name: string) => void;
+    updateAdminIDStream: (id: string) => void;
+    updateAdminNameStream: (name: string) => void;
+    updateYouYouStream: StreamCollectionUpdater<TStream | TParticipant>;
+    changeVids: ChangeVidsInvoker;
+    getUpdatedAllParams: () => ReorderStreamsParameters<TStream, TParticipant, TChangeVidsParameters>;
+    [key: string]: any;
+}
+export interface ReorderStreamsOptions<TParameters extends ReorderStreamsParameters<any, any, any> = ReorderStreamsParameters> {
+    add?: boolean;
+    screenChanged?: boolean;
+    parameters: TParameters;
+}
+export type ReorderStreamsType = <TParameters extends ReorderStreamsParameters<any, any, any> = ReorderStreamsParameters>(options: ReorderStreamsOptions<TParameters>) => Promise<void>;
+/**
+ * Reorders the video streams based on the provided options and updates the UI accordingly.
+ *
+ * @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 {Object} options.parameters - The parameters required for reordering streams.
+ * @param {Function} options.parameters.getUpdatedAllParams - Function to get updated parameters.
+ * @param {Array} options.parameters.allVideoStreams - Array of all video streams.
+ * @param {Array} options.parameters.participants - Array of participants.
+ * @param {Array} 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} options.parameters.newLimitedStreams - Array of new limited streams.
+ * @param {Array} options.parameters.newLimitedStreamsIDs - Array of new limited stream IDs.
+ * @param {Array} 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 {Error} Throws an error if there is an issue updating the streams.
+ *
+ * @example
+ * ```typescript
+ * await reorderStreams({
+ *   add: true,
+ *   screenChanged: false,
+ *   parameters: {
+ *     allVideoStreams: [...],
+ *     participants: [...],
+ *     // additional parameters...
+ *   },
+ * });
+ * ```
+ */
+export declare const reorderStreams: <TParameters extends ReorderStreamsParameters<any, any, any> = ReorderStreamsParameters>({ add, screenChanged, parameters, }: ReorderStreamsOptions<TParameters>) => Promise<void>;
+export {};
+//# sourceMappingURL=reorderStreams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reorderStreams.d.ts","sourceRoot":"","sources":["../../src/consumers/reorderStreams.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAErD,UAAU,iBAAiB;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,KAAK,iBAAiB,GAAG,CAAC,OAAO,EAAE;IACjC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,GAAG,CAAC;CACjB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEpB,KAAK,uBAAuB,CAAC,MAAM,IAAI;IACrC,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;CAC7C,CAAC,gBAAgB,CAAC,CAAC;AAMpB,MAAM,WAAW,wBAAwB,CACvC,OAAO,SAAS,iBAAiB,GAAG,MAAM,EAC1C,YAAY,SAAS,sBAAsB,GAAG,WAAW,EACzD,qBAAqB,GAAG,OAAO;IAE/B,eAAe,EAAE,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,CAAC;IAC5C,YAAY,EAAE,YAAY,EAAE,CAAC;IAC7B,aAAa,EAAE,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,CAAC;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,CAAC;IAC9C,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,EAAE,uBAAuB,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC;IACzE,0BAA0B,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACpD,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IAC/C,yBAAyB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,2BAA2B,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,qBAAqB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,kBAAkB,EAAE,uBAAuB,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC;IAGpE,UAAU,EAAE,iBAAiB,CAAC;IAC9B,mBAAmB,EAAE,MAAM,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;IAClG,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB,CACpC,WAAW,SAAS,wBAAwB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,wBAAwB;IAEtF,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,WAAW,CAAC;CACzB;AAGD,MAAM,MAAM,kBAAkB,GAAG,CAC/B,WAAW,SAAS,wBAAwB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,wBAAwB,EACtF,OAAO,EAAE,qBAAqB,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,eAAO,MAAM,cAAc,GACzB,WAAW,SAAS,wBAAwB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,wBAAwB,EACtF,qCAIC,qBAAqB,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,IAAI,CAwJnD,CAAC"}

package/dist/consumers/requestScreenShare.d.ts

@@ -0,0 +1,47 @@
+import { Socket } from 'socket.io-client';
+import { ShowAlert, StartShareScreenType, StartShareScreenParameters } from '../types/types';
+export interface RequestScreenShareParameters extends StartShareScreenParameters {
+    socket: Socket;
+    showAlert?: ShowAlert;
+    localUIMode: boolean;
+    targetResolution?: string;
+    targetResolutionHost?: string;
+    startShareScreen: StartShareScreenType;
+    getUpdatedAllParams: () => RequestScreenShareParameters;
+    [key: string]: any;
+}
+export interface RequestScreenShareOptions {
+    parameters: RequestScreenShareParameters;
+}
+export type RequestScreenShareType = (options: RequestScreenShareOptions) => Promise<void>;
+/**
+ * Requests to start screen sharing.
+ *
+ * @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 screen sharing for the host.
+ * @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: socketInstance,
+ *     localUIMode: false,
+ *     targetResolution: 'fhd',
+ *     startShareScreen: startShareScreenFunction,
+ *     // other parameters...
+ *   },
+ * });
+ * ```
+ */
+export declare function requestScreenShare({ parameters }: RequestScreenShareOptions): Promise<void>;
+//# sourceMappingURL=requestScreenShare.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requestScreenShare.d.ts","sourceRoot":"","sources":["../../src/consumers/requestScreenShare.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAE7F,MAAM,WAAW,4BAA6B,SAAQ,0BAA0B;IAC9E,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAI9B,gBAAgB,EAAE,oBAAoB,CAAC;IACvC,mBAAmB,EAAG,MAAM,4BAA4B,CAAC;IACzD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,wBAAsB,kBAAkB,CAAC,EAAE,UAAU,EAAE,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgDjG"}

package/dist/consumers/resumePauseAudioStreams.d.ts

@@ -0,0 +1,85 @@
+import { Participant, Stream, ProcessConsumerTransportsAudioParameters, Transport, EventType } from '../types/types';
+interface BreakoutParticipantLike {
+    name: string;
+    breakRoom?: number | null;
+}
+interface ParticipantLike {
+    name: string;
+    islevel?: string | null;
+    audioID?: string | null;
+    producerId?: string | null;
+    breakRoom?: number | null;
+}
+interface MediaEntryLike {
+    producerId?: string | null;
+    audioID?: string | null;
+}
+interface AudioTransportLike {
+    producerId?: string | null;
+    consumer?: {
+        paused?: boolean;
+        kind?: string;
+        pause: () => unknown;
+        resume: () => unknown;
+    };
+    socket_: {
+        emit: (event: string, payload: {
+            serverConsumerId: string;
+        }, callback?: ((payload?: {
+            resumed: boolean;
+        }) => void | Promise<unknown>)) => void;
+    };
+    serverConsumerTransportId: string;
+}
+export interface ResumePauseAudioStreamsParameters<TTransport extends AudioTransportLike = Transport, TMediaEntry extends MediaEntryLike | ParticipantLike = Stream | Participant> extends ProcessConsumerTransportsAudioParameters {
+    breakoutRooms: BreakoutParticipantLike[][];
+    ref_participants: ParticipantLike[];
+    allAudioStreams: TMediaEntry[];
+    participants: ParticipantLike[];
+    islevel: string;
+    eventType: EventType;
+    consumerTransports: TTransport[];
+    limitedBreakRoom: BreakoutParticipantLike[];
+    hostNewRoom: number;
+    member: string;
+    updateLimitedBreakRoom: (limitedBreakRoom: BreakoutParticipantLike[]) => void;
+    processConsumerTransportsAudio: (options: {
+        consumerTransports: TTransport[];
+        lStreams: TMediaEntry[];
+        parameters: ProcessConsumerTransportsAudioParameters;
+    }) => Promise<void>;
+    getUpdatedAllParams: () => ResumePauseAudioStreamsParameters<TTransport, TMediaEntry>;
+    [key: string]: any;
+}
+export interface ResumePauseAudioStreamsOptions<TTransport extends AudioTransportLike = Transport, TMediaEntry extends MediaEntryLike | ParticipantLike = Stream | Participant> {
+    breakRoom?: number;
+    inBreakRoom?: boolean;
+    parameters: ResumePauseAudioStreamsParameters<TTransport, TMediaEntry>;
+}
+export type ResumePauseAudioStreamsType = (options: ResumePauseAudioStreamsOptions) => Promise<void>;
+/**
+ * Resumes or pauses audio streams based on the provided options.
+ *
+ * @param {ResumePauseAudioStreamsOptions} options - The options for resuming or pausing audio streams.
+ * @param {number} [options.breakRoom=-1] - The ID of the break room.
+ * @param {boolean} [options.inBreakRoom=false] - Indicates if the participant is in a break room.
+ * @param {ResumePauseAudioStreamsParameters} options.parameters - The parameters required for processing audio streams.
+ *
+ * @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: {
+ *     // ...parameters here
+ *   },
+ * });
+ * ```
+ */
+export declare const resumePauseAudioStreams: <TTransport extends AudioTransportLike = Transport, TMediaEntry extends MediaEntryLike | ParticipantLike = Stream | Participant>({ breakRoom, inBreakRoom, parameters, }: ResumePauseAudioStreamsOptions<TTransport, TMediaEntry>) => Promise<void>;
+export {};
+//# sourceMappingURL=resumePauseAudioStreams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resumePauseAudioStreams.d.ts","sourceRoot":"","sources":["../../src/consumers/resumePauseAudioStreams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,wCAAwC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAErH,UAAU,uBAAuB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,UAAU,cAAc;IACtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,kBAAkB;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,OAAO,CAAC;QACrB,MAAM,EAAE,MAAM,OAAO,CAAC;KACvB,CAAC;IACF,OAAO,EAAE;QACP,IAAI,EAAE,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;YAAE,gBAAgB,EAAE,MAAM,CAAA;SAAE,EACrC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE;YAAE,OAAO,EAAE,OAAO,CAAA;SAAE,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,KACrE,IAAI,CAAC;KACX,CAAC;IACF,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC,CAChD,UAAU,SAAS,kBAAkB,GAAG,SAAS,EACjD,WAAW,SAAS,cAAc,GAAG,eAAe,GAAG,MAAM,GAAG,WAAW,CAC3E,SAAQ,wCAAwC;IAChD,aAAa,EAAE,uBAAuB,EAAE,EAAE,CAAC;IAC3C,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,eAAe,EAAE,WAAW,EAAE,CAAC;IAC/B,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;IACrB,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,uBAAuB,EAAE,KAAK,IAAI,CAAC;IAG9E,8BAA8B,EAAE,CAAC,OAAO,EAAE;QACxC,kBAAkB,EAAE,UAAU,EAAE,CAAC;QACjC,QAAQ,EAAE,WAAW,EAAE,CAAC;QACxB,UAAU,EAAE,wCAAwC,CAAC;KACtD,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,mBAAmB,EAAE,MAAM,iCAAiC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B,CAC7C,UAAU,SAAS,kBAAkB,GAAG,SAAS,EACjD,WAAW,SAAS,cAAc,GAAG,eAAe,GAAG,MAAM,GAAG,WAAW;IAE3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,iCAAiC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;CACxE;AAGD,MAAM,MAAM,2BAA2B,GAAG,CACxC,OAAO,EAAE,8BAA8B,KACpC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,eAAO,MAAM,uBAAuB,GAClC,UAAU,SAAS,kBAAkB,GAAG,SAAS,EACjD,WAAW,SAAS,cAAc,GAAG,eAAe,GAAG,MAAM,GAAG,WAAW,EAC3E,yCAIC,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC,KAAG,OAAO,CAAC,IAAI,CAiHxE,CAAC"}

package/dist/consumers/resumePauseStreams.d.ts

@@ -0,0 +1,68 @@
+import { Participant, Transport, Stream } from '../types/types';
+interface ParticipantLike {
+    name: string;
+    islevel?: string | null;
+    videoID?: string | null;
+}
+interface ConsumerLike {
+    kind?: string;
+    resume: () => unknown;
+}
+interface SocketLike {
+    emit: (event: string, payload: {
+        serverConsumerId: string;
+    }, callback?: ((payload: {
+        resumed: boolean;
+    }) => void | Promise<unknown>)) => void;
+}
+interface TransportLike {
+    producerId?: string | null;
+    consumer: ConsumerLike;
+    socket_: SocketLike;
+    serverConsumerTransportId: string;
+}
+export interface ResumePauseStreamsParameters<TParticipant extends ParticipantLike = Participant, TTransport extends TransportLike = Transport, TStream = Stream> {
+    participants: TParticipant[];
+    dispActiveNames: string[];
+    remoteScreenStream: TStream[];
+    consumerTransports: TTransport[];
+    screenId?: string;
+    islevel: string;
+    getUpdatedAllParams: () => ResumePauseStreamsParameters<TParticipant, TTransport, TStream>;
+    [key: string]: any;
+}
+export interface ResumePauseStreamsOptions<TParticipant extends ParticipantLike = Participant, TTransport extends TransportLike = Transport, TStream = Stream> {
+    parameters: ResumePauseStreamsParameters<TParticipant, TTransport, TStream>;
+}
+export type ResumePauseStreamsType = <TParticipant extends ParticipantLike = Participant, TTransport extends TransportLike = Transport, TStream = Stream>(options: ResumePauseStreamsOptions<TParticipant, TTransport, TStream>) => Promise<void>;
+/**
+ * Resumes or pauses streams based on the provided parameters.
+ *
+ * @param {ResumePauseStreamsOptions} options - The options for resuming or pausing streams.
+ * @param {Object} options.parameters - The parameters for the function.
+ * @param {Array} options.parameters.participants - The list of participants.
+ * @param {Array} options.parameters.dispActiveNames - The list of active display names.
+ * @param {Array} options.parameters.consumerTransports - The list of consumer transports.
+ * @param {string} [options.parameters.screenId] - The screen producer ID.
+ * @param {string} options.parameters.islevel - The level of the user.
+ *
+ * @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: participantArray,
+ *     dispActiveNames: ['user1', 'user2'],
+ *     consumerTransports: transportArray,
+ *     screenId: 'screen-123',
+ *     islevel: '1',
+ *   },
+ * });
+ * ```
+ */
+export declare function resumePauseStreams<TParticipant extends ParticipantLike = Participant, TTransport extends TransportLike = Transport, TStream = Stream>({ parameters, }: ResumePauseStreamsOptions<TParticipant, TTransport, TStream>): Promise<void>;
+export {};
+//# sourceMappingURL=resumePauseStreams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resumePauseStreams.d.ts","sourceRoot":"","sources":["../../src/consumers/resumePauseStreams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAEhE,UAAU,eAAe;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,UAAU,YAAY;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAA;KAAE,EACrC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,KACpE,IAAI,CAAC;CACX;AAED,UAAU,aAAa;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,UAAU,CAAC;IACpB,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B,CAC3C,YAAY,SAAS,eAAe,GAAG,WAAW,EAClD,UAAU,SAAS,aAAa,GAAG,SAAS,EAC5C,OAAO,GAAG,MAAM;IAEhB,YAAY,EAAE,YAAY,EAAE,CAAC;IAC7B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kBAAkB,EAAE,OAAO,EAAE,CAAC;IAC9B,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAGhB,mBAAmB,EAAE,MAAM,4BAA4B,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB,CACxC,YAAY,SAAS,eAAe,GAAG,WAAW,EAClD,UAAU,SAAS,aAAa,GAAG,SAAS,EAC5C,OAAO,GAAG,MAAM;IAEhB,UAAU,EAAE,4BAA4B,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;CAC7E;AAGD,MAAM,MAAM,sBAAsB,GAAG,CACnC,YAAY,SAAS,eAAe,GAAG,WAAW,EAClD,UAAU,SAAS,aAAa,GAAG,SAAS,EAC5C,OAAO,GAAG,MAAM,EAChB,OAAO,EAAE,yBAAyB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,wBAAsB,kBAAkB,CACtC,YAAY,SAAS,eAAe,GAAG,WAAW,EAClD,UAAU,SAAS,aAAa,GAAG,SAAS,EAC5C,OAAO,GAAG,MAAM,EAChB,EACA,UAAU,GACX,EAAE,yBAAyB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAwD9E"}

package/dist/consumers/resumeSendTransportAudio.d.ts

@@ -0,0 +1,65 @@
+import { Producer } from 'mediasoup-client/types';
+import { PrepopulateUserMediaParameters, PrepopulateUserMediaType } from '../types/types';
+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 const resumeSendTransportAudio: ResumeSendTransportAudioType;
+//# sourceMappingURL=resumeSendTransportAudio.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resumeSendTransportAudio.d.ts","sourceRoot":"","sources":["../../src/consumers/resumeSendTransportAudio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE1F,MAAM,WAAW,kCAAmC,SAAQ,8BAA8B;IACxF,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,kBAAkB,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,CAAC,aAAa,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC;IAC9D,wBAAwB,CAAC,EAAE,CAAC,kBAAkB,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC;IACzE,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAC;IAG5D,oBAAoB,EAAE,wBAAwB,CAAC;IAC/C,yBAAyB,CAAC,EAAE,wBAAwB,CAAC;IACrD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,UAAU,EAAE,kCAAkC,CAAC;CAChD;AAGD,MAAM,MAAM,4BAA4B,GAAG,CAAC,OAAO,EAAE,+BAA+B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAsBvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,eAAO,MAAM,wBAAwB,EAAE,4BAmDtC,CAAC"}

package/dist/consumers/signalNewConsumerTransport.d.ts

@@ -0,0 +1,59 @@
+import { Socket } from 'socket.io-client';
+import { ReorderStreamsParameters, ReorderStreamsType, ConnectRecvTransportType, ConnectRecvTransportParameters } from '../types/types';
+import { Device } from 'mediasoup-client/types';
+export interface SignalNewConsumerTransportParameters extends ReorderStreamsParameters, ConnectRecvTransportParameters {
+    device: Device | null;
+    consumingTransports: string[];
+    lock_screen: boolean;
+    updateConsumingTransports: (transports: string[]) => void;
+    connectRecvTransport: ConnectRecvTransportType;
+    reorderStreams: ReorderStreamsType;
+    getUpdatedAllParams: () => SignalNewConsumerTransportParameters;
+    [key: string]: any;
+}
+export interface SignalNewConsumerTransportOptions {
+    remoteProducerId: string;
+    islevel: string;
+    nsock: Socket;
+    parameters: SignalNewConsumerTransportParameters;
+}
+export type SignalNewConsumerTransportType = (options: SignalNewConsumerTransportOptions) => Promise<string[] | void>;
+/**
+ * Signals the creation of a new consumer transport.
+ *
+ * @param {SignalNewConsumerTransportOptions} options - The options for signaling a new consumer transport.
+ * @param {string} options.remoteProducerId - The ID of the remote producer.
+ * @param {string} options.islevel - Indicates the level of the consumer.
+ * @param {Socket} options.nsock - The socket instance for communication.
+ * @param {SignalNewConsumerTransportParameters} 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: '1',
+ *   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 const signalNewConsumerTransport: ({ remoteProducerId, islevel, nsock, parameters, }: SignalNewConsumerTransportOptions) => Promise<string[] | void>;
+//# sourceMappingURL=signalNewConsumerTransport.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"signalNewConsumerTransport.d.ts","sourceRoot":"","sources":["../../src/consumers/signalNewConsumerTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,wBAAwB,EAC5E,8BAA8B,EAAiC,MAAM,gBAAgB,CAAC;AACzF,OAAO,KAAK,EAAE,MAAM,EAAmB,MAAM,wBAAwB,CAAC;AAEtE,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB,EAAE,8BAA8B;IACpH,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;IAC1D,oBAAoB,EAAE,wBAAwB,CAAC;IAC/C,cAAc,EAAE,kBAAkB,CAAC;IACnC,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;IAChE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iCAAiC;IAChD,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,oCAAoC,CAAC;CAClD;AAGD,MAAM,MAAM,8BAA8B,GAAG,CAAC,OAAO,EAAE,iCAAiC,KAAK,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,eAAO,MAAM,0BAA0B,GAAU,mDAK9C,iCAAiC,KAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CA4G7D,CAAC"}

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

@@ -0,0 +1,76 @@
+import { Device, RtpCapabilities } from 'mediasoup-client/types';
+import { Socket } from 'socket.io-client';
+import { ReceiveAllPipedTransportsParameters, ReceiveAllPipedTransportsType, CreateDeviceClientType } from '../../types/types';
+export interface JoinConsumeRoomParameters extends ReceiveAllPipedTransportsParameters {
+    roomName: string;
+    islevel: string;
+    member: string;
+    device: Device | null;
+    updateDevice: (device: Device | null) => void;
+    receiveAllPipedTransports: ReceiveAllPipedTransportsType;
+    createDeviceClient: CreateDeviceClientType;
+    getUpdatedAllParams: () => JoinConsumeRoomParameters;
+    [key: string]: any;
+}
+export interface JoinConsumeRoomOptions {
+    remote_sock: Socket;
+    apiToken: string;
+    apiUserName: string;
+    parameters: JoinConsumeRoomParameters;
+}
+interface JoinConsumeRoomResponse {
+    success: boolean;
+    rtpCapabilities?: RtpCapabilities | null;
+}
+export type JoinConsumeRoomType = (options: JoinConsumeRoomOptions) => Promise<JoinConsumeRoomResponse>;
+/**
+ * Joins a consumption room by sending a request to the server, handling device setup, and managing piped transports.
+ *
+ * @function
+ * @async
+ * @param {Object} options - The configuration options.
+ * @param {Socket} options.remote_sock - The remote socket for communication.
+ * @param {string} options.apiToken - The API token for authentication.
+ * @param {string} options.apiUserName - The API username for authentication.
+ * @param {JoinConsumeRoomParameters} options.parameters - Additional parameters including room details and Mediasoup configurations.
+ * @returns {Promise<JoinConsumeRoomResponse>} - An object indicating the success of joining the room and optional RTP capabilities.
+ * @throws {Error} Throws an error if joining the room or setup fails.
+ *
+ * @example
+ * import { joinConsumeRoom } from 'mediasfu-reactjs';
+ * import { io } from 'socket.io-client';
+ *
+ * const apiToken = 'your-api-token';
+ * const apiUserName = 'your-api-username';
+ * const remote_sock = io("http://localhost:3000");
+ *
+ * const parameters = {
+ *   roomName: 'room-name',
+ *   islevel: '2',
+ *   member: 'user-id',
+ *   device: null,
+ *   updateDevice: (device) => console.log('Device updated:', device),
+ *   receiveAllPipedTransports: (params) => console.log('Receiving all piped transports:', params),
+ *   createDeviceClient: async (params) => { // Device client setup logic  },
+ *   getUpdatedAllParams: () => console.log('Getting updated parameters'),
+ * };
+ *
+ * async function init() {
+ *   try {
+ *     const data = await joinConsumeRoom({
+ *       remote_sock,
+ *       apiToken,
+ *       apiUserName,
+ *       parameters,
+ *     });
+ *     console.log('Joined room:', data);
+ *   } catch (error) {
+ *     console.error('Error joining room:', error);
+ *   }
+ * }
+ * init();
+ * // Expected output: { success: true, rtpCapabilities: { ... } }
+ */
+export declare const joinConsumeRoom: ({ remote_sock, apiToken, apiUserName, parameters, }: JoinConsumeRoomOptions) => Promise<JoinConsumeRoomResponse>;
+export {};
+//# sourceMappingURL=joinConsumeRoom.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"joinConsumeRoom.d.ts","sourceRoot":"","sources":["../../../src/consumers/socketReceiveMethods/joinConsumeRoom.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,mCAAmC,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAG/H,MAAM,WAAW,yBAA0B,SAAQ,mCAAmC;IACpF,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAG9C,yBAAyB,EAAE,6BAA6B,CAAC;IACzD,kBAAkB,EAAE,sBAAsB,CAAC;IAC3C,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;IACrD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,yBAAyB,CAAC;CACvC;AAED,UAAU,uBAAuB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAC1C;AAGD,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AAGH,eAAO,MAAM,eAAe,GAAU,qDAKnC,sBAAsB,KAAG,OAAO,CAAC,uBAAuB,CAgD1D,CAAC"}