@videosdk.live/react-sdk 0.7.0 → 0.8.0

package/dist/types/agentParticipant.d.ts

@@ -0,0 +1,138 @@
+export class AgentParticipant {
+  /**
+   * @description This represents the participant's ID
+   */
+  id: string;
+  /**
+   * @description This represents the participant's name
+   */
+  displayName: string;
+  /**
+   * @description This represents the all the Streams that the participant is producing
+   *
+   */
+  streams: Map<string, Stream>;
+  /**
+   * @description This represents whether the participant is an agent.
+   */
+  isAgent: boolean;
+  /**
+   * @description This represents the agent ID of the agentParticipant.
+   */
+  agentId: string;
+  /**
+   * @description This represents participant's current pin state
+   *
+   */
+  pinState: {
+    cam: boolean;
+    share: boolean;
+  };
+  /**
+   * @description This represents participant's current webcam status
+   */
+  webcamOn: boolean;
+  /**
+   * @description This represents participant's current mic status
+   *
+   */
+  micOn: boolean;
+  /**
+   * @description This represents participant's current mode
+   *
+   */
+  mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
+  /**
+   * @description This represents metaData which is passed in MeetingProvider
+   *
+   */
+  metaData: object;
+
+  /**
+   * @description This method can be used to kickout a participant from the meeting
+   */
+  remove(): void;
+
+  /**
+   * @param type If `SHARE_AND_CAM` is provided, it will pin screenshare and camera of the participant.
+   * If `CAM` is provided, it will only pin the participant's camera, If `SHARE` is provided, it will only pin the participant's screen share
+   */
+  pin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void;
+  /**
+   * @param type   If `SHARE_AND_CAM` is provided, it will unpin screenshare and camera of the participant.
+   * If `CAM` is provided, it will only unpin the participant's camera, If `SHARE` is provided, it will only unpin the participant's screen share
+   */
+  unpin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void;
+  /**
+   * @description This method returns the Video Statistics of the participant.
+   * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
+   */
+  getVideoStats(): Promise<
+    Array<{
+      bitrate: number;
+      rtt: number;
+      network: string;
+      codec: string;
+      jitter: number;
+      limitation: any;
+      totalPackets: number;
+      packetsLost: number;
+      concealmentEvents: number;
+      insertedSamplesForDecelaration: number;
+      removedSamplesForAccelaration: number;
+      size: any;
+      currentSpatialLayer: number;
+      currentTemporalLayer: number;
+      preferredSpatialLayer: number;
+      preferredTemporalLayer: number;
+    }>
+  >;
+  /**
+   * @description This method returns the Audio Statistics of the participant.
+   * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
+   */
+  getAudioStats(): Promise<
+    Array<{
+      bitrate: number;
+      rtt: number;
+      network: string;
+      codec: string;
+      jitter: number;
+      totalPackets: number;
+      packetsLost: number;
+      concealmentEvents: number;
+      insertedSamplesForDecelaration: number;
+      removedSamplesForAccelaration: number;
+      size: any;
+    }>
+  >;
+  /**
+   * Add event listener
+   * @param eventType Event name to which you want to subscribe.
+   * @param listener Callback function which will be triggered when the event happens
+   */
+  on(
+    eventType:
+      | "stream-enabled"
+      | "stream-disabled"
+      | "media-status-changed"
+      | "agent-state-changed"
+      | "transcription-received",
+    listener: (data: any) => void
+  ): void;
+  /**
+   * Remove event
+   * @param eventType Event name to which you want to unsubscribe.
+   * @param listener Callback function which was passed while subscribing to the event
+   */
+  off(
+    eventType:
+      | "stream-enabled"
+      | "stream-disabled"
+      | "media-status-changed"
+      | "agent-state-changed"
+      | "transcription-received",
+    listener: (data: any) => void
+  ): void;
+}
+import { Stream } from './stream';

package/dist/types/index.d.ts

