6.2 KiB
name, description
| name | description |
|---|---|
| edge-tts | Text-to-speech conversion using node-edge-tts npm package for generating audio from text. Supports multiple voices, languages, speed adjustment, pitch control, and subtitle generation. Use when: (1) User requests audio/voice output with triggers like "read this to me", "say that out loud", "play the audio", "narrate that", "read the search results", "tell me what you found", or when keywords "tts", "voice", "to audio", "to podcast", "read aloud" appear. (2) Content needs to be spoken rather than read (multitasking, accessibility, driving, cooking). (3) User wants a specific voice, speed, pitch, or format for TTS output. |
Edge-TTS Skill
Overview
Generate high-quality text-to-speech audio using Microsoft Edge's neural TTS service via the node-edge-tts npm package. Supports multiple languages, voices, adjustable speed/pitch, and subtitle generation.
Quick Start
When you detect TTS intent from triggers or user request:
- Call the tts tool (Bot built-in) to convert text to speech
- The tool returns a MEDIA: path
- Bot routes the audio to the current channel
// Example: Built-in tts tool usage
tts("Your text to convert to speech")
// Returns: MEDIA: /path/to/audio.mp3
Trigger Detection
Recognize these natural language patterns as TTS requests:
Direct Message TTS
- "read this to me"
- "say that out loud"
- "speak the last message"
- "play the audio for this"
- "i want to hear your response instead of reading it"
- "narrate that for me"
- "voice out the text above"
- "read it out loud"
Search Results TTS
- "read the search results"
- "tell me what you found"
- "give me a verbal summary of the news"
- "what does the internet say about [topic]? speak the answer"
- "read the top result aloud"
- "can you talk me through these findings?"
Keyword-Based
- "to audio"
- "to podcast"
- "read aloud"
- "tts"
- "voice mode"
- "audio only"
Advanced Customization
Using the Node.js Scripts
For more control, use the bundled scripts directly:
TTS Converter
cd scripts
npm install
node tts-converter.js "Your text" --voice en-US-AriaNeural --rate +10% --output output.mp3
Options:
--voice, -v: Voice name (default: en-US-AriaNeural)--lang, -l: Language code (e.g., en-US, es-ES)--format, -o: Output format (default: audio-24khz-48kbitrate-mono-mp3)--pitch: Pitch adjustment (e.g., +10%, -20%, default)--rate, -r: Rate adjustment (e.g., +10%, -20%, default)--volume: Volume adjustment (e.g., +0%, -10%, default)--save-subtitles, -s: Save subtitles as JSON file--output, -f: Output file path (default: tts_output.mp3)--proxy, -p: Proxy URL (e.g., http://localhost:7890)--timeout: Request timeout in milliseconds (default: 10000)--list-voices, -L: List available voices
Configuration Manager
cd scripts
npm install
node config-manager.js --set-voice en-US-AriaNeural
node config-manager.js --set-rate +10%
node config-manager.js --get
node config-manager.js --reset
Voice Selection
Common voices (use --list-voices for full list):
English:
en-US-MichelleNeural(female, natural, default)en-US-AriaNeural(female, natural)en-US-GuyNeural(male, natural)en-GB-SoniaNeural(female, British)en-GB-RyanNeural(male, British)
Other Languages:
es-ES-ElviraNeural(Spanish, Spain)fr-FR-DeniseNeural(French)de-DE-KatjaNeural(German)ja-JP-NanamiNeural(Japanese)zh-CN-XiaoxiaoNeural(Chinese)ar-SA-ZariyahNeural(Arabic)
Rate Guidelines
Rate values use percentage format:
"default": Normal speed"-20%"to"-10%": Slow, clear (tutorials, stories, accessibility)"+10%"to"+20%": Slightly fast (summaries)"+30%"to"+50%": Fast (news, efficiency)
Output Formats
Choose audio quality based on use case:
audio-24khz-48kbitrate-mono-mp3: Standard quality (voice notes, messages)audio-24khz-96kbitrate-mono-mp3: High quality (presentations, content)audio-48khz-96kbitrate-stereo-mp3: Highest quality (professional audio, music)
Resources
scripts/tts-converter.js
Main TTS conversion script using node-edge-tts. Generates audio files with customizable voice, rate, volume, pitch, and format. Supports subtitle generation and voice listing.
scripts/config-manager.js
Manages persistent user preferences for TTS settings (voice, language, format, pitch, rate, volume). Stores config in ~/.tts-config.json.
scripts/package.json
NPM package configuration with node-edge-tts dependency.
references/node_edge_tts_guide.md
Complete documentation for node-edge-tts npm package including:
- Full voice list by language
- Prosody options (rate, pitch, volume)
- Usage examples (CLI and Module)
- Subtitle generation
- Output formats
- Best practices and limitations
Refer to this when you need specific voice details or advanced features.
Installation
To use the bundled scripts:
cd /home/user/bot/skills/public/tts-skill/scripts
npm install
This installs:
node-edge-tts- TTS librarycommander- CLI argument parsing
Workflow
- Detect intent: Check for trigger phrases or TTS keywords in user message
- Choose method: Use built-in
ttstool for simple requests, orscripts/tts-converter.jsfor customization - Generate audio: Convert the target text (message, search results, summary)
- Return to user: The tts tool returns a MEDIA: path; Bot handles delivery
Notes
- node-edge-tts uses Microsoft Edge's online TTS service (updated, working authentication)
- No API key needed (free service)
- Output is MP3 format by default
- Requires internet connection
- Supports subtitle generation (JSON format with word-level timing)
- Audio files are temporary; Bot handles cleanup
- TTS keyword filtering: The skill automatically filters out TTS-related keywords (tts, TTS, text-to-speech) from text before conversion to avoid converting the trigger words themselves to audio
- For repeated preferences, use
config-manager.jsto set defaults - Default voice:
en-US-MichelleNeural(female, natural) - Neural voices (ending in
Neural) provide higher quality than Standard voices