Pré-requisitos

Pergunta: "o que preciso verificar antes de iniciar uma transcrição?"

@sofya-sdk/transcription é browser-only. Não é um SDK para Node, SSR, WebView ou Firefox Android nesta primeira versão. Os alvos suportados são browsers desktop evergreen, Chrome Android e Safari iOS, desde que disponibilizem captura de microfone e WebSocket. A matriz de suporte é revisada periodicamente; não é uma promessa de que qualquer versão histórica desses browsers funcionará.

Antes de chamar start() ou connectTranscription(), confirme:

• há window e navigator;
• a página está em contexto seguro (https: ou localhost no desenvolvimento);
• navigator.mediaDevices.getUserMedia existe;
• o usuário poderá conceder permissão de microfone;
• o seu ambiente fornece um endpoint WebSocket direto, ou uma chave para discovery.

O SDK transforma as três primeiras ausências em TranscriptionEnvironmentError: browser_unavailable, secure_context_required e microphone_unavailable. Permissão recusada produz o erro de sessão microphone_access_failed.

Não há harness fiel ao protocolo neste repositório e o smoke contra provider real ainda não foi executado: ele depende de credencial e ambiente do integrador. Portanto, trate o seu ambiente controlado como pré-requisito para validar a integração, não como algo que este pacote já tenha provado por você.

Dados sensíveis

Não grave em logs texto reconhecido, identificadores de atendimento, tokens, cookies ou headers de autorização. Os exemplos usam apenas placeholders; mantenha essa separação no seu aplicativo e envie telemetria somente com dados minimizados.

Próximo passo

quickstart.md mostra a conexão direta; para a jornada por discovery, veja discovery-fallback.md.