SDK Transcription

Le SDK @ephia/transcribe-sdk permet d’intégrer la transcription vocale en temps réel (streaming) dans vos applications React. Il fournit un bouton prêt à l’emploi, un contexte et des hooks pour afficher et gérer les segments de texte.

Prérequis

• Contexte HTTPS en production (ou localhost en développement)
• Navigateur moderne avec support du microphone et des WebSockets
• React 18+
• Une clé API Ephia pour l’authentification

Clé API

L’API n’est pas documentée pour un usage direct sans SDK. Tout passe par le SDK, qui utilise une clé API pour s’authentifier auprès du service de streaming.

Créez votre clé API sur la plateforme : Créer votre clé API.

Conservez cette clé en lieu sûr et ne l’exposez jamais en clair côté client en production (préférez un backend qui délivre un token à courte durée).

Vue d’ensemble

• TranscriptionProvider : contexte React qui stocke l’état de la transcription (chunks, enregistrement, erreurs).
• TranscriptionButton : bouton avec logo et barre de volume optionnelle ; démarre/arrête l’enregistrement et envoie l’audio vers le backend.
• useTranscription() : hook pour lire l’état (segments, isRecording, clear, etc.) dans vos composants.
• useStreamingV2 : hook bas niveau si vous construisez votre propre UI (URL + token).

Le SDK se connecte en WebSocket à votre backend (ou à l’URL de streaming configurée), envoie le flux audio et reçoit les segments de texte en temps réel.

Suite

• Installation — démarrage rapide (Next / Vite) et installation manuelle
• Utilisation — Provider, bouton, état et codes d’erreur
• Apparence — thème, variante, taille du bouton
• Presets — preset « standard »
• Exemples — exemples à venir
• Dépannage — erreurs courantes et solutions