Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ElevenLabs README.md #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions mod_elevenlabs_tts/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
# mod_google_tts

A Freeswitch module that allows Google Text-to-Speech API to be used as a tts provider.
A Freeswitch module that allows Eleven Labs' Text-to-Speech API to be used as a tts provider.

## API

### Commands
This freeswitch module does not add any new commands, per se. Rather, it integrates into the Freeswitch TTS interface such that it is invoked when an application uses the mod_dptools `speak` command with a tts engine of `google_tts` and a voice equal to the language code associated to one of the [supported Wavenet voices](https://cloud.google.com/text-to-speech/docs/voices)
This freeswitch module does not add any new commands, per se. Rather, it integrates into the Freeswitch TTS interface such that it is invoked when an application uses the mod_dptools `speak` command with a tts engine of `elevenlabs` and a voice equal to the language code associated to one of the [supported Eleven Labs voices](https://elevenlabs.io/docs/api-reference/query-library)

### Events
None.

## Usage
When using [drachtio-fsrmf](https://www.npmjs.com/package/drachtio-fsmrf), you can access this functionality via the speak method on the 'endpoint' object.
```js
ep.speak({
ttsEngine: 'google_tts',
voice: 'en-GB-Wavenet-A',
text: 'This aggression will not stand'
});
var text = "Hello World";
await endpoint.speak({
"ttsEngine": 'elevenlabs',
"voice": "W9OIfHh5DtdYiZUcFiql",
"text": `{use_speaker_boost=1,optimize_streaming_latency=4,style=0.5,stability=0.5,similarity_boost=0.75,api_key=XXYYZZ,model_id=eleven_turbo_v2}${text}`,
});
```
## Examples
[google_tts.js](../../examples/google_tts.js)
## Options

Documentation on these options can be found in Eleven Labs API docs: [Voice Settings](https://elevenlabs.io/docs/speech-synthesis/voice-settings)

- use_speaker_boost
- optimize_streaming_latency
- style
- stability
- similarity_boost