@@ -16,6 +16,7 @@ import {
 import { Permission } from './permission';
 import { Meeting } from './meeting';
 import { Participant } from './participant';
+import { AgentParticipant } from './agentParticipant';
 import { Stream } from './stream';
 import { Character, CharacterMode, CharacterState } from './character';
 /**
@@ -420,7 +421,7 @@ export function useMediaDevice({
  *
  * **Code Example :**
  * ```js
- * function onMediaStatusChanged(stream) {
+ * function onMediaStatusChanged(data) {
  *   const { kind, newStatus} = data;
  *   console.log("onMediaStatusChanged", kind, newStatus);
  * }
@@ -435,7 +436,7 @@ export function useMediaDevice({
  *
  * **Code Example :**
  * ```js
- * function onVideoQualityChanged(stream) {
+ * function onVideoQualityChanged(data) {
  *    const { currentQuality, prevQuality } = data;
  *    console.log("onVideoQualityChanged", currentQuality, prevQuality );
  * }
@@ -630,6 +631,167 @@ export function useParticipant(
   >;
 };
 
+/**
+ *
+ * @param participantId - Id of the participant.
+ * ---
+ * @param onStreamEnabled - It's a callback which gets triggered whenever a participant's video, audio or screen share stream is enabled.
+ *
+ * **Code Example :**
+ * ```js
+ * function onStreamEnabled(stream) {
+ *   console.log("onStreamEnabled", stream);
+ * }
+ * const { displayName } = useAgentParticipant(participantId,{
+ *   onStreamEnabled
+ * });
+ * ```
+ * ---
+ * @param onStreamDisabled - It's a callback which gets triggered whenever a participant's video, audio or screen share stream is disabled.
+ *
+ * **Code Example :**
+ *  ```js
+ * function onStreamEnabled(stream) {
+ *   console.log("onStreamEnabled", stream);
+ * }
+ * const { displayName } = useAgentParticipant(participantId,{
+ *   onStreamEnabled
+ * });
+ * ```
+ * ---
+ * @param onMediaStatusChanged - It's a callback which gets triggered whenever a participant's video, audio, screenshare or screenshare audio is disabled or enabled.
+ *
+ * **Code Example :**
+ * ```js
+ * function onMediaStatusChanged(data) {
+ *   const { kind, newStatus} = data;
+ *   console.log("onMediaStatusChanged", kind, newStatus);
+ * }
+ * const { displayName } = useAgentParticipant(participantId,{
+ *     onMediaStatusChanged
+ * });
+ * ```
+ * ---
+ * @param onAgentTranscriptionReceived - It's a callback which gets triggered whenever a participant's transcription is received.
+ * 
+ * **Code Example :**
+ * ```js
+ * function onAgentTranscriptionReceived(data) {
+ *   const { segment, participant } = data;
+ *   const {text, timestamp} = segment;
+ * 
+ *   console.log("onAgentTranscriptionReceived", text, timestamp, participant);
+ * }
+ * const { displayName } = useAgentParticipant(participantId,{
+ *   onAgentTranscriptionReceived
+ * });
+ * ```
+ * ---
+ * @param onAgentStateChanged - It's a callback which gets triggered whenever a participant's agent state is changed.
+ * 
+ * **Code Example :**
+ * ```js
+ * function onAgentStateChanged(data) {
+ *   console.log("onAgentStateChanged", data.state);
+ * }
+ * const { displayName } = useAgentParticipant(participantId,{
+ *   onAgentStateChanged
+ * });
+ * ```
+ * ---
+ * @returns This will return particular participant properties and method. You can refer this [API Reference](https://docs.videosdk.live/react/api/sdk-reference/use-participant/introduction)
+ */
+export function useAgentParticipant(
+  participantId: string,
+  {
+    onStreamEnabled,
+    onStreamDisabled,
+    onMediaStatusChanged,
+    onAgentTranscriptionReceived,
+    onAgentStateChanged
+  }?: {
+    onStreamDisabled?: (stream: Stream) => void;
+    onStreamEnabled?: (stream: Stream) => void;
+    onMediaStatusChanged?: ({
+      kind,
+      peerId,
+      newStatus
+    }: {
+      kind: 'audio' | 'video' | 'share' | 'shareAudio'; 
+      peerId: string;
+      newStatus: boolean;
+    }) => void;
+    onAgentTranscriptionReceived? :({
+      segment : {
+        text,
+        timestamp
+      },
+      participant
+    }:{
+      segment :{
+        text: string;
+        timestamp: number;
+      }
+      participant: Participant | AgentParticipant,
+    }) => void;
+    onAgentStateChanged?:({
+      state
+    }:{
+      state: string;
+    })=>void;
+  }
+): {
+  displayName: string;
+  agentParticipant: AgentParticipant;
+  webcamStream: Stream;
+  micStream: Stream;
+  webcamOn: boolean;
+  micOn: boolean;
+  isActiveSpeaker: boolean;
+  pinState: any;
+  agentState: string;
+  mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
+  remove: () => void;
+  pin: (data: 'SHARE_AND_CAM' | 'CAM' | 'SHARE') => void;
+  unpin: (data: 'SHARE_AND_CAM' | 'CAM' | 'SHARE') => void;
+  getAudioStats: () => Promise<
+    Array<{
+      bitrate: number;
+      rtt: number;
+      network: string;
+      codec: string;
+      jitter: number;
+      limitation: any;
+      totalPackets: number;
+      packetsLost: number;
+      concealmentEvents: number;
+      insertedSamplesForDecelaration: number;
+      removedSamplesForAccelaration: number;
+      size: any;
+    }>
+  >;
+  getVideoStats: () => Promise<
+    Array<{
+      bitrate: number;
+      rtt: number;
+      network: string;
+      codec: string;
+      jitter: number;
+      limitation: any;
+      totalPackets: number;
+      packetsLost: number;
+      concealmentEvents: number;
+      insertedSamplesForDecelaration: number;
+      removedSamplesForAccelaration: number;
+      size: any;
+      currentSpatialLayer: number;
+      currentTemporalLayer: number;
+      preferredSpatialLayer: number;
+      preferredTemporalLayer: number;
+    }>
+  >;
+};
+
 /**
  *
  * @param streamId - ID of the stream.
@@ -2090,5 +2252,11 @@ export const Constants: {
     DEBUG: string;
     ALL: string;
   };
+  AgentState:{
+    IDLE:string;
+    LISTENING:string;
+    THINKING:string;
+    SPEAKING:string;
+  }
 };
 export { CameraDeviceInfo, DeviceInfo, MicrophoneDeviceInfo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videosdk.live/react-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "ISC",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
@@ -76,7 +76,7 @@
     }
   },
   "dependencies": {
-    "@videosdk.live/js-sdk": "0.6.0",
+    "@videosdk.live/js-sdk": "0.7.0",
     "events": "^3.3.0"
   }
 }