@videosdk.live/react-sdk 0.1.88 → 0.1.90

package/dist/types/index.d.ts

@@ -790,6 +790,7 @@ export function useMeeting({
     playbackHlsUrl: string;
     livestreamUrl: string;
   };
+  transcriptionState: string;
   selectedCameraDevice?: {
     deviceId: string;
     groupId: string;
@@ -987,6 +988,73 @@ export function useFile(): {
   }) => Promise<string | null>;
 };
 
+/**
+ * @param onTranscriptionStateChanged - This will triggered when a realtime transcription state is changed.
+ * ---
+ * @param onTranscriptionText - This will triggered when a realtime transcription text is published.
+ * ---
+ * @returns This will return `startTranscription()` and `stopTranscription()` method. You can refer this [API Reference](https://docs.videosdk.live/react/api/sdk-reference/use-transcription#returns)
+ * ---
+ * **useTranscription example**
+ * ```js
+ *
+ *  function onTranscriptionStateChanged(data) {
+ *    console.log('New State Payload:', data)
+ *  }
+ *
+ *  function onTranscriptionText(data) {
+ *    console.log('Transcription Text Payload:', data);
+ *  }
+ *
+ *  const { startTranscription, stopTranscription } = useTranscription(topic, {
+ *    onTranscriptionStateChanged,
+ *    onTranscriptionText,
+ *  });
+ *
+ *  async function startTranscription()=>{
+ *    await startTranscription()
+ *  }
+ *
+ *  async function stopTranscription()=>{
+ *    await stopTranscription()
+ *  }
+ * ```
+ */
+export function useTranscription({
+  onTranscriptionStateChanged,
+  onTranscriptionText
+}?: {
+  onTranscriptionStateChanged?: (data: { id: string; status: string }) => void;
+  onTranscriptionText?: (data: {
+    participantId: string;
+    participantName: string;
+    text: string;
+    timestamp: string;
+    type: 'realtime';
+  }) => void;
+}): {
+  /**
+   * @description This method is used to start the meeting transcription
+   * @param config.webhookUrl? Webhook URL which will be called by VideoSDK when the transcription state gets changed
+   * @param config.modelConfig? modelConfig if any, which will be used while doing transcription
+   * @param config.summary.enabled Enables or disables summary generation from realtime transcriptions.
+   * @param config.summary.prompt Guides summary generation (optional).
+   */
+  startTranscription: ({
+    webhookUrl,
+    modelConfig,
+    summary
+  }: {
+    webhookUrl?: string;
+    modelConfig?: object;
+    summary?: {
+      enabled: boolean;
+      prompt?: string;
+    };
+  }) => void;
+  stopTranscription: () => void;
+};
+
 /**
  * @param microphoneId - It will be the id of the mic from which the audio should be captured.
  * ---
@@ -1193,9 +1261,12 @@ export const Constants: {
     INVALID_LIVESTREAM_CONFIG: number;
     START_HLS_FAILED: number;
     STOP_HLS_FAILED: number;
+    START_TRANSCRIPTION_FAILED: number;
+    STOP_TRANSCRIPTION_FAILED: number;
     RECORDING_FAILED: number;
     LIVESTREAM_FAILED: number;
     HLS_FAILED: number;
+    TRANSCRIPTION_FAILED: number;
     ERROR_GET_VIDEO_MEDIA: number;
     ERROR_GET_AUDIO_MEDIA: number;
     ERROR_GET_DISPLAY_MEDIA: number;
@@ -1241,6 +1312,12 @@ export const Constants: {
     HLS_STOPPING: string;
     HLS_STOPPED: string;
   };
+  transcriptionEvents: {
+    TRANSCRIPTION_STARTING: string;
+    TRANSCRIPTION_STARTED: string;
+    TRANSCRIPTION_STOPPING: string;
+    TRANSCRIPTION_STOPPED: string;
+  };
   modes: {
     CONFERENCE: string;
     VIEWER: string;