@videosdk.live/react-sdk 0.4.9 → 0.4.11

package/dist/types/index.d.ts

@@ -116,7 +116,8 @@ export function MeetingProvider({
  * ---
  * @param onParticipantJoined - This event callback is trigger when a new participant joins the meeting.
  * ---
- * @param onParticipantLeft - This event callback is trigger when a participant leaves the meeting.
+ * @param onParticipantLeft - This event callback is triggered when a participant leaves the meeting.
+ * - It provides the participant object and an additional reason object describing why the participant left.
  * ---
  * @param onSpeakerChanged -
  * - This event will be emitted when a active speaker changed.
@@ -218,7 +219,7 @@ export function MeetingConsumer({
 }: {
   children: any;
   onParticipantJoined?: (participant: Participant) => void;
-  onParticipantLeft?: (participant: Participant) => void;
+  onParticipantLeft?: (participant: Participant, reason: { message: string, code: number }) => void;
   onSpeakerChanged?: (activeSpeakerId: string | null) => void;
   onPresenterChanged?: (presenterId: string | null) => void;
   onMainParticipantChanged?: (participant: Participant) => void;
@@ -251,7 +252,7 @@ export function MeetingConsumer({
     reliability: string;
   }) => void;
   onMeetingJoined?: () => void;
-  onMeetingLeft?: () => void;
+  onMeetingLeft?: (reason: { message: string, code: number }) => void;
   onLiveStreamStarted?: () => void;
   onLiveStreamStopped?: () => void;
   onVideoStateChanged?: () => void;
@@ -675,7 +676,8 @@ export function useStream(
 /**
  * @param onParticipantJoined - This event callback is trigger when a new participant joins the meeting.
  * ---
- * @param onParticipantLeft - This event callback is trigger when a participant leaves the meeting.
+ * @param onParticipantLeft - This event callback is triggered when a participant leaves the meeting.
+ * - It provides the participant object and an additional reason object describing why the participant left.
  * ---
  * @param onSpeakerChanged -
  * - This event will be emitted when a active speaker changed.
@@ -786,7 +788,7 @@ export function useMeeting({
   onQualityLimitation,
 }?: {
   onParticipantJoined?: (participant: Participant) => void;
-  onParticipantLeft?: (participant: Participant) => void;
+  onParticipantLeft?: (participant: Participant, reason: { message: string, code: number }) => void;
   onSpeakerChanged?: (activeSpeakerId: string | null) => void;
   onPresenterChanged?: (presenterId: string | null) => void;
   onMainParticipantChanged?: (participant: Participant) => void;
@@ -819,7 +821,7 @@ export function useMeeting({
     reliability: string;
   }) => void;
   onMeetingJoined?: () => void;
-  onMeetingLeft?: () => void;
+  onMeetingLeft?: (reason: { message: string, code: number }) => void;
   onLiveStreamStarted?: () => void;
   onLiveStreamStopped?: () => void;
   onVideoStateChanged?: () => void;
@@ -1187,6 +1189,49 @@ export function usePubSub(
   }>;
 };
 
+/**
+ *
+ * @param key - Represents the key for which you want to set the value in the realtime store.
+ * ---
+ * @param onValueChanged - This will get triggered when the value for the given key changes. 
+ * ---
+ * @returns This will return `setValue()` and `getValue()` methods.
+ * ---
+ * **useRealtimeStore example**
+ * ```js
+ *  var key = 'BLOCKED';
+ *
+ *  function onValueChanged({value,updatedBy}) {
+ *    console.log('New Message:', message);
+ *  }
+ *
+ *  const {setValue,getValue} = useRealtimeStore(key, {
+ *    onValueChanged,
+ *  });
+ * ```
+ */
+export function useRealtimeStore(
+  key: string,
+  {
+    onValueChanged,
+  }?: {
+    onValueChanged?: ({
+      value,
+      updatedBy,
+    }: {
+      value: string
+      updatedBy: string,
+    }) => void,
+  }
+): {
+  setValue: ({
+    value
+  }: {
+    value: string;
+  }) => Promise<any>;
+  getValue: () => Promise<string>;
+};
+
 export function useFile(): {
   uploadBase64File: ({
     base64Data,
@@ -1976,5 +2021,22 @@ export const Constants: {
     VIDEO: Permission;
     AUDIO_AND_VIDEO: Permission;
   };
+  leaveReason:{
+    WEBSOCKET_DISCONNECTED: number,
+    REMOVE_PEER: number,
+    REMOVE_PEER_VIEWER_MODE_CHANGED: number,
+    REMOVE_PEER_MEDIA_RELAY_STOP: number,
+    SWITCH_ROOM: number,
+    ROOM_CLOSE: number,
+    UNKNOWN: number,
+    REMOVE_ALL: number,
+    MEETING_END_API: number,
+    REMOVE_PEER_API: number,
+    MANUAL_LEAVE_CALLED: number,
+    WEBSOCKET_CONNECTION_ATTEMPTS_EXHAUSTED: number, 
+    JOIN_ROOM_FAILED: number,
+    SWITCH_ROOM_FAILED: number,
+    CHARACTER_REMOVED: number,
+  }
 };
 export { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videosdk.live/react-sdk",
-  "version": "0.4.9",
+  "version": "0.4.11",
   "license": "ISC",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
@@ -74,7 +74,7 @@
     }
   },
   "dependencies": {
-    "@videosdk.live/js-sdk": "0.3.9",
+    "@videosdk.live/js-sdk": "0.3.11",
     "events": "^3.3.0"
   }
 }