@videosdk.live/react-sdk 0.1.83 → 0.1.85

package/dist/types/index.d.ts

@@ -6,7 +6,12 @@
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 import { Connection } from './connection';
-import { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo, PlaybackDeviceInfo } from './deviceInfo';
+import {
+  CameraDeviceInfo,
+  DeviceInfo,
+  MicrophoneDeviceInfo,
+  PlaybackDeviceInfo
+} from './deviceInfo';
 import { Permission } from './permission';
 import { Meeting } from './meeting';
 import { Participant } from './participant';
@@ -54,6 +59,8 @@ import { Stream } from './stream';
  * ---
  * @param config.defaultCamera - [For Mobile Browser] It sets the initial camera orientation. Use 'front' to initialize the camera with the front-facing (selfie) mode, or 'back' to initialize it with the rear-facing (main) mode.
  * ---
+ * @param config.debugMode - Enables users to view detailed error logs generated by our SDK directly on the VideoSDK's dashboard.
+ * ---
  * @param token -
  * - You can generate a token in two ways:
  *
@@ -64,7 +71,7 @@ import { Stream } from './stream';
  * - This is a boolean flag, when set to true, allows a participant to join a meeting directly without explicitly calling the join() function.
  *
  * - This is an OPTIONAL parameter. By default, it is set to false meaning, user has to manually call the join().
