SDK para Web

@sorisdk/web-audio es el SDK para navegadores que permite añadir el reconocimiento de audio de SORI a un servicio web o producto basado en el navegador.

Beta

El SDK para Web se encuentra actualmente en Beta. Dado que la implementación sigue evolucionando, algunas partes de la API y del flujo de integración pueden cambiar.

Requisitos previos

• Un contexto seguro, como https:// o http://localhost
• Un navegador moderno compatible con AudioContext y MediaDevices.getUserMedia
• Acceso al flujo de claves efímeras proporcionado por SORI
• Permiso de micrófono concedido por el usuario

Flujo de integración

1. Cree un AudioRecognizer con su appId.
2. Proporcione una clave efímera mediante ephemeralKey, como cadena o mediante su propio callback asíncrono.
3. Suscríbase a los eventos que necesite, como campaign, match y error.
4. Llame a start() para iniciar el reconocimiento.
5. Llame a stop() o destroy() cuando deba pausar el reconocimiento o se vaya a desmontar la página.

API principal

AudioRecognizer es la API principal para las integraciones Web de partners. Se encarga de la autenticación inicial, la gestión de sesiones, la caché de paquetes y el flujo de reconocimiento mediante el micrófono.

Ejemplo mínimo

import { AudioRecognizer } from "@sorisdk/web-audio";

const recognizer = new AudioRecognizer({
  appId: "YOUR_APP_ID",
  ephemeralKey: async () => {
    const response = await fetch("/api/ephemeral-key", {
      method: "POST"
    });

    if (!response.ok) {
      throw new Error(`Ephemeral key request failed: HTTP ${response.status}`);
    }

    const { ephemeral_key } = await response.json();
    return ephemeral_key;
  }
});

recognizer.on("campaign", (event) => {
  console.log(event.campaign);
});

await recognizer.start();

Para obtener información sobre la emisión de claves y los patrones de relay, consulte Clave efímera.

Pasos siguientes

• Configuración
• Clave efímera
• Conexión con la interfaz de usuario