@videosdk.live/react-sdk 0.1.82 → 0.1.84

package/dist/types/deviceInfo.d.ts

@@ -0,0 +1,28 @@
+export class DeviceInfo extends MediaDeviceInfo {
+}
+export class CameraDeviceInfo extends DeviceInfo {
+}
+export class MicrophoneDeviceInfo extends DeviceInfo {
+}
+export class PlaybackDeviceInfo extends DeviceInfo {
+}
+declare class MediaDeviceInfo {
+    constructor(deviceId: any, groupId: any, kind: any, label: any);
+    /**
+     * @type {string}
+     */
+    deviceId: string;
+    /**
+     * @type {string}
+     */
+    groupId: string;
+    /**
+     * @type {string}
+     */
+    kind: string;
+    /**
+     * @type {string}
+     */
+    label: string;
+}
+export {};

package/dist/types/index.d.ts

@@ -6,6 +6,13 @@
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 import { Connection } from './connection';
+import {
+  CameraDeviceInfo,
+  DeviceInfo,
+  MicrophoneDeviceInfo,
+  PlaybackDeviceInfo
+} from './deviceInfo';
+import { Permission } from './permission';
 import { Meeting } from './meeting';
 import { Participant } from './participant';
 import { Stream } from './stream';
@@ -62,7 +69,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,
@@ -70,7 +77,7 @@ export function MeetingProvider({
   token,
   joinWithoutUserInteraction,
   reinitialiseMeetingOnConfigChange: _reinitialiseMeetingOnConfigChange,
-  deviceInfo,
+  deviceInfo
 }: {
   children: any;
   config: {
@@ -188,7 +195,7 @@ export function MeetingConsumer({
   onRecordingStateChanged,
   onLivestreamStateChanged,
   onMeetingStateChanged,
-  onParticipantModeChanged,
+  onParticipantModeChanged
 }: {
   children: any;
   onParticipantJoined?: (participant: Participant) => void;
@@ -200,7 +207,7 @@ export function MeetingConsumer({
     participantId,
     name,
     allow,
-    deny,
+    deny
   }: {
     participantId: string;
     name: string;
@@ -209,7 +216,7 @@ export function MeetingConsumer({
   }) => void;
   onEntryResponded?: ({
     participantId,
-    decision,
+    decision
   }: {
     participantId: string;
     decision: string;
@@ -232,7 +239,7 @@ export function MeetingConsumer({
   onWebcamRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -241,7 +248,7 @@ export function MeetingConsumer({
   onMicRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -250,7 +257,7 @@ export function MeetingConsumer({
   onPinStateChanged?: ({
     participantId,
     state,
-    pinnedBy,
+    pinnedBy
   }: {
     participantId: string;
     state: { share: boolean; cam: boolean };
@@ -266,56 +273,88 @@ 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';
   }) => void;
 }): any;
 
+/**
+ *
+ * ---
+ * @param onDeviceChanged - It's a callback which gets triggered whenever a media device such as a camera, microphone, or speaker is connected to or removed from the system.
+ *
+ * **Code Example :**
+ * ```js
+ * function onDeviceChanged(devices) {
+ *   console.log("onDeviceChanged", devices);
+ * }
+ * const {} = useMediaDevice({
+ *   onDeviceChanged
+ * });
+ * ```
+ * ---
+ * @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;
+}): {
+  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>>;
+};
+
 /**
  *
  * @param participantId - Id of the participant.
@@ -380,14 +419,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;
@@ -396,13 +435,13 @@ export function useParticipant(
     onVideoQualityChanged?: ({
       peerId,
       prevQuality,
-      currentQuality,
+      currentQuality
     }: {
       peerId: string;
       prevQuality: 'low' | 'med' | 'high';
       currentQuality: 'low' | 'med' | 'high';
     }) => void;
-  },
+  }
 ): {
   displayName: string;
   participant: Participant;
@@ -429,13 +468,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;
@@ -592,7 +637,7 @@ export function useMeeting({
   onRecordingStateChanged,
   onLivestreamStateChanged,
   onMeetingStateChanged,
-  onParticipantModeChanged,
+  onParticipantModeChanged
 }?: {
   onParticipantJoined?: (participant: Participant) => void;
   onParticipantLeft?: (participant: Participant) => void;
@@ -603,7 +648,7 @@ export function useMeeting({
     participantId,
     name,
     allow,
-    deny,
+    deny
   }: {
     participantId: string;
     name: string;
@@ -612,7 +657,7 @@ export function useMeeting({
   }) => void;
   onEntryResponded?: ({
     participantId,
-    decision,
+    decision
   }: {
     participantId: string;
     decision: string;
@@ -635,7 +680,7 @@ export function useMeeting({
   onWebcamRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -644,7 +689,7 @@ export function useMeeting({
   onMicRequested?: ({
     participantId,
     accept,
-    reject,
+    reject
   }: {
     participantId: string;
     accept: () => void;
@@ -653,7 +698,7 @@ export function useMeeting({
   onPinStateChanged?: ({
     participantId,
     state,
-    pinnedBy,
+    pinnedBy
   }: {
     participantId: string;
     state: { share: boolean; cam: boolean };
@@ -669,50 +714,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';
@@ -769,7 +814,7 @@ export function useMeeting({
       theme: 'DEFAULT' | 'DARK' | 'LIGHT';
       quality: 'low' | 'med' | 'high';
       mode: 'video-and-audio' | 'audio';
-    },
+    }
   ) => void;
   stopRecording: () => void;
   startLiveStream: (
@@ -784,7 +829,7 @@ export function useMeeting({
         gridSize: number;
       };
       theme: 'DEFAULT' | 'DARK' | 'LIGHT';
-    },
+    }
   ) => void;
   stopLiveStream: () => void;
   startHls: (config?: {
@@ -822,7 +867,7 @@ export function useMeeting({
   seekVideo: ({ currentTime }: { currentTime: number }) => void;
   connectTo: ({
     meetingId,
-    payload,
+    payload
   }: {
     meetingId: string;
     payload: string;
@@ -861,7 +906,7 @@ export function usePubSub(
   topic: string,
   {
     onMessageReceived,
-    onOldMessagesReceived,
+    onOldMessagesReceived
   }?: {
     onMessageReceived?: (message: {
       id: string;
@@ -881,20 +926,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;
@@ -908,19 +953,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.
  * ---
@@ -956,23 +1007,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>;
 
@@ -1015,29 +1066,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;
@@ -1072,19 +1123,42 @@ 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>;
 
+/**
+ * @param timeoutDuration - This will accept the timeoutDuration.
+ *
+ * **Code Example**
+ * ```js
+ * import { getNetworkStats } from "@videosdk.live/react-sdk";
+ *
+ *  try{
+ *    const options = { timeoutDuration: 45000 };
+ *    const networkStats = await VideoSDK.getNetworkStats(options);
+ *    console.log("networkStats", networkStats);
+ *  }catch(Ex)
+ *  {
+ *    console.log("exception",Ex);
+ *  }
+ * ```
+ */
+export function getNetworkStats({
+  timeoutDuration
+}?: {
+  timeoutDuration?: number | undefined;
+}): Promise<{ downloadSpeed: number; uploadSpeed: number }>;
+
 export const Constants: {
   errors: {
     INVALID_API_KEY: number;
@@ -1137,4 +1211,10 @@ export const Constants: {
     CONFERENCE: string;
     VIEWER: string;
   };
+  permission: {
+    AUDIO: Permission;
+    VIDEO: Permission;
+    AUDIO_AND_VIDEO: Permission;
+  };
 };
+export { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo };

package/dist/types/permission.d.ts

@@ -0,0 +1,5 @@
+export declare enum Permission {
+    AUDIO = "audio",
+    VIDEO = "video",
+    AUDIO_AND_VIDEO = "audio_video"
+  } 

package/package.json

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