@andresaya/edge-tts 1.7.0 → 1.7.2

package/README.md

@@ -6,6 +6,8 @@
 ## Features
 
 - **Text-to-Speech**: Convert text into natural-sounding speech using Microsoft Edge's TTS capabilities.
+- **TypeScript Support**: Full TypeScript support with comprehensive type definitions included.
+- **Multiple Audio Formats**: Support for 36+ audio formats (MP3, WebM, OGG, WAV, PCM, and more).
 - **Multiple Voices**: Access a variety of voices to suit your project's needs.
 - **Voice Filtering**: Filter voices by language and gender for better selection.
 - **Audio Information**: Get detailed information about generated audio (size, duration, format).
@@ -27,6 +29,69 @@ bun add @andresaya/edge-tts
 npm install @andresaya/edge-tts
 ```
 
+## TypeScript Support
+
+Edge TTS is written in **TypeScript** and includes full type definitions. No additional `@types` packages are needed.
+
+### Available Types
+
+```typescript
+import { 
+    EdgeTTS, 
+    Constants,
+    Voice,
+    SynthesisOptions,
+    WordBoundary 
+} from '@andresaya/edge-tts';
+
+// Voice interface
+interface Voice {
+    Name: string;
+    ShortName: string;
+    Gender: 'Male' | 'Female';
+    Locale: string;
+    FriendlyName: string;
+    LocalName: string;
+}
+
+// Synthesis options
+interface SynthesisOptions {
+    pitch?: string | number;       // e.g., '+20Hz' or 20
+    rate?: string | number;        // e.g., '50%' or 50
+    volume?: string | number;      // e.g., '90%' or 90
+    inputType?: 'auto' | 'ssml' | 'text';  // Default: 'auto'
+    outputFormat?: string;         // e.g., Constants.OUTPUT_FORMAT.AUDIO_24KHZ_96KBITRATE_MONO_MP3
+}
+
+// Word boundary metadata
+interface WordBoundary {
+    type: "WordBoundary";
+    offset: number;
+    duration: number;
+    text: string;
+}
+```
+
+### Type-Safe Usage Example
+
+```typescript
+import { EdgeTTS, SynthesisOptions, Constants } from '@andresaya/edge-tts';
+
+const tts = new EdgeTTS();
+
+const options: SynthesisOptions = {
+    pitch: '+10Hz',
+    rate: '100%',
+    volume: '90%',
+    outputFormat: Constants.OUTPUT_FORMAT.WEBM_24KHZ_16BIT_MONO_OPUS
+};
+
+await tts.synthesize("TypeScript example", 'en-US-AriaNeural', options);
+
+const info = tts.getAudioInfo(); // Returns: { size: number; format: string; estimatedDuration: number }
+const boundaries = tts.getWordBoundaries(); // Returns: WordBoundary[]
+```
+
 ## Usage
 
 ### Command-Line Interface
@@ -146,12 +211,57 @@ await tts.synthesize("Hello, world!", 'en-US-AriaNeural');
 #### Advanced Synthesis with Options
 ```js
 await tts.synthesize("Hello, world!", 'en-US-AriaNeural', {
-    rate: '50%',      // Speech rate: -100% to +200% (or number)
-    volume: '90%',    // Speech volume: -100% to +100% (or number)
-    pitch: '+20Hz'    // Voice pitch: -100Hz to +100Hz (or number)
+    rate: '50%',           // Speech rate: -100% to +200% (or number)
+    volume: '90%',         // Speech volume: -100% to +100% (or number)
+    pitch: '+20Hz',        // Voice pitch: -100Hz to +100Hz (or number)
+    outputFormat: 'audio-24khz-96kbitrate-mono-mp3'  // Audio output format
 });
 ```
 
+#### Audio Output Formats
+
+Edge TTS supports multiple audio formats. You can specify the format using the `outputFormat` option:
+
+```js
+import { EdgeTTS, Constants } from '@andresaya/edge-tts';
+
+const tts = new EdgeTTS();
+
+// High quality MP3
+await tts.synthesize("Hello!", 'en-US-AriaNeural', {
+    outputFormat: Constants.OUTPUT_FORMAT.AUDIO_24KHZ_96KBITRATE_MONO_MP3
+});
+await tts.toFile('./output/audio'); // Automatically saved as .mp3
+
+// WebM/Opus for web
+await tts.synthesize("Hello!", 'en-US-AriaNeural', {
+    outputFormat: Constants.OUTPUT_FORMAT.WEBM_24KHZ_16BIT_MONO_OPUS
+});
+await tts.toFile('./output/audio'); // Automatically saved as .webm
+
+// Lossless WAV
+await tts.synthesize("Hello!", 'en-US-AriaNeural', {
+    outputFormat: Constants.OUTPUT_FORMAT.RIFF_24KHZ_16BIT_MONO_PCM
+});
+await tts.toFile('./output/audio'); // Automatically saved as .wav
+```
+
+**Available formats (all 36 tested and compatible):**
+
+- **MP3 Formats** (Streaming): 16kHz, 24kHz, 48kHz with various bitrates (32-192 kbps)
+- **Opus Formats** (Streaming): Audio, WebM, and OGG containers
+- **WAV/PCM Formats** (Non-streaming): RIFF (8-48 kHz) and RAW variants
+- **Specialized Codecs**: AMR-WB, G.722, TrueSilk, A-law, μ-law
+
+See `Constants.OUTPUT_FORMAT` for the complete list. The file extension is automatically detected based on the format.
+
+**Format recommendations:**
+- 🌐 **Web streaming**: `WEBM_24KHZ_16BIT_MONO_OPUS` or `AUDIO_24KHZ_96KBITRATE_MONO_MP3`
+- 📱 **Mobile apps**: `AUDIO_24KHZ_48KBITRATE_MONO_MP3`
+- 💾 **High quality**: `AUDIO_48KHZ_192KBITRATE_MONO_MP3` or `RIFF_48KHZ_16BIT_MONO_PCM`
+- ⚡ **Low bandwidth**: `AUDIO_16KHZ_32KBITRATE_MONO_MP3`
+
+
 #### Streaming Synthesis
 ```js
 // Stream audio data in real-time

package/dist/cli/edge-tts.js

@@ -6,7 +6,7 @@ const VoiceListCommand_1 = require("../commands/VoiceListCommand");
 const commander_1 = require("commander");
 const program = new commander_1.Command();
 program
-    .version('1.7.0')
+    .version('1.7.2')
     .addCommand(SynthesizeCommand_1.SynthesizeCommand)
     .addCommand(VoiceListCommand_1.VoiceListCommand);
 try {

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { EdgeTTS, type Voice, type SynthesisOptions } from './services/EdgeTTS';
+export { EdgeTTS, type Voice, type SynthesisOptions, type WordBoundary } from './services/EdgeTTS';
+export { Constants } from './config/constants';

package/dist/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EdgeTTS = void 0;
+exports.Constants = exports.EdgeTTS = void 0;
 var EdgeTTS_1 = require("./services/EdgeTTS");
 Object.defineProperty(exports, "EdgeTTS", { enumerable: true, get: function () { return EdgeTTS_1.EdgeTTS; } });
+var constants_1 = require("./config/constants");
+Object.defineProperty(exports, "Constants", { enumerable: true, get: function () { return constants_1.Constants; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andresaya/edge-tts",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Edge TTS is a package that allows access to the online text-to-speech service used by Microsoft Edge without the need for Microsoft Edge, Windows, or an API key.",
   "main": "dist/index.js",
   "browser": "dist/browser/edge-tts.esm.js",