Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

2.2 KB
Raw Blame
import { useEffect } from 'react';
import { useSetRecoilState } from 'recoil';
import { useParams } from 'react-router-dom';
import { getSpeechText } from 'librechat-data-provider';
import useTextToSpeechBrowser from '~/hooks/Input/useTextToSpeechBrowser';
import useAutoplayTrigger from '~/hooks/Audio/useAutoplayTrigger';
import { logger } from '~/utils';
import store from '~/store';

/**
 * Autoplay driver for the Browser TTS engine. `StreamAudio` covers the external engine by
 * streaming server audio into the global `<audio>` element; the Web Speech API has no such
 * element, so the utterance is spoken directly off the shared autoplay gate.
 */
export default function BrowserAudio({ index = 0 }) {
  const { conversationId: paramId } = useParams();
  const setIsSpeaking = useSetRecoilState(store.globalAudioPlayingFamily(index));
  const setAudioRunId = useSetRecoilState(store.audioRunFamily(index));

  const { shouldPlay, activeRunId, latestMessage } = useAutoplayTrigger(index);
  const { generateSpeechLocal, cancelSpeechLocal } = useTextToSpeechBrowser({ setIsSpeaking });

  /**
   * Leaving a conversation (or unmounting) stops whatever is still being spoken. React runs
   * every cleanup before any effect body, so the utterance the effect below is about to start
   * survives the `/c/new` -> `/c/:id` navigation that lands in the same commit as finalization.
   */
  useEffect(() => {
    return () => cancelSpeechLocal();
    // We only want the effect to run when the paramId changes
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [paramId]);

  useEffect(() => {
    if (!shouldPlay || activeRunId == null || latestMessage == null) {
      return;
    }

    const text = getSpeechText(latestMessage);

    if (!text) {
      return;
    }

    logger.log('BrowserAudio.tsx - speaking message:', latestMessage.messageId);
    /** Only claim the run once an utterance was queued, so a not-yet-loaded voice list
     *  retries on the next render instead of silently swallowing the playback. */
    if (generateSpeechLocal(text)) {
      setAudioRunId(activeRunId);
    }
  }, [shouldPlay, activeRunId, latestMessage, setAudioRunId, generateSpeechLocal]);

  return null;
}