@defcomm/meetingsdk 0.5.5 → 0.5.7

package/dist/index.d.mts

@@ -26,6 +26,8 @@ type Events = {
     onMeetingLeft?: () => void;
     onChatMessage?: (msg: ChatMessage) => void;
     onReaction?: (reaction: Reaction) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
     onScreenShareStarted?: (peerId: string, stream: MediaStream) => void;
     onScreenShareStopped?: (peerId: string) => void;
     onMuteStateChanged?: (peerId: string, kind: "audio" | "video", muted: boolean) => void;
@@ -130,6 +132,30 @@ type MeetingConfig = {
     videoMuted?: boolean;
     token: string;
 };
+type LiveTranscript = {
+    transcript_id: string;
+    participant_id: string;
+    speaker_name?: string | null;
+    sequence: number;
+    text: string;
+    offset_ms?: number | null;
+    start_ms?: number | null;
+    end_ms?: number | null;
+    timestamp: string;
+};
+type NetworkQuality = {
+    participant_id: string;
+    quality: "excellent" | "good" | "fair" | "poor" | string;
+    score: number;
+    recommended_action: "maintain" | "reduce_video" | "audio_priority" | string;
+    packet_loss_percent: number;
+    upload_kbps: number;
+    forwarded_drop_percent: number;
+    queued_packets: number;
+    packets_received: number;
+    packets_lost: number;
+    observed_at: string;
+};
 type RecordingInfo = {
     recording_id: string;
     started_at?: string;
@@ -138,7 +164,7 @@ type RecordingInfo = {
     active?: boolean;
     late_join?: boolean;
 };
-type StateScope = "participants" | "localParticipant" | "chat" | "presenter" | "activeSpeakers" | "recording" | `participant:${string}`;
+type StateScope = "participants" | "localParticipant" | "chat" | "presenter" | "activeSpeakers" | "recording" | "transcript" | "networkQuality" | `participant:${string}`;
 type SDKError = {
     code: string;
     message: string;
@@ -176,6 +202,8 @@ interface VideoSDKCoreOptions {
     onRoomUpdate?: (data: any) => void;
     onChatMessage?: (message: ChatMessage) => void;
     onReaction?: (reaction: Reaction) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
     onMuteStateChanged?: (peerId: string, kind: "audio" | "video", muted: boolean) => void;
 }
 type SFUConnectionState = "idle" | "connecting" | "joining" | "waiting_approval" | "connected" | "reconnecting" | "leaving" | "disconnected";
@@ -207,6 +235,8 @@ declare class MeetingState {
     presenterId: string | null;
     activeSpeakerIds: Set<string>;
     recording: RecordingInfo | null;
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
     private listeners;
     subscribe(scope: StateScope, fn: Listener): () => void;
     notify(scope: StateScope): void;
@@ -214,6 +244,10 @@ declare class MeetingState {
     setActiveSpeakers(ids: string[]): void;
     setRecording(recording: RecordingInfo | null): void;
     clearRecording(): void;
+    addLiveTranscript(transcript: LiveTranscript): void;
+    getLiveTranscripts(): LiveTranscript[];
+    clearLiveTranscripts(): void;
+    setNetworkQuality(quality: NetworkQuality | null): void;
     addParticipant(p: Participant): boolean;
     removeParticipant(id: string): void;
     updateParticipantMedia(id: string, patch: Partial<NonNullable<Participant["media"]>>): void;
@@ -295,6 +329,10 @@ declare class VideoSDKCore {
      * to know about those wire-level message types.
      */
     publishPubSub<T extends PubSubTopic>(topic: T, data: PubSubTopicConfig[T]["publish"]): void;
+    startLiveTranscription(): Promise<void>;
+    stopLiveTranscription(): void;
+    isLiveTranscriptionActive(): boolean;
+    getNetworkQuality(): NetworkQuality | null;
     private cleanupRemoteParticipant;
     disconnect(): Promise<void>;
     private performDisconnect;
@@ -345,6 +383,11 @@ type MeetingContextValue = {
     messages: ChatMessage[];
     presenterId: string | null;
     activeSpeakerIds: string[];
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
+    startLiveTranscription: () => Promise<void>;
+    stopLiveTranscription: () => void;
+    isLiveTranscriptionActive: () => boolean;
     recording: RecordingInfo | null;
     usePubSub: <T extends PubSubTopic>(topic: T) => PubSubHandleForTopic<T>;
     onPubSubMessage: <T extends PubSubTopic>(topic: T, cb: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void) => () => void;
@@ -373,6 +416,8 @@ type MeetingContextValue = {
     onReaction: (cb: (reaction: Reaction) => void) => () => void;
     onConnectionStateChanged: (cb: (state: SFUConnectionState) => void) => () => void;
     onActiveSpeakersChanged: (cb: (participantIds: string[]) => void) => () => void;
+    onNetworkQuality: (cb: (quality: NetworkQuality) => void) => () => void;
+    onLiveTranscript: (cb: (transcript: LiveTranscript) => void) => () => void;
 };
 declare const MeetingProvider: ({ config, children, }: {
     config: MeetingConfig;
@@ -394,6 +439,8 @@ declare const useMeeting: (handlers?: {
     onReaction?: (reaction: any) => void;
     onActiveSpeakersChanged?: (participantIds: string[]) => void;
     onConnectionStateChanged?: (state: SFUConnectionState) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
 }) => {
     join: (config?: Omit<MeetingConfig, "participantId" | "token">) => Promise<void>;
     getJoinState: (roomCode: string) => Promise<JoinState>;
@@ -421,6 +468,11 @@ declare const useMeeting: (handlers?: {
     messages: ChatMessage[];
     presenterId: string | null;
     activeSpeakerIds: string[];
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
+    startLiveTranscription: () => Promise<void>;
+    stopLiveTranscription: () => void;
+    isLiveTranscriptionActive: () => boolean;
     recording: RecordingInfo | null;
     usePubSub: <T extends PubSubTopic>(topic: T) => PubSubHandleForTopic<T>;
     onPubSubMessage: <T extends PubSubTopic>(topic: T, cb: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void) => () => void;
@@ -449,6 +501,8 @@ declare const useMeeting: (handlers?: {
     onReaction: (cb: (reaction: Reaction) => void) => () => void;
     onConnectionStateChanged: (cb: (state: SFUConnectionState) => void) => () => void;
     onActiveSpeakersChanged: (cb: (participantIds: string[]) => void) => () => void;
+    onNetworkQuality: (cb: (quality: NetworkQuality) => void) => () => void;
+    onLiveTranscript: (cb: (transcript: LiveTranscript) => void) => () => void;
 };
 
 declare const useParticipants: () => Participant[];
@@ -496,6 +550,10 @@ declare function useMeetingPreview(roomId: string, participantId: string): {
     error: string | null;
 };
 
+declare const useLiveTranscript: () => LiveTranscript[];
+
+declare const useNetworkQuality: () => NetworkQuality | null;
+
 interface ActiveSpeakerDetectorOptions {
     intervalMs?: number;
     threshold?: number;
@@ -532,4 +590,4 @@ declare function usePubSub<T extends PubSubTopic>(topic: T, options?: {
     onMessageReceived?: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void;
 }): PubSubHandleForTopic<T>;
 
-export { ActiveSpeakerDetector, type ChatInput, type MeetingConfig, MeetingProvider, MeetingState, type Participant, type ParticipantInfo, type PubSubHandle, type PubSubHandleForTopic, type PubSubMessage, type PubSubTopic, type PubSubTopicConfig, type Reaction, type RecordingInfo, type SFUConnectionState, type TrackInfo, VideoSDKCore, useLocalParticipant, useMeeting, useMeetingContext, useMeetingPreview, useParticipants, usePubSub, useRemoteMedia };
+export { ActiveSpeakerDetector, type ChatInput, type LiveTranscript, type MeetingConfig, MeetingProvider, MeetingState, type NetworkQuality, type Participant, type ParticipantInfo, type PubSubHandle, type PubSubHandleForTopic, type PubSubMessage, type PubSubTopic, type PubSubTopicConfig, type Reaction, type RecordingInfo, type SFUConnectionState, type TrackInfo, VideoSDKCore, useLiveTranscript, useLocalParticipant, useMeeting, useMeetingContext, useMeetingPreview, useNetworkQuality, useParticipants, usePubSub, useRemoteMedia };

package/dist/index.d.ts

@@ -26,6 +26,8 @@ type Events = {
     onMeetingLeft?: () => void;
     onChatMessage?: (msg: ChatMessage) => void;
     onReaction?: (reaction: Reaction) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
     onScreenShareStarted?: (peerId: string, stream: MediaStream) => void;
     onScreenShareStopped?: (peerId: string) => void;
     onMuteStateChanged?: (peerId: string, kind: "audio" | "video", muted: boolean) => void;
@@ -130,6 +132,30 @@ type MeetingConfig = {
     videoMuted?: boolean;
     token: string;
 };
+type LiveTranscript = {
+    transcript_id: string;
+    participant_id: string;
+    speaker_name?: string | null;
+    sequence: number;
+    text: string;
+    offset_ms?: number | null;
+    start_ms?: number | null;
+    end_ms?: number | null;
+    timestamp: string;
+};
+type NetworkQuality = {
+    participant_id: string;
+    quality: "excellent" | "good" | "fair" | "poor" | string;
+    score: number;
+    recommended_action: "maintain" | "reduce_video" | "audio_priority" | string;
+    packet_loss_percent: number;
+    upload_kbps: number;
+    forwarded_drop_percent: number;
+    queued_packets: number;
+    packets_received: number;
+    packets_lost: number;
+    observed_at: string;
+};
 type RecordingInfo = {
     recording_id: string;
     started_at?: string;
@@ -138,7 +164,7 @@ type RecordingInfo = {
     active?: boolean;
     late_join?: boolean;
 };
-type StateScope = "participants" | "localParticipant" | "chat" | "presenter" | "activeSpeakers" | "recording" | `participant:${string}`;
+type StateScope = "participants" | "localParticipant" | "chat" | "presenter" | "activeSpeakers" | "recording" | "transcript" | "networkQuality" | `participant:${string}`;
 type SDKError = {
     code: string;
     message: string;
@@ -176,6 +202,8 @@ interface VideoSDKCoreOptions {
     onRoomUpdate?: (data: any) => void;
     onChatMessage?: (message: ChatMessage) => void;
     onReaction?: (reaction: Reaction) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
     onMuteStateChanged?: (peerId: string, kind: "audio" | "video", muted: boolean) => void;
 }
 type SFUConnectionState = "idle" | "connecting" | "joining" | "waiting_approval" | "connected" | "reconnecting" | "leaving" | "disconnected";
@@ -207,6 +235,8 @@ declare class MeetingState {
     presenterId: string | null;
     activeSpeakerIds: Set<string>;
     recording: RecordingInfo | null;
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
     private listeners;
     subscribe(scope: StateScope, fn: Listener): () => void;
     notify(scope: StateScope): void;
@@ -214,6 +244,10 @@ declare class MeetingState {
     setActiveSpeakers(ids: string[]): void;
     setRecording(recording: RecordingInfo | null): void;
     clearRecording(): void;
+    addLiveTranscript(transcript: LiveTranscript): void;
+    getLiveTranscripts(): LiveTranscript[];
+    clearLiveTranscripts(): void;
+    setNetworkQuality(quality: NetworkQuality | null): void;
     addParticipant(p: Participant): boolean;
     removeParticipant(id: string): void;
     updateParticipantMedia(id: string, patch: Partial<NonNullable<Participant["media"]>>): void;
@@ -295,6 +329,10 @@ declare class VideoSDKCore {
      * to know about those wire-level message types.
      */
     publishPubSub<T extends PubSubTopic>(topic: T, data: PubSubTopicConfig[T]["publish"]): void;
+    startLiveTranscription(): Promise<void>;
+    stopLiveTranscription(): void;
+    isLiveTranscriptionActive(): boolean;
+    getNetworkQuality(): NetworkQuality | null;
     private cleanupRemoteParticipant;
     disconnect(): Promise<void>;
     private performDisconnect;
@@ -345,6 +383,11 @@ type MeetingContextValue = {
     messages: ChatMessage[];
     presenterId: string | null;
     activeSpeakerIds: string[];
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
+    startLiveTranscription: () => Promise<void>;
+    stopLiveTranscription: () => void;
+    isLiveTranscriptionActive: () => boolean;
     recording: RecordingInfo | null;
     usePubSub: <T extends PubSubTopic>(topic: T) => PubSubHandleForTopic<T>;
     onPubSubMessage: <T extends PubSubTopic>(topic: T, cb: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void) => () => void;
@@ -373,6 +416,8 @@ type MeetingContextValue = {
     onReaction: (cb: (reaction: Reaction) => void) => () => void;
     onConnectionStateChanged: (cb: (state: SFUConnectionState) => void) => () => void;
     onActiveSpeakersChanged: (cb: (participantIds: string[]) => void) => () => void;
+    onNetworkQuality: (cb: (quality: NetworkQuality) => void) => () => void;
+    onLiveTranscript: (cb: (transcript: LiveTranscript) => void) => () => void;
 };
 declare const MeetingProvider: ({ config, children, }: {
     config: MeetingConfig;
@@ -394,6 +439,8 @@ declare const useMeeting: (handlers?: {
     onReaction?: (reaction: any) => void;
     onActiveSpeakersChanged?: (participantIds: string[]) => void;
     onConnectionStateChanged?: (state: SFUConnectionState) => void;
+    onLiveTranscript?: (transcript: LiveTranscript) => void;
+    onNetworkQuality?: (quality: NetworkQuality) => void;
 }) => {
     join: (config?: Omit<MeetingConfig, "participantId" | "token">) => Promise<void>;
     getJoinState: (roomCode: string) => Promise<JoinState>;
@@ -421,6 +468,11 @@ declare const useMeeting: (handlers?: {
     messages: ChatMessage[];
     presenterId: string | null;
     activeSpeakerIds: string[];
+    liveTranscripts: LiveTranscript[];
+    networkQuality: NetworkQuality | null;
+    startLiveTranscription: () => Promise<void>;
+    stopLiveTranscription: () => void;
+    isLiveTranscriptionActive: () => boolean;
     recording: RecordingInfo | null;
     usePubSub: <T extends PubSubTopic>(topic: T) => PubSubHandleForTopic<T>;
     onPubSubMessage: <T extends PubSubTopic>(topic: T, cb: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void) => () => void;
@@ -449,6 +501,8 @@ declare const useMeeting: (handlers?: {
     onReaction: (cb: (reaction: Reaction) => void) => () => void;
     onConnectionStateChanged: (cb: (state: SFUConnectionState) => void) => () => void;
     onActiveSpeakersChanged: (cb: (participantIds: string[]) => void) => () => void;
+    onNetworkQuality: (cb: (quality: NetworkQuality) => void) => () => void;
+    onLiveTranscript: (cb: (transcript: LiveTranscript) => void) => () => void;
 };
 
 declare const useParticipants: () => Participant[];
@@ -496,6 +550,10 @@ declare function useMeetingPreview(roomId: string, participantId: string): {
     error: string | null;
 };
 
+declare const useLiveTranscript: () => LiveTranscript[];
+
+declare const useNetworkQuality: () => NetworkQuality | null;
+
 interface ActiveSpeakerDetectorOptions {
     intervalMs?: number;
     threshold?: number;
@@ -532,4 +590,4 @@ declare function usePubSub<T extends PubSubTopic>(topic: T, options?: {
     onMessageReceived?: (message: PubSubMessage<PubSubTopicConfig[T]["message"]>) => void;
 }): PubSubHandleForTopic<T>;
 
-export { ActiveSpeakerDetector, type ChatInput, type MeetingConfig, MeetingProvider, MeetingState, type Participant, type ParticipantInfo, type PubSubHandle, type PubSubHandleForTopic, type PubSubMessage, type PubSubTopic, type PubSubTopicConfig, type Reaction, type RecordingInfo, type SFUConnectionState, type TrackInfo, VideoSDKCore, useLocalParticipant, useMeeting, useMeetingContext, useMeetingPreview, useParticipants, usePubSub, useRemoteMedia };
+export { ActiveSpeakerDetector, type ChatInput, type LiveTranscript, type MeetingConfig, MeetingProvider, MeetingState, type NetworkQuality, type Participant, type ParticipantInfo, type PubSubHandle, type PubSubHandleForTopic, type PubSubMessage, type PubSubTopic, type PubSubTopicConfig, type Reaction, type RecordingInfo, type SFUConnectionState, type TrackInfo, VideoSDKCore, useLiveTranscript, useLocalParticipant, useMeeting, useMeetingContext, useMeetingPreview, useNetworkQuality, useParticipants, usePubSub, useRemoteMedia };