React Native SDK | ElevenLabs Documentation

Se översikten över ElevenAgents för en förklaring av hur ElevenAgents fungerar.

Installation

Installera paketet och dess beroenden i ditt React Native-projekt.

npm install @elevenlabs/react-native @livekit/react-native @livekit/react-native-webrtc livekit-client

En exempelapp som använder detta SDK med Expo hittar du här

Uppgraderar du från en tidigare version? Kör npx skills add elevenlabs/packages för att installera färdigheten elevenlabs:sdk-migration för din AI-kodningsagent, som automatiserar ändringar av importer, omslutning med ConversationProvider och API-uppdateringar.

Krav

React Native med LiveKit-beroenden
Mikrofonbehörigheter konfigurerade för din plattform
Expo-kompatibilitet (endast utvecklingsbyggen)
React Native 0.79.0+, eller Metro konfigurerat för att lösa package.json-"exports" i äldre versioner

Detta SDK har utformats och byggts för användning med Expo-ramverket. På grund av beroendet av LiveKits WebRTC-implementering kräver det utvecklingsbyggen och kan inte användas med Expo Go.

@elevenlabs/react-native löser sin React Native-ingångspunkt via fältet "exports" i package.json. Metro löser endast "exports" som standard från och med Metro 0.82.0, som levererades i React Native 0.79.0 (släppt den 8 april 2025). Om du använder en React Native-version äldre än 0.79 anger du resolver.unstable_enablePackageExports = true i din metro.config.js så att paketet löses korrekt:

const { getDefaultConfig } = require("metro-config");
const config = getDefaultConfig(__dirname);
config.resolver.unstable_enablePackageExports = true;
module.exports = config;

Konfiguration

Konfigurera providern

Omslut din app med ConversationProvider för att aktivera ElevenAgents-funktionalitet.

import { ConversationProvider } from "@elevenlabs/react-native";
import React from "react";
function App() {
  return (
    <ConversationProvider>
      <YourAppComponents />
    </ConversationProvider>
  );
}

@elevenlabs/react-native återexporterar ConversationProvider och alla hooks från @elevenlabs/react. API:t är identiskt med React SDK:t för webben — se dokumentationen för React SDK:t för den fullständiga API-referensen.

Användning

Alla hooks från React SDK:t är tillgängliga via @elevenlabs/react-native:

useConversation — praktisk hook som kombinerar all status och alla metoder
useConversationControls — åtgärdsmetoder (startSession, endSession osv.)
useConversationStatus — anslutningsstatus
useConversationInput — avstängningsstatus
useConversationMode — tal-/lyssningsstatus
useConversationFeedback — tillgänglighet och inskickning av feedback
useConversationClientTool — dynamisk registrering av klientverktyg
useRawConversation — rå konversationsinstans

Starta en konversation

import { useConversationControls, useConversationStatus } from "@elevenlabs/react-native";
import React from "react";
import { View, Text, Button } from "react-native";
function ConversationComponent() {
  const { startSession, endSession } = useConversationControls();
  const { status } = useConversationStatus();
  const handleStart = async () => {
    await startSession({
      agentId: "agent_7101k5zvyjhmfg983brhmhkd98n6",
    });
  };
  return (
    <View>
      <Text>Status: {status}</Text>
      <Button
        title={status === "connected" ? "End" : "Start"}
        onPress={status === "connected" ? endSession : handleStart}
      />
    </View>
  );
}

För privata agenter, autentisering, klientverktyg, åsidosättningar och alla andra funktioner, se dokumentationen för React SDK:t.

Exempelimplementation

Här är ett komplett exempel på en React Native-komponent som använder ElevenLabs Agents SDK:

import { ConversationProvider, useConversation } from "@elevenlabs/react-native";
import React, { useState } from "react";
import { View, Text, TouchableOpacity, StyleSheet } from "react-native";
function ConversationScreen() {
  const [isConnected, setIsConnected] = useState(false);
  const conversation = useConversation({
    onConnect: () => {
      console.log("Connected to conversation");
      setIsConnected(true);
    },
    onDisconnect: () => {
      console.log("Disconnected from conversation");
      setIsConnected(false);
    },
    onMessage: (message) => {
      console.log("Message received:", message);
    },
    onError: (error) => {
      console.error("Conversation error:", error);
    },
  });
  const startConversation = async () => {
    try {
      await conversation.startSession({
        agentId: "agent_7101k5zvyjhmfg983brhmhkd98n6",
      });
    } catch (error) {
      console.error("Failed to start conversation:", error);
    }
  };
  const endConversation = async () => {
    try {
      await conversation.endSession();
    } catch (error) {
      console.error("Failed to end conversation:", error);
    }
  };
  return (
    <View style={styles.container}>
      <Text style={styles.status}>Status: {conversation.status}</Text>
      <Text style={styles.speaking}>
        Agent is {conversation.isSpeaking ? "speaking" : "not speaking"}
      </Text>
      <TouchableOpacity
        style={[styles.button, isConnected && styles.buttonActive]}
        onPress={isConnected ? endConversation : startConversation}
      >
        <Text style={styles.buttonText}>
          {isConnected ? "End Conversation" : "Start Conversation"}
        </Text>
      </TouchableOpacity>
      {conversation.canSendFeedback && (
        <View style={styles.feedbackContainer}>
          <TouchableOpacity
            style={styles.feedbackButton}
            onPress={() => conversation.sendFeedback(true)}
          >
            <Text>👍</Text>
          </TouchableOpacity>
          <TouchableOpacity
            style={styles.feedbackButton}
            onPress={() => conversation.sendFeedback(false)}
          >
            <Text>👎</Text>
          </TouchableOpacity>
        </View>
      )}
    </View>
  );
}
function App() {
  return (
    <ConversationProvider>
      <ConversationScreen />
    </ConversationProvider>
  );
}
const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: "center",
    alignItems: "center",
    padding: 20,
  },
  status: {
    fontSize: 16,
    marginBottom: 10,
  },
  speaking: {
    fontSize: 14,
    marginBottom: 20,
    color: "#666",
  },
  button: {
    backgroundColor: "#007AFF",
    paddingHorizontal: 20,
    paddingVertical: 10,
    borderRadius: 8,
    marginBottom: 20,
  },
  buttonActive: {
    backgroundColor: "#FF3B30",
  },
  buttonText: {
    color: "white",
    fontSize: 16,
    fontWeight: "600",
  },
  feedbackContainer: {
    flexDirection: "row",
    gap: 10,
  },
  feedbackButton: {
    backgroundColor: "#F2F2F7",
    padding: 10,
    borderRadius: 8,
  },
});
export default App;

Plattformsspecifika aspekter

iOS

Se till att mikrofonbehörigheter är korrekt konfigurerade i din Info.plist:

<key>NSMicrophoneUsageDescription</key>
<string>This app needs microphone access to enable voice conversations with AI agents.</string>

Android

Lägg till mikrofonbehörigheter i din android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.RECORD_AUDIO" />

Överväg att begära behörigheter vid körning innan du startar en konversation:

import { PermissionsAndroid, Platform } from "react-native";
const requestMicrophonePermission = async () => {
  if (Platform.OS === "android") {
    const granted = await PermissionsAndroid.request(PermissionsAndroid.PERMISSIONS.RECORD_AUDIO, {
      title: "Microphone Permission",
      message: "This app needs microphone access to enable voice conversations.",
      buttonNeutral: "Ask Me Later",
      buttonNegative: "Cancel",
      buttonPositive: "OK",
    });
    return granted === PermissionsAndroid.RESULTS.GRANTED;
  }
  return true;
};