mediasfu-shared 1.0.6 → 1.2.0

package/HEADLESS_GUIDE.md

@@ -0,0 +1,156 @@
+# Building a Headless MediaSFU Wrapper with mediasfu-shared
+
+`mediasfu-shared` is the lowest-level public TypeScript package in the MediaSFU SDK family. It supplies room, socket, producer, consumer, grid, state, and utility primitives. It does not supply a visible room, `ModernMediasfuGeneric`, a custom-component system, or a framework headless controller.
+
+Choose this layer only when you are building a framework adapter or a product whose runtime ownership cannot be expressed through a higher-level SDK.
+
+## Prefer the highest useful layer
+
+| Need | Recommended layer |
+| --- | --- |
+| Complete polished room | Framework SDK and `ModernMediasfuGeneric` where available |
+| Replace selected cards, controls, or modals | Framework SDK custom components or `uiOverrides` |
+| App owns the full workspace but SDK owns runtime publication | Framework SDK with `returnUI=false` |
+| Build or maintain the framework/runtime adapter itself | `mediasfu-shared` |
+
+## Runtime ownership
+
+```text
+Your framework store and lifecycle
+        | current parameter object
+        v
+mediasfu-shared room / socket / producer / consumer functions
+        | state updates and media events
+        v
+Your adapter publishes new immutable framework state
+        | resolved video + every remote audio source
+        v
+Your application UI
+```
+
+Your adapter must define clear ownership for the socket, mediasoup device, send/receive transports, producers, consumers, participant state, render state, and teardown.
+
+## 1. Make reads pure
+
+Create one pure read for your current parameter bag and separate it from publication:
+
+```ts
+let currentParameters: Record<string, any> = {};
+
+export function getCurrentParameters() {
+  return currentParameters;
+}
+
+export function publishParameters(next: Record<string, any>) {
+  currentParameters = next;
+  subscribers.forEach((subscriber) => subscriber(next));
+}
+```
+
+Do not call a publisher from render, computed state, pagination, polling, or media-card reads. A read must not notify subscribers.
+
+The names above belong to your adapter; `mediasfu-shared` does not currently export a dedicated parameter-store controller.
+
+## 2. Secure create and join
+
+Keep MediaSFU credentials on your backend. The public client sends an authenticated create/join intent to your app server. The server validates it, adds credentials from environment variables, and forwards it to MediaSFU Cloud or your MediaSFU Open rooms endpoint.
+
+Normalize the response into your adapter's session state. Never log secrets or retain raw room responses in screenshots. Follow the [secure proxy guide](https://mediasfu.com/docs/usage/secure-backend-proxy/).
+
+For local-only experimentation, short-lived credentials can live in ignored environment configuration. Remove them before committing, publishing, or building public artifacts.
+
+## 3. Connect room and socket state
+
+The package exports room helpers, `connectSocket`, `SocketManager`, producer-client flows, socket-receive methods, and TypeScript contracts. Build the smallest happy path first:
+
+1. create or join securely
+2. connect the socket with returned session data
+3. create the mediasoup device
+4. join the assigned room
+5. register socket event handlers
+6. publish current room state to the framework
+
+Do not mix UI customization into this acceptance step.
+
+## 4. Produce local media
+
+The shared package exports `clickAudio`, `clickVideo`, `clickScreenShare`, stream-success helpers, and send-transport helpers. Always invoke them with the newest parameter object from your pure store.
+
+Your adapter must surface permission pending, permission denied, producer connecting, live, paused, ended, and failed states so the UI does not guess from button color alone.
+
+## 5. Consume remote media
+
+Consumer helpers cover receive transport creation, signaling, consumer resume, producer-close events, piped producers, grid planning, and audio processing. Treat a signaled producer and a renderable live track as different milestones.
+
+For every consumer, retain stable identifiers for:
+
+- participant
+- producer
+- consumer
+- stream/track
+- media kind
+- screen-share versus camera source
+
+Use those identifiers for reconciliation and cleanup rather than array position or visible page.
+
+## 6. Resolve visual media deterministically
+
+A reliable wrapper should define a consistent visual priority:
+
+1. active screen share
+2. selected or pinned remote camera
+3. local camera preview
+4. avatar or audio-only fallback
+
+Recompute when participants, streams, producer IDs, screen-share state, or track readiness changes. The package exports pure grid/render planning engines such as the `prepopulateUserMedia` and `addVideosGrid` engine helpers; use the generated API reference for exact signatures.
+
+## 7. Render every audio source
+
+Audio consumption is independent of video layout and pagination.
+
+- Keep a dedicated audio-render collection keyed by stable producer ID.
+- Add an audio target when a live remote audio consumer arrives.
+- Keep it active when the participant is off-page or not selected.
+- Remove it on producer close, participant leave, breakout exclusion, or teardown.
+- Handle browser autoplay or native audio-session restrictions in the framework adapter.
+
+## 8. Publish outside framework render/build phases
+
+Socket and transport callbacks may arrive while a framework is rendering. Coalesce publication onto that framework's safe post-render scheduler. Avoid notifying consumers synchronously from React render, Vue computed evaluation, Angular change detection, or another framework's build phase.
+
+## 9. Teardown and late callbacks
+
+Teardown can race socket acknowledgements. Guard disposed devices, sockets, and transports in every late callback. Make cleanup idempotent:
+
+- unregister socket handlers
+- close consumers and receive transports
+- close producers and send transports
+- stop app-owned tracks
+- detach render targets
+- clear timers, queues, and pending promises where possible
+- publish a final disconnected state once
+
+## 10. Verification matrix
+
+Before publishing a wrapper or application, install the released `mediasfu-shared` version from npm and repeat the build and media acceptance checks against that clean dependency.
+
+| Path | Minimum proof |
+| --- | --- |
+| Secure create/join | Backend request succeeds and no client artifact contains credentials |
+| Produce | Remote participant receives microphone, camera, and screen tracks |
+| Consume | Local app renders remote camera/screen and plays remote audio |
+| Pagination | Off-page participant remains audible |
+| Resolution | Screen-to-camera-to-fallback transitions without stale frames |
+| Reconnect | Producers/consumers recover without duplicates |
+| Teardown | Late callbacks do not throw and no tracks/listeners remain |
+
+Use a real two-participant room for media acceptance. Seeded or mocked UI proves layout only.
+
+## References
+
+- [Package README](README.md)
+- [Shared SDK guide](https://mediasfu.com/docs/sdks/shared/)
+- [Generated API references](https://mediasfu.com/docs/api-reference/)
+- [Secure backend proxy](https://mediasfu.com/docs/usage/secure-backend-proxy/)
+- [MediaSFU Open](https://github.com/MediaSFU/MediaSFUOpen)
+- [MediaSFU Sandbox](https://mediasfu.com/sandbox)

package/README.md

@@ -1,8 +1,14 @@
-# mediasfu-shared · [mediasfu-shared on npm](https://www.npmjs.com/package/mediasfu-shared)
-
-**mediasfu-shared** is the framework-agnostic WebRTC runtime at the core of the MediaSFU SDK family. It provides shared room helpers, mediasoup signaling, socket management, media state utilities, and TypeScript types for React, Vue, Angular, Svelte, and plain TypeScript. Install with `npm install mediasfu-shared`.
-
-`mediasfu-shared` is the framework-agnostic MediaSFU runtime package. It exposes the shared room helpers, mediasoup/socket flows, state utilities, and TypeScript types used by the MediaSFU SDK family.
+# mediasfu-shared — framework-neutral MediaSFU engine
+
+**mediasfu-shared** is the framework-agnostic WebRTC runtime at the core of the MediaSFU SDK family. It provides shared room helpers, mediasoup signaling, socket management, media state utilities, and TypeScript types for React, Vue, Angular, Svelte, and plain TypeScript. Install with `npm install mediasfu-shared`.
+
+<p align="center">
+  <a href="https://www.mediasfu.com/quick-usage">
+    <img src="https://raw.githubusercontent.com/MediaSFU/MediaSFU-Shared/main/public/readme/mediasfu-platform-capabilities.webp" width="1100" alt="MediaSFU real-time product capabilities including meetings, live broadcasts, classrooms, calling, recording, agents, and live commerce" />
+  </a>
+</p>
+
+This package exposes framework-neutral room, media, participant, playback, and headless helpers. It does not render a room or provide a framework state controller. Choose a framework SDK when you want prebuilt UI, `ModernMediasfuGeneric`, UI overrides, or a framework-native headless hook or service.
 
 ## When To Use This Package
 
@@ -20,55 +26,104 @@ npm install mediasfu-shared mediasoup-client socket.io-client
 
 `mediasoup-client` and `socket.io-client` are peer dependencies, so install them in the host app.
 
-## Backend Requirement
-
-The cloud room helpers in this package target `https://mediasfu.com/v1/rooms/` by default.
-
-- Use MediaSFU Cloud when you want managed room creation, signaling, and media routing. Pass `apiUserName` and `apiKey`.
-- Use MediaSFU Open / Community Edition when you self-host. Pass a non-MediaSFU `localLink` such as `http://localhost:3000`.
-
-## Quick Example
-
-```ts
-import {
-  SocketManager,
-  connectSocket,
-  createRoomOnMediaSFU,
-  joinRoomOnMediaSFU,
-} from 'mediasfu-shared';
-
-const createResult = await createRoomOnMediaSFU({
-  payload: {
-    action: 'create',
-    userName: 'Ada',
-    duration: 60,
-    capacity: 10,
-  },
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-});
-
-const joinResult = await joinRoomOnMediaSFU({
-  payload: {
-    action: 'join',
-    meetingID: 'room123',
-    userName: 'Ben',
-  },
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-});
-
-const socket = await connectSocket({
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-  apiToken: 'your-api-token',
-  link: 'https://mediasfu.com/socket',
-});
-
-const socketManager = new SocketManager({ socket });
-
-console.log(createResult.success, joinResult.success, socketManager.socket.connected);
-```
+## Backend requirement and credential boundary
+
+The Cloud room helpers target `https://mediasfu.com/v1/rooms/` by default.
+
+- Use **MediaSFU Cloud** when you want managed room creation, signaling, and media routing.
+- Use **MediaSFU Open** when you want your own locally or privately running MediaSFU media server. You install and operate [MediaSFU Open](https://github.com/MediaSFU/MediaSFUOpen), then configure its reachable URL.
+
+In production, create and join rooms through your authenticated backend so the MediaSFU API username and key never enter a browser or mobile bundle. Direct credentials are suitable only for an ignored, private local-development environment.
+
+## Server-side room bootstrap
+
+The following shape belongs in a trusted server process. Validate and authorize the caller, load credentials from server-side environment configuration, and return only the client-safe room/session fields your application needs.
+
+```ts
+import {
+  createRoomOnMediaSFU,
+} from 'mediasfu-shared';
+
+export async function createRoomForAuthenticatedUser(userName: string) {
+  return createRoomOnMediaSFU({
+    payload: {
+      action: 'create',
+      userName,
+      duration: 60,
+      capacity: 10,
+    },
+    apiUserName: process.env.MEDIASFU_API_USERNAME ?? '',
+    apiKey: process.env.MEDIASFU_API_KEY ?? '',
+  });
+}
+```
+
+## Headless state and actions
+
+`mediasfu-shared` exports the framework-independent headless helpers used by the
+React Native, Expo, Vue, and Angular adapters. The package does not mount a room
+component by itself: pass it the newest parameter bag published by your chosen
+framework SDK.
+
+```ts
+import {
+  getCurrentParams,
+  getRoomReadiness,
+  getLocalVideoStream,
+  listParticipantMediaStates,
+  runMediaControl,
+  type HeadlessParameters,
+} from 'mediasfu-shared';
+
+let parameters: HeadlessParameters = {};
+
+export function acceptPublishedParameters(next: HeadlessParameters) {
+  parameters = next;
+}
+
+export function readRoom() {
+  const current = getCurrentParams({ parameters });
+  return {
+    readiness: getRoomReadiness({ parameters: current }),
+    localVideo: getLocalVideoStream({ parameters: current }),
+    participants: listParticipantMediaStates({ parameters: current }),
+  };
+}
+
+export async function toggleMicrophone() {
+  return runMediaControl({ parameters, control: 'clickAudio' });
+}
+```
+
+Always replace the stored bag when the framework publishes a new one. Do not
+hold an earlier snapshot: the SDK reassigns fields as room state changes.
+`getCurrentParams()` is a pure read. `getUpdatedAllParams()` republishes and
+must not be used by render functions, computed values, or polling timers.
+
+The headless barrel also exports media-stream resolution, participant state,
+permissions, moderation, recording/polls/whiteboard/breakout controls, session
+extras, playback/viewer capabilities, and media-production helpers. The native
+entry omits the DOM-only virtual-background pipeline; use the native SDK's
+platform implementation instead.
+
+### Browser virtual backgrounds
+
+For a browser headless wrapper, apply a background after the camera is live and
+keep rendering the stream returned by the SDK's current parameter bag:
+
+```ts
+import { applyVirtualBackground, clearVirtualBackground } from 'mediasfu-shared';
+
+await applyVirtualBackground({ parameters, image: '/backgrounds/studio.jpg' });
+// On removal, the producer is restored to the raw camera track.
+await clearVirtualBackground({ parameters });
+```
+
+The helper uses the same segmentation/compositing contract as the React modal,
+isolates processing tracks, and updates `virtualStream`/`processedStream` for
+the self-view. Native builds intentionally omit this browser-only pipeline.
+
+For lifecycle ownership, media resolution, independent audio rendering, publication scheduling, and teardown guidance, read [Building a Headless MediaSFU Wrapper](HEADLESS_GUIDE.md).
 
 ## Import Paths
 
@@ -77,11 +132,13 @@ console.log(createResult.success, joinResult.success, socketManager.socket.conne
 - `mediasfu-shared/methods` is useful when you want action utilities and room helpers.
 - `mediasfu-shared/types` is useful when you only need TypeScript contracts.
 
-## Documentation
-
-- Main docs: [https://mediasfu.com/documentation](https://mediasfu.com/documentation)
-- User guide: [https://mediasfu.com/user-guide](https://mediasfu.com/user-guide)
-- MediaSFU Open / CE: [https://github.com/MediaSFU/MediaSFUOpen](https://github.com/MediaSFU/MediaSFUOpen)
+## Documentation
+
+- Shared/headless guide: [HEADLESS_GUIDE.md](HEADLESS_GUIDE.md)
+- Main developer docs: [https://mediasfu.com/documentation](https://mediasfu.com/documentation)
+- API Sandbox: [https://mediasfu.com/sandbox](https://mediasfu.com/sandbox)
+- Secure backend proxy guide: [https://mediasfu.com/docs/usage/secure-backend-proxy/](https://mediasfu.com/docs/usage/secure-backend-proxy/)
+- MediaSFU Open / CE: [https://github.com/MediaSFU/MediaSFUOpen](https://github.com/MediaSFU/MediaSFUOpen)
 
 Generate package-local API docs with:
 
@@ -103,6 +160,17 @@ npm run build-docs
 - GitHub issues: [https://github.com/MediaSFU/MediaSFU-Shared/issues](https://github.com/MediaSFU/MediaSFU-Shared/issues)
 - Email: info@mediasfu.com
 
-## License
-
-MIT. See [LICENSE](LICENSE).
+## Host leave and rejoin
+
+Host exits still end the room by default. To leave while keeping the room, timer, and other participants active, pass `endRoomOnHostExit: false`:
+
+```ts
+await confirmExit({ socket, member, roomName, endRoomOnHostExit: false });
+await leaveRoom({ parameters, endRoomOnHostExit: false });
+```
+
+The host can later rejoin with the normal room credentials. Never expose production API credentials in a client application; use your backend room proxy outside local development.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

package/dist/ProducerClient/producerClientEmits/createDeviceClient.d.ts

@@ -0,0 +1,23 @@
+import { RtpCapabilities, Device } from 'mediasoup-client/types';
+export interface CreateDeviceClientOptions {
+    rtpCapabilities: RtpCapabilities | null;
+}
+export type CreateDeviceClientType = (options: CreateDeviceClientOptions) => Promise<Device | null>;
+/**
+ * Creates a mediasoup client device with the provided RTP capabilities.
+ *
+ * @param {CreateDeviceClientOptions} options - The options for creating the device client.
+ * @param {RTPCapabilities} options.rtpCapabilities - The RTP capabilities required for the device.
+ * @returns {Promise<Device | null>} A promise that resolves to the created Device or null if creation fails.
+ * @throws {Error} Throws an error if the required parameters are not provided or if device creation is not supported.
+ *
+ * @example
+ * const device = await createDeviceClient({ rtpCapabilities });
+ * if (device) {
+ *   console.log("Device created successfully");
+ * } else {
+ *   console.log("Failed to create device");
+ * }
+ */
+export declare const createDeviceClient: ({ rtpCapabilities }: CreateDeviceClientOptions) => Promise<Device | null>;
+//# sourceMappingURL=createDeviceClient.d.ts.map

package/dist/ProducerClient/producerClientEmits/createDeviceClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDeviceClient.d.ts","sourceRoot":"","sources":["../../../src/ProducerClient/producerClientEmits/createDeviceClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAEtE,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;CACzC;AAID,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;AAGpG;;;;;;;;;;;;;;;GAeG;AAEH,eAAO,MAAM,kBAAkB,GAAU,qBAEtC,yBAAyB,KAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAiCnD,CAAC"}

package/dist/ProducerClient/producerClientEmits/joinRoomClient.d.ts

@@ -0,0 +1,22 @@
+import { Socket } from 'socket.io-client';
+import { JoinRoomResponse } from '../../producers/producerEmits/joinRoom';
+import { JoinConRoomResponse } from '../../producers/producerEmits/joinConRoom';
+export interface JoinRoomClientOptions {
+    socket: Socket;
+    roomName: string;
+    islevel: string;
+    member: string;
+    sec: string;
+    apiUserName: string;
+    consume?: boolean;
+}
+export type JoinRoomClientResponse = JoinRoomResponse | JoinConRoomResponse;
+export type JoinRoomClientType = (options: JoinRoomClientOptions) => Promise<JoinRoomClientResponse>;
+/**
+ * Joins a room by delegating to the producer or consumer join emit based on the consume flag.
+ *
+ * @param {JoinRoomClientOptions} options - The options for joining the room.
+ * @returns {Promise<JoinRoomClientResponse>} The response returned from the server.
+ */
+export declare const joinRoomClient: ({ socket, roomName, islevel, member, sec, apiUserName, consume, }: JoinRoomClientOptions) => Promise<JoinRoomClientResponse>;
+//# sourceMappingURL=joinRoomClient.d.ts.map

package/dist/ProducerClient/producerClientEmits/joinRoomClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinRoomClient.d.ts","sourceRoot":"","sources":["../../../src/ProducerClient/producerClientEmits/joinRoomClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAY,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAe,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAE7F,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAC5E,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAErG;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAU,mEAQlC,qBAAqB,KAAG,OAAO,CAAC,sBAAsB,CAyBxD,CAAC"}

package/dist/ProducerClient/producerClientEmits/updateRoomParametersClient.d.ts

@@ -0,0 +1,85 @@
+import { RtpCapabilities } from 'mediasoup-client/types';
+import { HParamsType, VParamsType, ScreenParamsType, AParamsType, MeetingRoomParams, VidCons, ShowAlert, ResponseJoinRoom, EventType } from '../../types/shared-base-types';
+export interface UpdateRoomParametersClientParameters {
+    rtpCapabilities: RtpCapabilities | null;
+    roomRecvIPs: string[];
+    meetingRoomParams: MeetingRoomParams | null;
+    itemPageLimit: number;
+    audioOnlyRoom: boolean;
+    addForBasic: boolean;
+    screenPageLimit: number;
+    shareScreenStarted: boolean;
+    shared: boolean;
+    targetOrientation: string;
+    vidCons: VidCons;
+    recordingVideoSupport: boolean;
+    frameRate: number;
+    adminPasscode: string;
+    eventType: EventType;
+    youAreCoHost: boolean;
+    autoWave: boolean;
+    forceFullDisplay: boolean;
+    chatSetting: string;
+    meetingDisplayType: string;
+    audioSetting: string;
+    videoSetting: string;
+    screenshareSetting: string;
+    hParams: HParamsType;
+    vParams: VParamsType;
+    screenParams: ScreenParamsType;
+    aParams: AParamsType;
+    islevel: string;
+    showAlert?: ShowAlert;
+    data: ResponseJoinRoom;
+    updateRtpCapabilities: (rtpCapabilities: RtpCapabilities | null) => void;
+    updateRoomRecvIPs: (roomRecvIPs: string[]) => void;
+    updateMeetingRoomParams: (meetingRoomParams: MeetingRoomParams | null) => void;
+    updateItemPageLimit: (limit: number) => void;
+    updateAudioOnlyRoom: (isAudioOnly: boolean) => void;
+    updateAddForBasic: (addForBasic: boolean) => void;
+    updateScreenPageLimit: (limit: number) => void;
+    updateVidCons: (cons: VidCons) => void;
+    updateFrameRate: (frameRate: number) => void;
+    updateAdminPasscode: (passcode: string) => void;
+    updateEventType: (eventType: EventType) => void;
+    updateYouAreCoHost: (coHost: boolean) => void;
+    updateAutoWave: (autoWave: boolean) => void;
+    updateForceFullDisplay: (forceFull: boolean) => void;
+    updateChatSetting: (setting: string) => void;
+    updateMeetingDisplayType: (type: string) => void;
+    updateAudioSetting: (setting: string) => void;
+    updateVideoSetting: (setting: string) => void;
+    updateScreenshareSetting: (setting: string) => void;
+    updateHParams: (params: HParamsType) => void;
+    updateVParams: (params: VParamsType) => void;
+    updateScreenParams: (params: ScreenParamsType) => void;
+    updateAParams: (params: AParamsType) => void;
+    updateMainHeightWidth: (heightWidth: number) => void;
+    updateTargetResolution: (resolution: string) => void;
+    updateTargetResolutionHost: (resolution: string) => void;
+    updateRecordingAudioPausesLimit: (limit: number) => void;
+    updateRecordingAudioPausesCount: (count: number) => void;
+    updateRecordingAudioSupport: (support: boolean) => void;
+    updateRecordingAudioPeopleLimit: (limit: number) => void;
+    updateRecordingAudioParticipantsTimeLimit: (limit: number) => void;
+    updateRecordingVideoPausesCount: (count: number) => void;
+    updateRecordingVideoPausesLimit: (limit: number) => void;
+    updateRecordingVideoSupport: (support: boolean) => void;
+    updateRecordingVideoPeopleLimit: (limit: number) => void;
+    updateRecordingVideoParticipantsTimeLimit: (limit: number) => void;
+    updateRecordingAllParticipantsSupport: (support: boolean) => void;
+    updateRecordingVideoParticipantsSupport: (support: boolean) => void;
+    updateRecordingAllParticipantsFullRoomSupport: (support: boolean) => void;
+    updateRecordingVideoParticipantsFullRoomSupport: (support: boolean) => void;
+    updateRecordingPreferredOrientation: (orientation: string) => void;
+    updateRecordingSupportForOtherOrientation: (support: boolean) => void;
+    updateRecordingMultiFormatsSupport: (support: boolean) => void;
+    updateRecordingVideoOptions: (options: string) => void;
+    updateRecordingAudioOptions: (options: string) => void;
+}
+export type UpdateRoomParametersClientOptions = {
+    parameters: UpdateRoomParametersClientParameters;
+};
+export type UpdateRoomParametersClientType = (options: UpdateRoomParametersClientOptions) => void;
+export declare const updateRoomParametersClient: ({ parameters }: UpdateRoomParametersClientOptions) => void;
+//# sourceMappingURL=updateRoomParametersClient.d.ts.map

package/dist/ProducerClient/producerClientEmits/updateRoomParametersClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateRoomParametersClient.d.ts","sourceRoot":"","sources":["../../../src/ProducerClient/producerClientEmits/updateRoomParametersClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AA0BzD,OAAO,EACL,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,SAAS,EACV,MAAM,+BAA+B,CAAC;AAEvC,MAAM,WAAW,oCAAoC;IACnD,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC5C,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,gBAAgB,CAAC;IAC/B,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,IAAI,EAAE,gBAAgB,CAAC;IACvB,qBAAqB,EAAE,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI,KAAK,IAAI,CAAC;IACzE,iBAAiB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACnD,uBAAuB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,KAAK,IAAI,CAAC;IAC/E,mBAAmB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,mBAAmB,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;IACpD,iBAAiB,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,eAAe,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,mBAAmB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,eAAe,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;IAChD,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAC9C,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5C,sBAAsB,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACrD,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,wBAAwB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACjD,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,wBAAwB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC7C,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC7C,kBAAkB,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACvD,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC7C,qBAAqB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,sBAAsB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,0BAA0B,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,2BAA2B,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACxD,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,yCAAyC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnE,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,2BAA2B,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACxD,+BAA+B,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,yCAAyC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnE,qCAAqC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAClE,uCAAuC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACpE,6CAA6C,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1E,+CAA+C,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5E,mCAAmC,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IACnE,yCAAyC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACtE,kCAAkC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/D,2BAA2B,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACvD,2BAA2B,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACxD;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,UAAU,EAAE,oCAAoC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,CAAC,OAAO,EAAE,iCAAiC,KAAK,IAAI,CAAC;AAElG,eAAO,MAAM,0BAA0B,GAAI,gBAAgB,iCAAiC,KAAG,IAqR9F,CAAC"}

package/dist/consumers/addVideosGrid.d.ts

@@ -0,0 +1,10 @@
+export interface AddVideosGridParameters {
+    [key: string]: any;
+}
+export interface AddVideosGridOptions {
+    parameters: AddVideosGridParameters;
+    [key: string]: any;
+}
+export type AddVideosGridType = (options: AddVideosGridOptions) => Promise<void>;
+export declare const addVideosGrid: AddVideosGridType;
+//# sourceMappingURL=addVideosGrid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addVideosGrid.d.ts","sourceRoot":"","sources":["../../src/consumers/addVideosGrid.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,uBAAuB;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,uBAAuB,CAAC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjF,eAAO,MAAM,aAAa,EAAE,iBAE3B,CAAC"}

package/dist/consumers/autoAdjust.d.ts

@@ -0,0 +1,41 @@
+import { EventType } from '../types/types';
+export interface AutoAdjustOptions {
+    n: number;
+    eventType: EventType;
+    shareScreenStarted: boolean;
+    shared: boolean;
+}
+export type AutoAdjustType = (options: AutoAdjustOptions) => Promise<number[]>;
+/**
+ * Adjusts values based on the provided options and the number of participants.
+ *
+ * @function
+ * @async
+ * @param {AutoAdjustOptions} options - The options for auto adjustment.
+ * @param {number} options.n - The number of participants.
+ * @param {string} options.eventType - The type of event (e.g., 'broadcast', 'chat', 'conference').
+ * @param {boolean} options.shareScreenStarted - Indicates if screen sharing has started.
+ * @param {boolean} options.shared - Indicates if something is shared.
+ *
+ * @returns {Promise<number[]>} A promise that resolves to an array containing the adjusted values.
+ *
+ * @example
+ * import { autoAdjust } from 'mediasfu-reactjs';
+ *
+ * const options = {
+ *   n: 10,
+ *   eventType: 'conference',
+ *   shareScreenStarted: false,
+ *   shared: false,
+ * };
+ *
+ * autoAdjust(options)
+ *   .then(values => {
+ *     console.log('Adjusted values:', values);
+ *   })
+ *   .catch(error => {
+ *     console.error('Error adjusting values:', error);
+ *   });
+ */
+export declare function autoAdjust({ n, eventType, shareScreenStarted, shared }: AutoAdjustOptions): Promise<number[]>;
+//# sourceMappingURL=autoAdjust.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"autoAdjust.d.ts","sourceRoot":"","sources":["../../src/consumers/autoAdjust.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,WAAW,iBAAiB;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,SAAS,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAG/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,wBAAsB,UAAU,CAAC,EAC/B,CAAC,EACD,SAAS,EAAE,kBAAkB,EAAE,MAAM,EACtC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAoDvC"}

package/dist/consumers/calculateRowsAndColumns.d.ts

@@ -0,0 +1,24 @@
+export interface CalculateRowsAndColumnsOptions {
+    n: number;
+}
+export type CalculateRowsAndColumnsType = (options: CalculateRowsAndColumnsOptions) => [number, number];
+/**
+ * Calculates the number of rows and columns needed to display a given number of items in a grid.
+ *
+ * @function
+ * @param {CalculateRowsAndColumnsOptions} options - The options for calculating rows and columns.
+ * @param {number} options.n - The number of items to display.
+ * @returns {[number, number]} A tuple containing the number of rows and columns.
+ *
+ * @example
+ * import { calculateRowsAndColumns } from 'mediasfu-reactjs';
+ *
+ * const options = {
+ *   n: 10,
+ * };
+ *
+ * const [rows, cols] = calculateRowsAndColumns(options);
+ * console.log(`Rows: ${rows}, Columns: ${cols}`); // Outputs: Rows: 4, Columns: 3
+ */
+export declare function calculateRowsAndColumns({ n }: CalculateRowsAndColumnsOptions): [number, number];
+//# sourceMappingURL=calculateRowsAndColumns.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"calculateRowsAndColumns.d.ts","sourceRoot":"","sources":["../../src/consumers/calculateRowsAndColumns.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,8BAA8B;IAC7C,CAAC,EAAE,MAAM,CAAC;CACX;AAGD,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,EAAE,8BAA8B,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAExG;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,CAAC,EAAE,EAAE,8BAA8B,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAyB/F"}