Function useVoiceInput

packages/@react-spectrum/ai/src/useVoiceInput.ts:230–312

(options: VoiceInputProps)

};

export const useVoiceInput = (options: VoiceInputProps): VoiceInputResult => {
  const {lang, onError, onListeningChange} = options;

  // Resolve support once — it cannot change for the lifetime of the page.
  const ctor = useMemo(() => (isSecureVoiceContext() ? getRecognitionCtor() : null), []);
  const isSupported = ctor !== null;

  const [isListening, setIsListening] = useState(false);
  const [errorCode, setErrorCode] = useState<VoiceInputErrorCode | null>(null);
  const [interimTranscript, setInterimTranscript] = useState('');
  const [finalTranscript, setFinalTranscript] = useState('');
  const transcript = finalTranscript + interimTranscript;

  const recognitionRef = useRef<SpeechRecognition | null>(null);
  const startingRef = useRef(false);
  const handleError = useEffectEvent((code: VoiceInputErrorCode) => {
    onError?.(code);
  });
  const handleListeningChange = useEffectEvent((v: boolean) => {
    onListeningChange?.(v);
  });

  const stop = useCallback(() => {
    recognitionRef.current?.stop();
  }, []);

  const start = useCallback(() => {
    // Guard against double-start (a started recognizer throws InvalidStateError)
    // and against re-entry while the permission prompt is open.
    if (!ctor || recognitionRef.current || startingRef.current) {
      return;
    }
    startingRef.current = true;
    setErrorCode(null);
    setInterimTranscript('');
    setFinalTranscript('');

    // Request mic access first so the browser permission prompt reliably opens
    // and a denial is reported before recognition starts.
    void requestMicrophone().then(micError => {
      startingRef.current = false;
      if (micError) {
        setErrorCode(micError);
        handleError(micError);
        return;
      }
      // Bail if already started while the permission prompt was open.
      if (recognitionRef.current) {
        return;
      }

      const recognition = createRecognizer(ctor, lang ?? navigator.language ?? 'en-US', {
        recognitionRef,
        setListening: setIsListening,
        onListeningChange: handleListeningChange,
        onError: handleError,
        setError: setErrorCode,
        setInterim: setInterimTranscript,