Skip to content

Latest commit

 

History

History
146 lines (105 loc) · 4.49 KB

README.md

File metadata and controls

146 lines (105 loc) · 4.49 KB

aiOla Streaming Vanilla JS SDK

Version: 0.1.0

The Aiola Streaming Vanilla JS SDK allows developers to easily integrate microphone audio streaming with Aiola's services. The SDK supports live transcription and event-based interactions in the browser using vanilla JavaScript.

Table of Contents

Features

  • Microphone Streaming: Stream audio data from the browser's microphone.
  • Live Transcription: Receive real-time transcription of the streamed audio.
  • Event Handling: Process custom events received from the Aiola backend.
  • Customizable Configuration: Easily configure microphone and server connection settings.
  • Keywords Spotting: Set up keyword spotting for real-time detection of specific keywords.
  • Supported Languages: en-EN, de-DE, fr-FR, zh-ZH, es-ES, pt-PT

Requirements

  • Browser:
    • Modern browsers (Chrome, Firefox, Edge).
    • Must support AudioWorklet and Web Audio API.
  • Server:
    • Connection to Aiola backend with a valid API key.
  • HTTPS:
    • Application must be served over https:// or localhost to access the microphone.

Installation

  1. Download or clone the SDK file: 
    git clone https://github.com/aiola-lab/aiola-js-sdk
  2. Place aiola_streaming_client.js in your project directory.

Usage

Include the SDK

Add the following to your HTML file:

<script type="module">
  import AiolaStreamingClient from "./aiola_streaming_client.js";
</script>

AiolaStreamingClient API

initialization:

const config = {...} 
const streamingClient = new AiolaStreamingClient(config);

for more details on the config, see Config

streaming:

streamingClient.startStreaming();
streamingClient.stopStreaming();

keywords spotting

streamingClient.set_kws(['comma', 'separated', 'keywords']);

Configuration

The SDK accepts the following configuration options:

Property Type Default Description
baseUrl string Required The base URL of the Aiola backend.
namespace string /events Namespace for subscription (/events or /transcript).
queryParams object Required Query parameters for the connection (e.g., flow_id).
bearer string Required Bearer token for authentication.
transports array ['polling'] Transport methods ('polling' or 'websocket').
micConfig object See below Microphone configuration (sample rate, chunk size).
events object Required Callback functions for handling events.

Microphone Configuration

Property Type Default Description
sampleRate number 16000 Sample rate in Hz.
channels number 1 Number of audio channels (Mono).
chunkSize number 4096 Size of each audio chunk.
dtype string int16 Data type for audio samples.

Events

Event Name Description
onTranscript Callback for transcript data.
onEvents Callback for custom events from the backend.

Example Callbacks

function handleTranscript(data) {
  const transcript = data?.transcript || "No transcript";
  console.log(`Transcript received: ${transcript}`);
}

function handleEvents(data) {
  const events = data?.results?.Items || [];
  console.log(`Events received:`, events);
}

Example Code