mediasfu-shared 1.0.6 → 1.2.0

package/dist/methods/displaySettings/modifyDisplaySettings.d.ts

@@ -0,0 +1,106 @@
+import { ShowAlert, OnScreenChangesParameters, OnScreenChangesType } from '../../types/types';
+export interface ModifyDisplaySettingsParameters extends OnScreenChangesParameters {
+    showAlert?: ShowAlert;
+    meetingDisplayType: string;
+    autoWave: boolean;
+    forceFullDisplay: boolean;
+    showSubtitlesOnCards?: boolean;
+    meetingVideoOptimized: boolean;
+    islevel: string;
+    recordStarted: boolean;
+    recordResumed: boolean;
+    recordStopped: boolean;
+    recordPaused: boolean;
+    recordingDisplayType: 'video' | 'media' | 'all';
+    recordingVideoOptimized: boolean;
+    prevForceFullDisplay: boolean;
+    prevMeetingDisplayType: string;
+    updateMeetingDisplayType: (displayType: string) => void;
+    updateAutoWave: (autoWave: boolean) => void;
+    updateForceFullDisplay: (forceFullDisplay: boolean) => void;
+    updateShowSubtitlesOnCards?: (showSubtitlesOnCards: boolean) => void;
+    updateMeetingVideoOptimized: (optimized: boolean) => void;
+    updatePrevForceFullDisplay: (forceFullDisplay: boolean) => void;
+    updatePrevMeetingDisplayType: (displayType: string) => void;
+    updateIsDisplaySettingsModalVisible: (isVisible: boolean) => void;
+    updateFirstAll: (firstAll: boolean) => void;
+    updateUpdateMainWindow: (update: boolean) => void;
+    breakOutRoomStarted: boolean;
+    breakOutRoomEnded: boolean;
+    onScreenChanges: OnScreenChangesType;
+    [key: string]: any;
+}
+export interface ModifyDisplaySettingsOptions {
+    parameters: ModifyDisplaySettingsParameters;
+}
+export type ModifyDisplaySettingsType = (options: ModifyDisplaySettingsOptions) => Promise<void>;
+/**
+ * Modifies the display settings based on the provided parameters.
+ *
+ * @param {ModifyDisplaySettingsOptions} options - The options containing the parameters to modify the display settings.
+ * @param {Object} options.parameters - The parameters for modifying the display settings.
+ * @param {Function} options.parameters.showAlert - Function to show alert messages.
+ * @param {string} options.parameters.meetingDisplayType - The current meeting display type.
+ * @param {boolean} options.parameters.autoWave - Flag indicating if auto wave is enabled.
+ * @param {boolean} options.parameters.forceFullDisplay - Flag indicating if full display is forced.
+ * @param {boolean} options.parameters.meetingVideoOptimized - Flag indicating if the meeting video is optimized.
+ * @param {string} options.parameters.islevel - The current level of the meeting.
+ * @param {boolean} options.parameters.recordStarted - Flag indicating if recording has started.
+ * @param {boolean} options.parameters.recordResumed - Flag indicating if recording has resumed.
+ * @param {boolean} options.parameters.recordStopped - Flag indicating if recording has stopped.
+ * @param {boolean} options.parameters.recordPaused - Flag indicating if recording is paused.
+ * @param {string} options.parameters.recordingDisplayType - The current recording display type.
+ * @param {boolean} options.parameters.recordingVideoOptimized - Flag indicating if the recording video is optimized.
+ * @param {string} options.parameters.prevForceFullDisplay - The previous force full display value.
+ * @param {string} options.parameters.prevMeetingDisplayType - The previous meeting display type.
+ * @param {Function} options.parameters.updateMeetingDisplayType - Function to update the meeting display type.
+ * @param {Function} options.parameters.updateAutoWave - Function to update the auto wave setting.
+ * @param {Function} options.parameters.updateForceFullDisplay - Function to update the force full display setting.
+ * @param {Function} options.parameters.updateMeetingVideoOptimized - Function to update the meeting video optimization setting.
+ * @param {Function} options.parameters.updatePrevForceFullDisplay - Function to update the previous force full display setting.
+ * @param {Function} options.parameters.updatePrevMeetingDisplayType - Function to update the previous meeting display type.
+ * @param {Function} options.parameters.updateIsDisplaySettingsModalVisible - Function to update the visibility of the display settings modal.
+ * @param {Function} options.parameters.updateFirstAll - Function to update the first all setting.
+ * @param {Function} options.parameters.updateUpdateMainWindow - Function to update the main window.
+ * @param {boolean} options.parameters.breakOutRoomStarted - Flag indicating if a breakout room has started.
+ * @param {boolean} options.parameters.breakOutRoomEnded - Flag indicating if a breakout room has ended.
+ * @param {Function} options.parameters.onScreenChanges - Function to handle screen changes.
+ *
+ * @example
+ * ```typescript
+ * const options: ModifyDisplaySettingsOptions = {
+ *   parameters: {
+ *     showAlert: showAlertFunction,
+ *     meetingDisplayType: "video",
+ *     autoWave: true,
+ *     forceFullDisplay: false,
+ *     meetingVideoOptimized: true,
+ *     islevel: "2",
+ *     recordStarted: true,
+ *     recordResumed: false,
+ *     recordStopped: false,
+ *     recordPaused: false,
+ *     recordingDisplayType: "video",
+ *     recordingVideoOptimized: true,
+ *     prevForceFullDisplay: false,
+ *     prevMeetingDisplayType: "media",
+ *     updateMeetingDisplayType: updateDisplayTypeFunction,
+ *     updateAutoWave: updateAutoWaveFunction,
+ *     updateForceFullDisplay: updateForceFullDisplayFunction,
+ *     updateMeetingVideoOptimized: updateVideoOptimizedFunction,
+ *     updatePrevForceFullDisplay: updatePrevForceFullFunction,
+ *     updatePrevMeetingDisplayType: updatePrevDisplayTypeFunction,
+ *     updateIsDisplaySettingsModalVisible: setModalVisibilityFunction,
+ *     updateFirstAll: setFirstAllFunction,
+ *     updateUpdateMainWindow: setMainWindowUpdateFunction,
+ *     breakOutRoomStarted: false,
+ *     breakOutRoomEnded: true,
+ *     onScreenChanges: onScreenChangesFunction
+ *   }
+ * };
+ *
+ * await modifyDisplaySettings(options);
+ * ```
+ */
+export declare const modifyDisplaySettings: ({ parameters }: ModifyDisplaySettingsOptions) => Promise<void>;
+//# sourceMappingURL=modifyDisplaySettings.d.ts.map

