Installation

Démarrage rapide (Next.js / Vite)

Pour un projet Next.js ou Vite existant, utilisez l’outil en ligne de commande :

npx create-ephia-transcribe@latest

Cette commande :

Détecte le type de projet (Next ou Vite).
Installe le package @ephia/transcribe-sdk.
Copie le fichier audio-processor.js dans le dossier des assets statiques (public/ pour Next et Vite).
Affiche un rappel des étapes suivantes (wrapping avec TranscriptionProvider, passage du token, lien vers la doc).

Ensuite :

Enveloppez la partie de l’app qui utilise la transcription avec TranscriptionProvider.
Récupérez une clé API (token) depuis Créer votre clé API et passez-la au TranscriptionButton via la prop token.
Importez les styles du SDK : import '@ephia/transcribe-sdk/dist/styles.css'.

Installation manuelle (React)

Si vous n’utilisez pas l’outil create-ephia-transcribe :

1. Installer le package

npm install @ephia/transcribe-sdk

2. Servir le fichier audio worklet

Le SDK charge un worklet audio depuis une URL. Copiez le fichier audio-processor.js depuis le package (dans node_modules/@ephia/transcribe-sdk/assets/ ou fourni par create-ephia-transcribe) vers un emplacement servi par votre app (par ex. public/audio-processor.js). Le SDK utilise par défaut l’URL /audio-processor.js. Vous pouvez la surcharger avec la prop audioProcessorUrl du TranscriptionButton.

3. Importer les styles

Dans votre point d’entrée ou layout :

import '@ephia/transcribe-sdk/dist/styles.css';

4. Utiliser le Provider et le bouton

Enveloppez votre arbre avec TranscriptionProvider.
Affichez TranscriptionButton en lui passant la prop token (obligatoire). Le token doit être une clé API valide obtenue depuis Créer votre clé API.

Voir la page Utilisation pour les exemples de code complets.

Vanilla (sans React)

Le SDK est conçu pour React (Provider, hooks). Pour un usage sans React, l’API WebSocket brute n’est pas documentée ; l’intégration recommandée est d’utiliser React et le SDK.

Introduction Utilisation