@videosdk.live/react-sdk 0.8.1 → 0.8.2

package/dist/types/agentParticipant.d.ts

@@ -0,0 +1,140 @@
+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"
+      | 'agent-metrics',
+    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"
+      | 'agent-metrics',
+    listener: (data: any) => void
+  ): void;
+}
+import { Stream } from './stream';

package/dist/types/character.d.ts

@@ -0,0 +1,113 @@
+import { Participant } from './participant';
+import { Stream } from './stream';
+
+export enum CharacterMode {
+  TEXT = 'text',
+  CO_PILOT = 'co_pilot',
+  AUTO_PILOT = 'auto_pilot',
+  VISION_PILOT = 'vision_pilot'
+}
+
+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 language of interaction
+   */
+  language: 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>;
+
+  /**
+   * @description This method can be used to interrupt a character participant
+   */
+  interrupt(): 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'
+      | 'user-message'
+      | 'data'
+      | 'error',
+    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'
+      | 'user-message'
+      | 'data'
+      | 'error',
+    listener: (data: any) => void
+  ): void;
+}

package/dist/types/connection.d.ts

@@ -0,0 +1,19 @@
+export class Connection {
+    /**
+     * @deprecated
+     */
+    id: string;
+    /**
+     * @deprecated
+     */
+    payload: string;
+    /**
+     * @deprecated
+     */
+    meeting: ConnectionMeeting;
+    /**
+     * @deprecated
+     */
+    close(): void;
+}
+import { ConnectionMeeting } from './connectionMeeting';

package/dist/types/connectionMeeting.d.ts

@@ -0,0 +1,49 @@
+export class ConnectionMeeting {
+    /**
+     * @deprecated
+     */
+    id: string;
+    /**
+     * @deprecated
+     */
+    participants: Map<string, ConnectionParticipant>;
+    /**
+     * @deprecated
+     * @param peer
+     */
+    participantJoin(peer: any): void;
+    /**
+     * @deprecated
+     * @param peer
+     */
+    participantLeft(peerId: any): void;
+    /**
+     * @deprecated
+     */
+    sendChatMessage(message: string): void;
+    /**
+     * @deprecated
+     * @param peer
+     */
+    sendChatMessageEvent({ participantId, message }: { participantId: any; message: any }): void;
+    /**
+     * @deprecated
+     * @param peer
+     */
+    end(): Promise<void>;
+    /**
+     * @deprecated
+     * Add event listener
+     * @param eventType
+     * @param listener Callback function
+     */
+    on(eventType: 'participant-joined' | 'participant-left' | 'data', listener: (data: any) => void): void;
+    /**
+     * @deprecated
+     * Remove event listener
+     * @param eventType
+     * @param listener Callback function
+     */
+    off(eventType: 'participant-joined' | 'participant-left' | 'data', listener: (data: any) => void): void;
+}
+import { ConnectionParticipant } from './connectionParticipant';

package/dist/types/connectionParticipant.d.ts

@@ -0,0 +1,15 @@
+export class ConnectionParticipant {
+    /**
+     * @deprecated
+     */
+    id: string;
+    /**
+     * @deprecated
+     */
+    displayName: string;
+    /**
+     * @deprecated
+     * @param  options
+     */
+    switchTo({ meetingId, payload, token }: { meetingId: string; payload: string; token: string }): Promise<void>;
+}

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 {};