@twn39/edgetts-js
Advanced tools
TypeScript/JavaScript port of edge-tts for browser environments using native WebSocket and Fetch APIs
TypeScript/JavaScript port of the Python edge-tts library, designed to work in browser environments using native WebSocket and Fetch APIs.
This library allows you to use Microsoft Edge's online text-to-speech service without needing Windows or the Edge browser.
npm install @twn39/edgetts-js
import { Communicate } from '@twn39/edgetts-js';
const communicate = new Communicate('Hello, world!', {
voice: 'en-US-EmmaMultilingualNeural',
rate: '+0%',
volume: '+0%',
pitch: '+0Hz',
boundary: 'SentenceBoundary'
});
for await (const chunk of communicate.stream()) {
if (chunk.type === 'audio') {
// Handle audio data (Uint8Array)
console.log('Received audio chunk:', chunk.data.length, 'bytes');
} else if (chunk.type === 'WordBoundary' || chunk.type === 'SentenceBoundary') {
// Handle metadata
console.log('Word:', chunk.text, 'at', chunk.offset);
}
}
<!DOCTYPE html>
<html>
<head>
<script type="module">
import { Communicate } from './dist/index.js';
const communicate = new Communicate('Hello, world!');
const audioChunks = [];
for await (const chunk of communicate.stream()) {
if (chunk.type === 'audio') {
audioChunks.push(chunk.data);
}
}
const audioBlob = new Blob(audioChunks, { type: 'audio/mpeg' });
const audioUrl = URL.createObjectURL(audioBlob);
const audio = new Audio(audioUrl);
audio.play();
</script>
</head>
</html>
Main class for streaming audio and metadata from the Edge TTS service.
new Communicate(text: string, options?: CommunicateOptions)
Parameters:
text (string): The text to convert to speechoptions (CommunicateOptions, optional): Configuration optionsCommunicateOptions:
voice (string): Voice name (default: 'en-US-EmmaMultilingualNeural')rate (string): Speech rate, e.g., '+0%', '+10%', '-20%' (default: '+0%')volume (string): Volume, e.g., '+0%', '+50%', '-10%' (default: '+0%')pitch (string): Pitch, e.g., '+0Hz', '+10Hz', '-5Hz' (default: '+0Hz')boundary ('WordBoundary' | 'SentenceBoundary'): Metadata boundary type (default: 'SentenceBoundary')proxy (string): Proxy URL (not supported in browser)connectTimeout (number): Connection timeout in seconds (default: 10)receiveTimeout (number): Receive timeout in seconds (default: 60)async* stream(): AsyncGenerator<TTSChunk, void, unknown>
Streams audio and metadata from the service.
Yields: TTSChunk objects
TTSChunk types:
TTSChunkAudio: { type: 'audio', data: Uint8Array }TTSChunkMetadata: { type: 'WordBoundary' | 'SentenceBoundary', offset: number, duration: number, text: string }async save(audioData: Uint8Array[], metadataData?: TTSChunk[]): Promise<void>
Save audio and metadata to the specified arrays.
Class for generating SRT subtitles from WordBoundary and SentenceBoundary events.
new SubMaker()
feed(msg: TTSChunk): void
Feed a WordBoundary or SentenceBoundary message to the SubMaker.
getSrt(): string
Get the SRT formatted subtitles.
Example:
import { Communicate, SubMaker } from '@twn39/edgetts-js';
const communicate = new Communicate('Hello world!', { boundary: 'SentenceBoundary' });
const submaker = new SubMaker();
for await (const chunk of communicate.stream()) {
if (chunk.type === 'SentenceBoundary') {
submaker.feed(chunk);
}
}
console.log(submaker.getSrt());
async function listVoices(proxy?: string): Promise<Voice[]>
List all available voices and their attributes.
Returns: Array of Voice objects
Voice object:
Name: Full voice nameShortName: Short voice name (e.g., 'en-US-EmmaMultilingualNeural')Gender: 'Female' or 'Male'Locale: Locale code (e.g., 'en-US')SuggestedCodec: Suggested codecFriendlyName: Friendly nameStatus: 'Deprecated', 'GA', or 'Preview'VoiceTag: Additional voice tagsClass for finding voices based on their attributes.
static async create(customVoices?: Voice[]): Promise<VoicesManager>
Creates a VoicesManager object and populates it with all available voices.
find(criteria: VoicesManagerFind): VoicesManagerVoice[]
Find all matching voices based on the provided attributes.
VoicesManagerFind:
Gender?: 'Female' | 'Male'Locale?: stringLanguage?: stringgetAllVoices(): Get all voicesgetLocales(): Get all unique localesgetLanguages(): Get all unique languagesfindByLocale(locale): Find voices by localefindByLanguage(language): Find voices by languagefindByGender(gender): Find voices by genderExample:
import { VoicesManager } from '@twn39/edgetts-js';
const manager = await VoicesManager.create();
// Find all English female voices
const englishFemaleVoices = manager.find({
Language: 'en',
Gender: 'Female'
});
// Find voices by locale
const usVoices = manager.findByLocale('en-US');
console.log('Available locales:', manager.getLocales());
Open demo.html in a browser to try an interactive demo:
# Start a local server
pnpm build
python3 -m http.server 8080
# Open http://localhost:8080/demo.html
The demo showcases:
# Install dependencies
pnpm install
# Build the library
pnpm build
# Type check
pnpm type-check
# Watch mode for development
pnpm dev
This library includes comprehensive unit and integration tests using Vitest:
# Run all tests
pnpm test
# Run tests in watch mode
pnpm test:watch
Test coverage:
This library uses modern browser APIs:
WebSocket - For streaming audiofetch - For HTTP requestscrypto.subtle - For DRM token generationAsyncGenerator - For streaming dataMinimum browser versions:
MIT License - See LICENSE file for details.
This is a TypeScript/JavaScript port of the Python edge-tts library by rany.
Contributions are welcome! Please feel free to submit a Pull Request.
FAQs
TypeScript/JavaScript port of edge-tts for browser environments using native WebSocket and Fetch APIs
We found that @twn39/edgetts-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Company News
Socket won two 2026 Reppy Awards from RepVue, ranking in the top 5% of all sales orgs. AE Alexandra Lister shares what it's like to grow a sales career here.
Security News
NIST will stop enriching most CVEs under a new risk-based model, narrowing the NVD's scope as vulnerability submissions continue to surge.
Company News
/Security News
Socket is an initial recipient of OpenAI's Cybersecurity Grant Program, which commits $10M in API credits to defenders securing open source software.