@videosdk.live/react-sdk 0.1.105 → 0.2.1

package/dist/types/index.d.ts

@@ -44,13 +44,15 @@ import { Character, CharacterMode, CharacterState } from './character';
  * ---
  * @param config.mode -
  *
- * - There are 2 types of modes:
+ * - There are 3 types of modes:
+ * 
+ * - **SEND_AND_RECV**: Both audio and video streams will be produced and consumed in this mode.
+ * 
+ * - **RECV_ONLY**: Both audio and video streams will be only consumed in this mode.
+ * 
+ * - **SIGNALLING_ONLY**: Audio and video streams will not be produced or consumed in this mode.
  *
- * - **CONFERENCE**: Both audio and video streams will be produced and consumed in this mode.
- *
- * - **VIEWER**: Audio and video streams will not be produced or consumed in this mode.
- *
- * - defaultValue : **CONFERENCE**
+ * - defaultValue : **SEND_AND_RECV**
  *
  * ---
  *
@@ -95,7 +97,7 @@ export function MeetingProvider({
     customCameraVideoTrack?: MediaStream | undefined;
     customMicrophoneAudioTrack?: MediaStream | undefined;
     multiStream?: boolean;
-    mode?: 'CONFERENCE' | 'VIEWER';
+    mode?: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY';
     metaData?: object;
     defaultCamera?: 'front' | 'back';
     debugMode: boolean;
@@ -164,8 +166,9 @@ export function MeetingProvider({
  * @param onParticipantModeChanged -
  * - This event will be triggered when mode gets chanded.
  * - It will pass mode, as an event callback parameter.
- *      - **CONFERENCE** : Both audio and video streams will be produced and consumed in this mode.
- *      - **VIEWER** : Audio and video streams will not be produced or consumed in this mode.
+ *      - **SEND_AND_RECV**: Both audio and video streams will be produced and consumed in this mode.
+ *      - **RECV_ONLY**: Both audio and video streams will be only consumed in this mode.
+ *      - **SIGNALLING_ONLY**: Audio and video streams will not be produced or consumed in this mode.
  */
 
 export function MeetingConsumer({
@@ -280,11 +283,11 @@ export function MeetingConsumer({
     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;
@@ -293,37 +296,37 @@ export function MeetingConsumer({
     status
   }: {
     status:
-      | 'RECORDING_STARTING'
-      | 'RECORDING_STARTED'
-      | 'RECORDING_STOPPING'
-      | 'RECORDING_STOPPED';
+    | 'RECORDING_STARTING'
+    | 'RECORDING_STARTED'
+    | 'RECORDING_STOPPING'
+    | 'RECORDING_STOPPED';
   }) => void;
   onLivestreamStateChanged?: ({
     status
   }: {
     status:
-      | 'LIVESTREAM_STARTING'
-      | 'LIVESTREAM_STARTED'
-      | 'LIVESTREAM_STOPPING'
-      | 'LIVESTREAM_STOPPED';
+    | 'LIVESTREAM_STARTING'
+    | 'LIVESTREAM_STARTED'
+    | 'LIVESTREAM_STOPPING'
+    | 'LIVESTREAM_STOPPED';
   }) => void;
   onMeetingStateChanged?: ({
     state
   }: {
     state:
-      | 'CONNECTING'
-      | 'CONNECTED'
-      | 'FAILED'
-      | 'DISCONNECTED'
-      | 'CLOSING'
-      | 'CLOSED';
+    | 'CONNECTING'
+    | 'CONNECTED'
+    | 'FAILED'
+    | 'DISCONNECTED'
+    | 'CLOSING'
+    | 'CLOSED';
   }) => void;
   onParticipantModeChanged?: ({
     participantId,
     mode
   }: {
     participantId: string;
-    mode: 'CONFERENCE' | 'VIEWER';
+    mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
   }) => void;
 }): any;
 
@@ -460,7 +463,7 @@ export function useParticipant(
   isActiveSpeaker: boolean;
   isMainParticipant: boolean;
   pinState: any;
-  mode: 'CONFERENCE' | 'VIEWER';
+  mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
   consumeMicStreams: () => void;
   consumeWebcamStreams: () => void;
   stopConsumingMicStreams: () => void;
@@ -620,8 +623,9 @@ export function useParticipant(
  * @param onParticipantModeChanged -
  * - This event will be triggered when mode gets chanded.
  * - It will pass mode, as an event callback parameter.
- *      - **CONFERENCE** : Both audio and video streams will be produced and consumed in this mode.
- *      - **VIEWER** : Audio and video streams will not be produced or consumed in this mode.
+ *      - **SEND_AND_RECV**: Both audio and video streams will be produced and consumed in this mode.
+ *      - **RECV_ONLY**: Both audio and video streams will be only consumed in this mode.
+ *      - **SIGNALLING_ONLY**: Audio and video streams will not be produced or consumed in this mode.
  * ---
  * @returns This will return Meeting properties and method. You can refer this [API Reference](https://docs.videosdk.live/react/api/sdk-reference/use-meeting/introduction)
  *
@@ -739,11 +743,11 @@ export function useMeeting({
     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;
@@ -752,37 +756,37 @@ export function useMeeting({
     status
   }: {
     status:
-      | 'RECORDING_STARTING'
-      | 'RECORDING_STARTED'
-      | 'RECORDING_STOPPING'
-      | 'RECORDING_STOPPED';
+    | 'RECORDING_STARTING'
+    | 'RECORDING_STARTED'
+    | 'RECORDING_STOPPING'
+    | 'RECORDING_STOPPED';
   }) => void;
   onLivestreamStateChanged?: ({
     status
   }: {
     status:
-      | 'LIVESTREAM_STARTING'
-      | 'LIVESTREAM_STARTED'
-      | 'LIVESTREAM_STOPPING'
-      | 'LIVESTREAM_STOPPED';
+    | 'LIVESTREAM_STARTING'
+    | 'LIVESTREAM_STARTED'
+    | 'LIVESTREAM_STOPPING'
+    | 'LIVESTREAM_STOPPED';
   }) => void;
   onMeetingStateChanged?: ({
     state
   }: {
     state:
-      | 'CONNECTING'
-      | 'CONNECTED'
-      | 'FAILED'
-      | 'DISCONNECTED'
-      | 'CLOSING'
-      | 'CLOSED';
+    | 'CONNECTING'
+    | 'CONNECTED'
+    | 'FAILED'
+    | 'DISCONNECTED'
+    | 'CLOSING'
+    | 'CLOSED';
   }) => void;
   onParticipantModeChanged?: ({
     participantId,
     mode
   }: {
     participantId: string;
-    mode: 'CONFERENCE' | 'VIEWER';
+    mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
   }) => void;
   onCharacterJoined?: (character: Character) => void;
   onCharacterLeft?: (character: Character) => void;
@@ -905,7 +909,7 @@ export function useMeeting({
   >;
   changeMic: (object: string | MediaStream) => void;
   changeWebcam: (object: string | MediaStream) => void;
-  changeMode(mode: 'CONFERENCE' | 'VIEWER'): void;
+  changeMode(mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'): void;
   startVideo: ({ link }: { link: string }) => void;
   stopVideo: () => void;
   pauseVideo: ({ currentTime }: { currentTime: number }) => void;
@@ -1331,20 +1335,20 @@ export function createMicrophoneAudioTrack({
   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>;
 
@@ -1391,25 +1395,25 @@ export function createCameraVideoTrack({
 }: {
   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;
@@ -1447,12 +1451,12 @@ export function createScreenShareVideoTrack({
   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>;
@@ -1559,8 +1563,13 @@ export const Constants: {
   characterState: CharacterState;
   characterMode: CharacterMode;
   modes: {
-    CONFERENCE: string;
-    VIEWER: string;
+    // Deprecated modes
+    CONFERENCE: string; // Deprecated
+    VIEWER: string; // Deprecated
+    // New modes
+    SEND_AND_RECV: string; // New mode
+    SIGNALLING_ONLY: string; // New mode
+    RECV_ONLY: string
   };
   permission: {
     AUDIO: Permission;

package/dist/types/meeting.d.ts

@@ -89,9 +89,9 @@ export class Meeting {
   join(): void;
 
   /**
-   * @description These method is used to change the participant mode between CONFERENCE and VIEWER
+   * @description This method is used to change the participant mode between SEND_AND_RECV, RECV_ONLY and SIGNALLING_ONLY
    */
-  changeMode(mode: 'CONFERENCE' | 'VIEWER'): void;
+  changeMode(mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'): void;
 
   /**
    * @description These method is used to leave the meeting for local participant

package/dist/types/participant.d.ts

@@ -43,7 +43,7 @@ export class Participant {
    * @description This represents participant's current mode
    *
    */
-  mode: 'CONFERENCE' | 'VIEWER';
+  mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
   /**
    * @description This represents metaData which is passed in MeetingProvider
    *

package/package.json

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