package/dist/methods/displaySettings/modifyDisplaySettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modifyDisplaySettings.d.ts","sourceRoot":"","sources":["../../../src/methods/displaySettings/modifyDisplaySettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,yBAAyB,EAAE,mBAAmB,EAAG,MAAM,mBAAmB,CAAA;AAGnG,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IAChF,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,QAAQ,EAAE,OAAO,CAAA;IACjB,gBAAgB,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,qBAAqB,EAAE,OAAO,CAAA;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,OAAO,CAAA;IACtB,aAAa,EAAE,OAAO,CAAA;IACtB,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,EAAE,OAAO,CAAA;IACrB,oBAAoB,EAAE,OAAO,GAAG,OAAO,GAAG,KAAK,CAAA;IAC/C,uBAAuB,EAAE,OAAO,CAAA;IAChC,oBAAoB,EAAE,OAAO,CAAA;IAC7B,sBAAsB,EAAE,MAAM,CAAA;IAC9B,wBAAwB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAA;IACvD,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAA;IAC3C,sBAAsB,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAA;IAC3D,0BAA0B,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,KAAK,IAAI,CAAA;IACpE,2BAA2B,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IACzD,0BAA0B,EAAE,CAAC,gBAAgB,EAAE,OAAO,KAAK,IAAI,CAAA;IAC/D,4BAA4B,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAA;IAC3D,mCAAmC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IACjE,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAA;IAC3C,sBAAsB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;IACjD,mBAAmB,EAAE,OAAO,CAAA;IAC5B,iBAAiB,EAAE,OAAO,CAAA;IAG1B,eAAe,EAAE,mBAAmB,CAAA;IAEpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,+BAA+B,CAAA;CAC5C;AAGD,MAAM,MAAM,yBAAyB,GAAG,CACtC,OAAO,EAAE,4BAA4B,KAClC,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AAEH,eAAO,MAAM,qBAAqB,GAAU,gBAEzC,4BAA4B,KAAG,OAAO,CAAC,IAAI,CAgI7C,CAAA"}

