From 36b07f00a24c194525483e5ed002a563de47c310 Mon Sep 17 00:00:00 2001 From: Lyle Pratt Date: Sun, 4 Feb 2024 10:24:13 -0600 Subject: [PATCH] Update README.md Updated ElevenLabs module to include an example of how to use the module as well as links to params in ElevenLabs docs. --- mod_elevenlabs_tts/README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/mod_elevenlabs_tts/README.md b/mod_elevenlabs_tts/README.md index 017a0d2..f389573 100644 --- a/mod_elevenlabs_tts/README.md +++ b/mod_elevenlabs_tts/README.md @@ -1,11 +1,11 @@ # 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. @@ -13,11 +13,19 @@ 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) \ No newline at end of file +## 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