docs.VoiceRun

React SDK

A React library for integrating VoiceRun agent functionality into your web applications.

Features#

  • Real-time microphone input capture
  • High-quality audio playback
  • Audio level monitoring and speech detection
  • WebSocket-based communication
  • React Context integration

Installation#

npm install primvoices-react

Quick Start#

import { PrimVoicesProvider, usePrimVoices } from 'primvoices-react';

// Configure the provider
const config = {
  agentId: 'your-agent-id',
  environment: 'production',
  logLevel: 'ERROR'
};

// Wrap your app with the provider
function App() {
  return (
    <PrimVoicesProvider config={config} autoConnect={true}>
      <YourComponent />
    </PrimVoicesProvider>
  );
}

// Use the hook in your components
function YourComponent() {
  const {
    connect,
    disconnect,
    startListening,
    stopListening,
    sendTextEvent,
    isConnected,
    isListening,
    isPlaying,
    audioStats,
    error
  } = usePrimVoices();

  return (
    <div>
      <p>Connected: {isConnected ? 'Yes' : 'No'}</p>
      <p>Listening: {isListening ? 'Yes' : 'No'}</p>
      <p>Playing: {isPlaying ? 'Yes' : 'No'}</p>

      <button onClick={connect}>Connect</button>
      <button onClick={disconnect}>Disconnect</button>
      <button onClick={startListening}>Start Listening</button>
      <button onClick={stopListening}>Stop Listening</button>
    </div>
  );
}

Browser Support#

  • Chrome 74+
  • Firefox 75+
  • Safari 14.1+
  • Edge 79+

Links#

reactsdkwebjavascript