package/dist/methods/exit/confirmExit.d.ts

@@ -0,0 +1,38 @@
+import { Socket } from 'socket.io-client';
+export interface ConfirmExitOptions {
+    socket: Socket;
+    localSocket?: Socket;
+    member: string;
+    roomName: string;
+    ban?: boolean;
+    /** Whether a host exit should end the room for everyone. Defaults to true. */
+    endRoomOnHostExit?: boolean;
+}
+export type ConfirmExitType = (options: ConfirmExitOptions) => Promise<void>;
+/**
+ * Confirms the exit of a member from a room and optionally bans them.
+ *
+ * @param {ConfirmExitOptions} options - The options for confirming the exit.
+ * @param {Socket} options.socket - The socket instance to emit the event.
+ * @param {Socket} [options.localSocket] - The local socket instance to emit the event.
+ * @param {string} options.member - The member who is exiting.
+ * @param {string} options.roomName - The name of the room the member is exiting from.
+ * @param {boolean} [options.ban=false] - Whether to ban the member from the room.
+ * @param {boolean} [options.endRoomOnHostExit=true] - Whether a host exit ends the room for everyone.
+ * @returns {Promise<void>} A promise that resolves when the exit is confirmed.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   socket: socketInstance,
+ *   localSocket: localSocketInstance,
+ *   member: "JohnDoe",
+ *   roomName: "Room123",
+ *   ban: false,
+ *   endRoomOnHostExit: false, // Let the host rejoin without ending the room.
+ * };
+ * await confirmExit(options);
+ * ```
+ */
+export declare const confirmExit: ({ socket, localSocket, member, roomName, ban, endRoomOnHostExit }: ConfirmExitOptions) => Promise<void>;
+//# sourceMappingURL=confirmExit.d.ts.map

package/dist/methods/exit/confirmExit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirmExit.d.ts","sourceRoot":"","sources":["../../../src/methods/exit/confirmExit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,8EAA8E;IAC9E,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAGD,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,eAAO,MAAM,WAAW,GAAU,mEAO/B,kBAAkB,KAAG,OAAO,CAAC,IAAI,CAkBnC,CAAA"}

package/dist/methods/exit/index.d.ts

@@ -0,0 +1,3 @@
+export * from './confirmExit';
+export * from './launchConfirmExit';
+//# sourceMappingURL=index.d.ts.map

package/dist/methods/exit/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/methods/exit/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA"}

package/dist/methods/exit/launchConfirmExit.d.ts

@@ -0,0 +1,23 @@
+export interface LaunchConfirmExitOptions {
+    updateIsConfirmExitModalVisible: (isVisible: boolean) => void;
+    isConfirmExitModalVisible: boolean;
+}
+export type LaunchConfirmExitType = (options: LaunchConfirmExitOptions) => void;
+/**
+ * Toggles the visibility of the confirmation exit modal.
+ *
+ * @param {LaunchConfirmExitOptions} options - The options for launching the confirmation exit modal.
+ * @param {Function} options.updateIsConfirmExitModalVisible - Function to update the visibility state of the confirmation exit modal.
+ * @param {boolean} options.isConfirmExitModalVisible - Current visibility state of the confirmation exit modal.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   updateIsConfirmExitModalVisible: setIsConfirmExitModalVisible,
+ *   isConfirmExitModalVisible: false,
+ * }
+ * launchConfirmExit(options)
+ * ```
+ */
+export declare const launchConfirmExit: LaunchConfirmExitType;
+//# sourceMappingURL=launchConfirmExit.d.ts.map

package/dist/methods/exit/launchConfirmExit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"launchConfirmExit.d.ts","sourceRoot":"","sources":["../../../src/methods/exit/launchConfirmExit.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,+BAA+B,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IAC7D,yBAAyB,EAAE,OAAO,CAAA;CACnC;AAED,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,wBAAwB,KAAK,IAAI,CAAA;AAE/E;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,EAAE,qBAK/B,CAAA"}