Prim Voices React Integration

A React library for integrating Prim Voices Agent functionality into your 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: 'staged',
  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();

  // Your component logic here
}

Browser Support

β€’ Chrome 74+

β€’ Firefox 75+

β€’ Safari 14.1+

β€’ Edge 79+

Documentation

For more detailed documentation, visit our documentation page.