npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

edge-tts-client

v1.0.2

Published

Client-side (web browser) implementation of Edge TTS package — Microsoft Edge Read Aloud API called to generate free text-to-speech

Downloads

253

Readme

EdgeTTSClient

A TypeScript-based client for interacting with Microsoft Edge's Text-to-Speech (TTS) API. This package is compatible with both Node.js and browser environments, making it versatile for various use cases.

Features

  • 🎙️ Text-to-Speech: Synthesize speech from text using Microsoft's Edge TTS API.
  • 🌐 Cross-Platform: Works in both Node.js and the browser.
  • 📦 TypeScript Support: Includes complete TypeScript definitions.
  • 🔊 Audio Streaming: Supports real-time streaming of audio chunks.

Installation

To install the package, run:

npm install edge-tts-client

Usage

Basic Example

import { EdgeTTSClient, ProsodyOptions, OUTPUT_FORMAT } from 'edge-tts-client';

// Initialize the client
const ttsClient = new EdgeTTSClient();

// Set metadata for synthesis
await ttsClient.setMetadata('en-US-GuyNeural', OUTPUT_FORMAT.AUDIO_24KHZ_48KBITRATE_MONO_MP3);

// Define SSML options
const options = new ProsodyOptions();
options.pitch = 'medium';
options.rate = 1.2;
options.volume = 90;

// Synthesize text to a stream
const stream = ttsClient.toStream('Hello, world!', options);

// Handle the audio stream
stream.on('data', (audioChunk) => {
    console.log('Received audio chunk:', audioChunk);
});

stream.on('end', () => {
    console.log('Synthesis complete.');
});

API

EdgeTTSClient

The main class for interacting with Edge TTS.

Methods

  • setMetadata(voiceName: string, outputFormat: OUTPUT_FORMAT, voiceLocale?: string): Promise<void>

    • Sets the voice, format, and locale for TTS synthesis.
  • toStream(input: string, options?: ProsodyOptions): EventEmitter

    • Converts text to a stream of audio chunks.
  • close(): void

    • Closes the WebSocket connection.

ProsodyOptions

Defines the prosody options for SSML synthesis:

  • pitch: Pitch of the voice (e.g., 'medium', 'high').
  • rate: Speed of the speech (e.g., 1.0, 1.2).
  • volume: Volume of the audio (e.g., 90, 'loud').

OUTPUT_FORMAT

An enum defining the available output formats, such as:

  • AUDIO_24KHZ_48KBITRATE_MONO_MP3
  • WEBM_24KHZ_16BIT_MONO_OPUS

Development

Build

To build the project, run:

npm run build

Test

To run tests with Vitest:

npm run test

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes or improvements.