@videosdk.live/react-sdk 0.1.94 → 0.1.95

package/dist/types/character.d.ts

@@ -0,0 +1,96 @@
+import { Participant } from './participant';
+import { Stream } from './stream';
+
+export enum CharacterMode {
+  Text2Text = 'text2text',
+  Speech2Text = 'speech2text',
+  Speech2Speech = 'speech2speech'
+}
+
+export enum CharacterState {
+  CHARACTER_SPEAKING = 'CHARACTER_SPEAKING',
+  CHARACTER_THINKING = 'CHARACTER_THINKING',
+  CHARACTER_LISTENING = 'CHARACTER_LISTENING'
+}
+
+export class Character extends Participant {
+  /**
+   * @description This represents interactionId of interaction
+   */
+  interactionId: string;
+
+  /**
+   * @description This represents the id character participant
+   */
+  id: string;
+
+  /**
+   * @description This represents state of character participant
+   */
+  state: CharacterState;
+
+  /**
+   * @description This represents attached knowledge to character participant
+   */
+  knowledgeBases: string[];
+
+  /**
+   * @description This represents communication mode of character participant
+   */
+  characterMode: CharacterMode;
+
+  /**
+   * @description This represents role of character participant
+   */
+  characterRole: string;
+
+  /**
+   * @description This method can be used to join a character participant in the meeting
+   */
+  join(): Promise<void>;
+
+  /**
+   * @description This method can be used to leave a character participant from the meeting
+   */
+  leave(): Promise<void>;
+
+  /**
+   * @description This method can be used to send message to a character participant
+   */
+  sendMessage(text: string): Promise<void>;
+
+  /**
+   * 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'
+      | 'video-quality-changed'
+      | 'character-state-changed'
+      | 'character-message'
+      | 'character-joined'
+      | 'character-left',
+    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'
+      | 'video-quality-changed'
+      | 'character-state-changed'
+      | 'character-message'
+      | 'character-joined'
+      | 'character-left',
+    listener: (data: any) => void
+  ): void;
+}

package/dist/types/index.d.ts

@@ -16,6 +16,7 @@ import { Permission } from './permission';
 import { Meeting } from './meeting';
 import { Participant } from './participant';
 import { Stream } from './stream';
+import { Character, CharacterMode, CharacterState } from './character';
 /**
  * @param children - Render child component.
  * ---
@@ -85,7 +86,7 @@ export function MeetingProvider({
   config: {
     meetingId: string;
     autoConsume?: boolean;
-    preferredProtocol?: "UDP_ONLY" | "UDP_OVER_TCP" | "TCP_ONLY";
+    preferredProtocol?: 'UDP_ONLY' | 'UDP_OVER_TCP' | 'TCP_ONLY';
     participantId?: string | undefined;
     name: string;
     micEnabled: boolean;
@@ -640,7 +641,9 @@ export function useMeeting({
   onRecordingStateChanged,
   onLivestreamStateChanged,
   onMeetingStateChanged,
-  onParticipantModeChanged
+  onParticipantModeChanged,
+  onCharacterJoined,
+  onCharacterLeft
 }?: {
   onParticipantJoined?: (participant: Participant) => void;
   onParticipantLeft?: (participant: Participant) => void;
@@ -765,12 +768,15 @@ export function useMeeting({
     participantId: string;
     mode: 'CONFERENCE' | 'VIEWER';
   }) => void;
+  onCharacterJoined?: (character: Character) => void;
+  onCharacterLeft?: (character: Character) => void;
 }): {
   meetingId: string;
   meeting: Meeting;
   localParticipant: Participant;
   activeSpeakerId: string;
   participants: Map<string, Participant>;
+  characters: Map<string, Character>;
   pinnedParticipants: Map<
     string,
     {
@@ -1006,7 +1012,7 @@ export function useFile(): {
  *    console.log('Transcription Text Payload:', data);
  *  }
  *
- *  const { startTranscription, stopTranscription } = useTranscription(topic, {
+ *  const { startTranscription, stopTranscription } = useTranscription({
  *    onTranscriptionStateChanged,
  *    onTranscriptionText,
  *  });
@@ -1055,6 +1061,148 @@ export function useTranscription({
   stopTranscription: () => void;
 };
 
+/**
+ * @param onCharacterStateChanged - This will triggered when a character state is changed.
+ * ---
+ * @param onCharacterMessage - This will triggered when a character response/message is published.
+ * ---
+ * @param onStreamEnabled - It's a callback which gets triggered whenever a character's video, audio or screen share stream is enabled.
+ * ---
+ * @param onStreamEnabled - It's a callback which gets triggered whenever a character's video, audio or screen share stream is disabled.
+ * ---
+ * @param onMediaStatusChanged - It's a callback which gets triggered whenever a character's video or audio is disabled or enabled.
+ * ---
+ * @param onVideoQualityChanged -
+ * - It's a callback which gets triggered whenever a character's video quality changes.
+ * - currentQuality and prevQuality can have values `HIGH` | `MEDIUM` | `LOW`.
+ * ---
+ * @returns This will return `character` Object.
+ * ---
+ * **useCharacter example**
+ * ```js
+ *
+ *  function onCharacterStateChanged(data) {
+ *    console.log('New State Payload:', data)
+ *  }
+ *
+ *  function onCharacterMessage(data) {
+ *    console.log('character message Payload:', data);
+ *  }
+ *
+ *  const { join, leave, sendMessage } = useCharacter({
+ *   interactionId,
+ *   // OR
+ *    id,
+ *    displayName,
+ *    characterRole,
+ *    characterMode,
+ *    knowledgeBases,
+ *    },
+ *    {
+ *    onCharacterStateChanged,
+ *    onCharacterMessage,
+ *    onCharacterJoined,
+ *    onCharacterLeft,
+ *
+ *    onStreamEnabled,
+ *    onStreamDisabled,
+ *    onMediaStatusChanged,
+ *    onVideoQualityChanged
+ *  });
+ *
+ *  async function joinCharacter()=>{
+ *    await join()
+ *  }
+ *
+ *  async function removeCharacter()=>{
+ *    await leave()
+ *  }
+ * ```
+ */
+export function useCharacter(
+  {
+    interactionId,
+    // OR
+    id,
+    displayName,
+    characterRole,
+    characterMode,
+    knowledgeBases
+  }: {
+    interactionId: string;
+    // OR
+    id: string;
+    displayName: string;
+    characterRole: string;
+    characterMode: 'text2text' | 'speech2text' | 'speech2speech';
+    knowledgeBases: string[];
+  },
+  {
+    onCharacterStateChanged,
+    onCharacterMessage,
+
+    onStreamEnabled,
+    onStreamDisabled,
+    onMediaStatusChanged,
+    onVideoQualityChanged
+  }: {
+    onCharacterStateChanged?: (data: {
+      id: string;
+      status: CharacterState;
+    }) => void;
+    onCharacterMessage?: (data: {
+      participantId: string;
+      participantName: string;
+      text: string;
+      timestamp: number;
+    }) => void;
+    onCharacterJoined?: () => void;
+    onCharacterLeft?: () => void;
+
+    onStreamDisabled?: (stream: Stream) => void;
+    onStreamEnabled?: (stream: Stream) => void;
+    onMediaStatusChanged?: ({
+      kind,
+      peerId,
+      newStatus
+    }: {
+      kind: 'audio' | 'video';
+      peerId: string;
+      newStatus: boolean;
+    }) => void;
+    onVideoQualityChanged?: ({
+      peerId,
+      prevQuality,
+      currentQuality
+    }: {
+      peerId: string;
+      prevQuality: 'low' | 'med' | 'high';
+      currentQuality: 'low' | 'med' | 'high';
+    }) => void;
+  }
+): {
+  displayName: string;
+  webcamStream: Stream;
+  micStream: Stream;
+  webcamOn: boolean;
+  micOn: boolean;
+  isActiveSpeaker: boolean;
+
+  interactionId?: string;
+  id?: string;
+  characterMode?: CharacterMode;
+  characterState?: CharacterState;
+  knowledgeBases?: string[];
+
+  enableMic: () => void;
+  disableMic: () => void;
+  enableWebcam: () => void;
+  disableWebcam: () => void;
+  join: () => Promise<void>;
+  leave: () => Promise<void>;
+  sendMessage: (text: string) => Promise<void>;
+};
+
 /**
  * @param microphoneId - It will be the id of the mic from which the audio should be captured.
  * ---
@@ -1318,6 +1466,8 @@ export const Constants: {
     TRANSCRIPTION_STOPPING: string;
     TRANSCRIPTION_STOPPED: string;
   };
+  characterState: CharacterState;
+  characterMode: CharacterMode;
   modes: {
     CONFERENCE: string;
     VIEWER: string;

package/dist/types/meeting.d.ts

@@ -463,7 +463,11 @@ export class Meeting {
       | 'meeting-state-changed'
       | 'switch-meeting'
       | 'error'
-      | 'chat-message',
+      | 'chat-message'
+      | 'transcription-text'
+      | 'transcription-state-changed'
+      | 'character-joined'
+      | 'character-left',
     listener: (data: any) => void
   ): void;
   /**
@@ -506,7 +510,12 @@ export class Meeting {
       | 'meeting-state-changed'
       | 'switch-meeting'
       | 'error'
-      | 'chat-message',
+      | 'chat-message'
+      | 'transcription-text'
+      | 'transcription-state-changed'
+      | 'character-joined'
+      | 'character-left',
+
     listener: (data: any) => void
   ): void;
 }

package/package.json

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