- * 
+ *
  */
 export function MeetingProvider({
   children,
@@ -72,7 +79,7 @@ export function MeetingProvider({
   token,
   joinWithoutUserInteraction,
   reinitialiseMeetingOnConfigChange: _reinitialiseMeetingOnConfigChange,
-  deviceInfo,
+  deviceInfo
 }: {
   children: any;
   config: {
@@ -90,6 +97,7 @@ export function MeetingProvider({
     mode?: 'CONFERENCE' | 'VIEWER';
     metaData?: object;
     defaultCamera?: 'front' | 'back';
+    debugMode: boolean;
   };
   token: string;
   joinWithoutUserInteraction?: boolean;
@@ -190,7 +198,7 @@ export function MeetingConsumer({
   onRecordingStateChanged,
   onLivestreamStateChanged,
   onMeetingStateChanged,
-  onParticipantModeChanged,
+  onParticipantModeChanged
 }: {
   children: any;
   onParticipantJoined?: (participant: Participant) => void;
@@ -202,7 +210,7 @@ export function MeetingConsumer({
     participantId,
     name,
     allow,
-    deny,
+    deny
   }: {
     participantId: string;
     name: string;
@@ -211,7 +219,7 @@ export function MeetingConsumer({
   }) => void;
   onEntryResponded?: ({
     participantId,
-    decision,
+    decision
   }: {
     participantId: string;
     decision: string;
@@ -234,7 +242,7 @@ export function MeetingConsumer({
   onWebcamRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -243,7 +251,7 @@ export function MeetingConsumer({
   onMicRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -252,7 +260,7 @@ export function MeetingConsumer({
   onPinStateChanged?: ({
     participantId,
     state,
-    pinnedBy,
+    pinnedBy
   }: {
     participantId: string;
     state: { share: boolean; cam: boolean };
@@ -268,50 +276,50 @@ export function MeetingConsumer({
     status,
     downstreamUrl,
     playbackHlsUrl,
-    livestreamUrl,
+    livestreamUrl
   }: {
     status:
-    | 'HLS_STARTING'
-    | 'HLS_STARTED'
-    | 'HLS_PLAYABLE'
-    | 'HLS_STOPPING'
-    | 'HLS_STOPPED';
+      | 'HLS_STARTING'
+      | 'HLS_STARTED'
+      | 'HLS_PLAYABLE'
+      | 'HLS_STOPPING'
+      | 'HLS_STOPPED';
     downstreamUrl?: string;
     playbackHlsUrl?: string;
     livestreamUrl?: string;
   }) => void;
   onRecordingStateChanged?: ({
-    status,
+    status
   }: {
     status:
-    | 'RECORDING_STARTING'
-    | 'RECORDING_STARTED'
-    | 'RECORDING_STOPPING'
-    | 'RECORDING_STOPPED';
+      | 'RECORDING_STARTING'
+      | 'RECORDING_STARTED'
+      | 'RECORDING_STOPPING'
+      | 'RECORDING_STOPPED';
   }) => void;
   onLivestreamStateChanged?: ({
-    status,
+    status
   }: {
     status:
-    | 'LIVESTREAM_STARTING'
-    | 'LIVESTREAM_STARTED'
-    | 'LIVESTREAM_STOPPING'
-    | 'LIVESTREAM_STOPPED';
+      | 'LIVESTREAM_STARTING'
+      | 'LIVESTREAM_STARTED'
+      | 'LIVESTREAM_STOPPING'
+      | 'LIVESTREAM_STOPPED';
   }) => void;
   onMeetingStateChanged?: ({
-    state,
+    state
   }: {
     state:
-    | 'CONNECTING'
-    | 'CONNECTED'
-    | 'FAILED'
-    | 'DISCONNECTED'
-    | 'CLOSING'
-    | 'CLOSED';
+      | 'CONNECTING'
+      | 'CONNECTED'
+      | 'FAILED'
+      | 'DISCONNECTED'
+      | 'CLOSING'
+      | 'CLOSED';
   }) => void;
   onParticipantModeChanged?: ({
     participantId,
-    mode,
+    mode
   }: {
     participantId: string;
     mode: 'CONFERENCE' | 'VIEWER';
@@ -335,19 +343,19 @@ export function MeetingConsumer({
  * ---
  * @returns This will returns methods and events associated with media devices and permissions. You can refer this [API Reference](https://docs.videosdk.live/react/api/sdk-reference/use-mediaDevice/introduction)
  */
-export function useMediaDevice(
-  {
-    onDeviceChanged,
-  }?: {
-    onDeviceChanged?: (devices: Promise<Array<DeviceInfo>>) => void;
-  },
-): {
+export function useMediaDevice({
+  onDeviceChanged
+}?: {
+  onDeviceChanged?: (devices: Promise<Array<DeviceInfo>>) => void;
+}): {
   getDevices: () => Promise<Array<DeviceInfo>>;
   getCameras: () => Promise<Array<CameraDeviceInfo>>;
   getMicrophones: () => Promise<Array<MicrophoneDeviceInfo>>;
   getPlaybackDevices: () => Promise<Array<PlaybackDeviceInfo>>;
   checkPermissions: (permissions?: Permission) => Promise<Map<string, boolean>>;
-  requestPermission: (permissions?: Permission) => Promise<Map<string, boolean>>;
+  requestPermission: (
+    permissions?: Permission
+  ) => Promise<Map<string, boolean>>;
 };
 
 /**
@@ -414,14 +422,14 @@ export function useParticipant(
     onStreamEnabled,
     onStreamDisabled,
     onMediaStatusChanged,
-    onVideoQualityChanged,
+    onVideoQualityChanged
   }?: {
     onStreamDisabled?: (stream: Stream) => void;
     onStreamEnabled?: (stream: Stream) => void;
     onMediaStatusChanged?: ({
       kind,
       peerId,
-      newStatus,
+      newStatus
     }: {
       kind: 'audio' | 'video';
       peerId: string;
@@ -430,13 +438,13 @@ export function useParticipant(
     onVideoQualityChanged?: ({
       peerId,
       prevQuality,
-      currentQuality,
+      currentQuality
     }: {
       peerId: string;
       prevQuality: 'low' | 'med' | 'high';
       currentQuality: 'low' | 'med' | 'high';
     }) => void;
-  },
+  }
 ): {
   displayName: string;
   participant: Participant;
@@ -463,13 +471,19 @@ export function useParticipant(
   enableWebcam: () => void;
   disableWebcam: () => void;
   remove: () => void;
-  captureImage: ({ height, width }: { height?: number, width?: number }) => Promise<string | null>;
+  captureImage: ({
+    height,
+    width
+  }: {
+    height?: number;
+    width?: number;
+  }) => Promise<string | null>;
   pin: (data: 'SHARE_AND_CAM' | 'CAM' | 'SHARE') => void;
   unpin: (data: 'SHARE_AND_CAM' | 'CAM' | 'SHARE') => void;
   switchTo: ({
     meetingId,
     payload,
-    token,
+    token
   }: {
     meetingId: string;
     payload: string;
@@ -626,7 +640,7 @@ export function useMeeting({
   onRecordingStateChanged,
   onLivestreamStateChanged,
   onMeetingStateChanged,
-  onParticipantModeChanged,
+  onParticipantModeChanged
 }?: {
   onParticipantJoined?: (participant: Participant) => void;
   onParticipantLeft?: (participant: Participant) => void;
@@ -637,7 +651,7 @@ export function useMeeting({
     participantId,
     name,
     allow,
-    deny,
+    deny
   }: {
     participantId: string;
     name: string;
@@ -646,7 +660,7 @@ export function useMeeting({
   }) => void;
   onEntryResponded?: ({
     participantId,
-    decision,
+    decision
   }: {
     participantId: string;
     decision: string;
@@ -669,7 +683,7 @@ export function useMeeting({
   onWebcamRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -678,7 +692,7 @@ export function useMeeting({
   onMicRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -687,7 +701,7 @@ export function useMeeting({
   onPinStateChanged?: ({
     participantId,
     state,
-    pinnedBy,
+    pinnedBy
   }: {
     participantId: string;
     state: { share: boolean; cam: boolean };
@@ -703,50 +717,50 @@ export function useMeeting({
     status,
     downstreamUrl,
     playbackHlsUrl,
-    livestreamUrl,
+    livestreamUrl
   }: {
     status:
-    | 'HLS_STARTING'
-    | 'HLS_STARTED'
-    | 'HLS_PLAYABLE'
-    | 'HLS_STOPPING'
-    | 'HLS_STOPPED';
+      | 'HLS_STARTING'
+      | 'HLS_STARTED'
+      | 'HLS_PLAYABLE'
+      | 'HLS_STOPPING'
+      | 'HLS_STOPPED';
     downstreamUrl?: string;
     playbackHlsUrl?: string;
     livestreamUrl?: string;
   }) => void;
   onRecordingStateChanged?: ({
-    status,
+    status
   }: {
     status:
-    | 'RECORDING_STARTING'
-    | 'RECORDING_STARTED'
-    | 'RECORDING_STOPPING'
-    | 'RECORDING_STOPPED';
+      | 'RECORDING_STARTING'
+      | 'RECORDING_STARTED'
+      | 'RECORDING_STOPPING'
+      | 'RECORDING_STOPPED';
   }) => void;
   onLivestreamStateChanged?: ({
-    status,
+    status
   }: {
     status:
-    | 'LIVESTREAM_STARTING'
-    | 'LIVESTREAM_STARTED'
-    | 'LIVESTREAM_STOPPING'
-    | 'LIVESTREAM_STOPPED';
+      | 'LIVESTREAM_STARTING'
+      | 'LIVESTREAM_STARTED'
+      | 'LIVESTREAM_STOPPING'
+      | 'LIVESTREAM_STOPPED';
   }) => void;
   onMeetingStateChanged?: ({
-    state,
+    state
   }: {
     state:
-    | 'CONNECTING'
-    | 'CONNECTED'
-    | 'FAILED'
-    | 'DISCONNECTED'
-    | 'CLOSING'
-    | 'CLOSED';
+      | 'CONNECTING'
+      | 'CONNECTED'
+      | 'FAILED'
+      | 'DISCONNECTED'
+      | 'CLOSING'
+      | 'CLOSED';
   }) => void;
   onParticipantModeChanged?: ({
     participantId,
-    mode,
+    mode
   }: {
     participantId: string;
     mode: 'CONFERENCE' | 'VIEWER';
@@ -803,7 +817,7 @@ export function useMeeting({
       theme: 'DEFAULT' | 'DARK' | 'LIGHT';
       quality: 'low' | 'med' | 'high';
       mode: 'video-and-audio' | 'audio';
-    },
+    }
   ) => void;
   stopRecording: () => void;
   startLiveStream: (
@@ -818,7 +832,7 @@ export function useMeeting({
         gridSize: number;
       };
       theme: 'DEFAULT' | 'DARK' | 'LIGHT';
-    },
+    }
   ) => void;
   stopLiveStream: () => void;
   startHls: (config?: {
@@ -856,7 +870,7 @@ export function useMeeting({
   seekVideo: ({ currentTime }: { currentTime: number }) => void;
   connectTo: ({
     meetingId,
-    payload,
+    payload
   }: {
     meetingId: string;
     payload: string;
@@ -895,7 +909,7 @@ export function usePubSub(
   topic: string,
   {
     onMessageReceived,
-    onOldMessagesReceived,
+    onOldMessagesReceived
   }?: {
     onMessageReceived?: (message: {
       id: string;
@@ -915,20 +929,20 @@ export function usePubSub(
         timestamp: string;
         topic: string;
         payload: object;
-      }>,
+      }>
     ) => void;
-  },
+  }
 ): {
   publish: (
     message: string,
     {
       persist,
-      sendOnly,
+      sendOnly
     }: {
       persist: boolean;
       sendOnly?: Array<String>;
     },
-    payload?: object,
+    payload?: object
   ) => void;
   messages: Array<{
     id: string;
@@ -942,19 +956,25 @@ export function usePubSub(
 };
 
 export function useFile(): {
-  uploadBase64File: ({ base64Data, token, fileName }: {
+  uploadBase64File: ({
+    base64Data,
+    token,
+    fileName
+  }: {
     base64Data: string;
     token: string;
     fileName: string;
   }) => Promise<string | null>;
 
-  fetchBase64File: ({ url, token }: {
+  fetchBase64File: ({
+    url,
+    token
+  }: {
     url: string;
     token: string;
   }) => Promise<string | null>;
 };
 
-
 /**
  * @param microphoneId - It will be the id of the mic from which the audio should be captured.
  * ---
@@ -990,23 +1010,23 @@ export function useFile(): {
 export function createMicrophoneAudioTrack({
   noiseConfig,
   encoderConfig,
-  microphoneId,
+  microphoneId
 }: {
   noiseConfig?:
-  | {
-    echoCancellation: boolean;
-    autoGainControl: boolean;
-    noiseSuppression: boolean;
-  }
-  | undefined;
+    | {
+        echoCancellation: boolean;
+        autoGainControl: boolean;
+        noiseSuppression: boolean;
+      }
+    | undefined;
   encoderConfig?:
-  | 'speech_low_quality'
-  | 'speech_standard'
-  | 'music_standard'
-  | 'standard_stereo'
-  | 'high_quality'
-  | 'high_quality_stereo'
-  | undefined;
+    | 'speech_low_quality'
+    | 'speech_standard'
+    | 'music_standard'
+    | 'standard_stereo'
+    | 'high_quality'
+    | 'high_quality_stereo'
+    | undefined;
   microphoneId?: string | undefined;
 }): Promise<MediaStream>;
 
@@ -1049,29 +1069,29 @@ export function createCameraVideoTrack({
   encoderConfig,
   facingMode,
   optimizationMode,
-  multiStream,
+  multiStream
 }: {
   cameraId?: string | undefined;
   encoderConfig?:
-  | 'h90p_w160p'
-  | 'h180p_w320p'
-  | 'h216p_w384p'
-  | 'h360p_w640p'
-  | 'h540p_w960p'
-  | 'h720p_w1280p'
-  | 'h1080p_w1920p'
-  | 'h1440p_w2560p'
-  | 'h2160p_w3840p'
-  | 'h120p_w160p'
-  | 'h180p_w240p'
-  | 'h240p_w320p'
-  | 'h360p_w480p'
-  | 'h480p_w640p'
-  | 'h540p_w720p'
-  | 'h720p_w960p'
-  | 'h1080p_w1440p'
-  | 'h1440p_w1920p'
-  | undefined;
+    | 'h90p_w160p'
+    | 'h180p_w320p'
+    | 'h216p_w384p'
+    | 'h360p_w640p'
+    | 'h540p_w960p'
+    | 'h720p_w1280p'
+    | 'h1080p_w1920p'
+    | 'h1440p_w2560p'
+    | 'h2160p_w3840p'
+    | 'h120p_w160p'
+    | 'h180p_w240p'
+    | 'h240p_w320p'
+    | 'h360p_w480p'
+    | 'h480p_w640p'
+    | 'h540p_w720p'
+    | 'h720p_w960p'
+    | 'h1080p_w1440p'
+    | 'h1440p_w1920p'
+    | undefined;
   facingMode?: 'user' | 'environment' | undefined;
   optimizationMode?: 'text' | 'motion' | 'detail' | undefined;
   multiStream?: boolean;
@@ -1106,15 +1126,15 @@ export function createCameraVideoTrack({
 export function createScreenShareVideoTrack({
   encoderConfig,
   optimizationMode,
-  withAudio,
+  withAudio
 }: {
   encoderConfig?:
-  | 'h360p_30fps'
-  | 'h720p_5fps'
-  | 'h720p_15fps'
-  | 'h1080p_15fps'
-  | 'h1080p_30fps'
-  | undefined;
+    | 'h360p_30fps'
+    | 'h720p_5fps'
+    | 'h720p_15fps'
+    | 'h1080p_15fps'
+    | 'h1080p_30fps'
+    | undefined;
   optimizationMode?: 'text' | 'motion' | 'detail' | undefined;
   withAudio?: 'enable' | 'disable';
 }): Promise<MediaStream>;
@@ -1127,7 +1147,7 @@ export function createScreenShareVideoTrack({
  * import { getNetworkStats } from "@videosdk.live/react-sdk";
  *
  *  try{
- *    const options = { timeoutDuration: 45000 }; 
+ *    const options = { timeoutDuration: 45000 };
  *    const networkStats = await VideoSDK.getNetworkStats(options);
  *    console.log("networkStats", networkStats);
  *  }catch(Ex)
@@ -1142,7 +1162,7 @@ export function getNetworkStats({
   timeoutDuration?:
   | number
   | undefined;
-}): Promise<{downloadSpeed: number,uploadSpeed: number}>;
+}): Promise<{ downloadSpeed: number, uploadSpeed: number }>;
 
 export const Constants: {
   errors: {
@@ -1172,6 +1192,25 @@ export const Constants: {
     ERROR_GET_VIDEO_MEDIA_PERMISSION_DENIED: number;
     ERROR_GET_AUDIO_MEDIA_PERMISSION_DENIED: number;
     ERROR_GET_DISPLAY_MEDIA_PERMISSION_DENIED: number;
+    ERROR_CAMERA_ACCESS_DENIED_OR_DISMISSED: number;
+    ERROR_MICROPHONE_ACCESS_DENIED_OR_DISMISSED: number;
+    ERROR_CAMERA_PERMISSION_DENIED_BY_OS: number;
+    ERROR_MICROPHONE_PERMISSION_DENIED_BY_OS: number;
+    ERROR_CAMERA_NOT_FOUND: number;
+    ERROR_MICROPHONE_NOT_FOUND: number;
+    ERROR_CAMERA_IN_USE: number;
+    ERROR_MICROPHONE_IN_USE: number;
+    ERROR_CAMERA_PERMISSION_OR_AUTOPLAY_ISSUE: number;
+    ERROR_VIDEO_SOURCE_INITIATION_FAILED: number;
+    ERROR_WEBCAM_TRACK_ENDED: number;
+    ERROR_MICROPHONE_TRACK_ENDED: number;
+    ERROR_INVALID_CUSTOM_VIDEO_TRACK: number;
+    ERROR_INVALID_CUSTOM_AUDIO_TRACK: number;
+    ERROR_CUSTOM_VIDEO_TRACK_ENDED: number;
+    ERROR_CUSTOM_AUDIO_TRACK_ENDED: number;
+    ERROR_CAMERA_ACCESS_UNAVAILABLE: number;
+    ERROR_MICROPHONE_ACCESS_UNAVAILABLE: number;
+    ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED: number;
   };
   recordingEvents: {
     RECORDING_STARTING: string;
@@ -1202,3 +1241,4 @@ export const Constants: {
     AUDIO_AND_VIDEO: Permission;
   };
 };
+export { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videosdk.live/react-sdk",
-  "version": "0.1.83",
+  "version": "0.1.85",
   "license": "ISC",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
@@ -73,7 +73,7 @@
     }
   },
   "dependencies": {
-    "@videosdk.live/js-sdk": "0.0.80",
+    "@videosdk.live/js-sdk": "0.0.82",
     "events": "^3.3.0"
   }
 }