Voices

Every voice of the Piper collection: which can be used, which cannot, and why.

These are the voices audioSpeak() can use. They are Piper voices from the rhasspy/piper-voices collection, and none of them is bundled with the module: each is downloaded the first time you use it, into ~/.bxaudio/voices (see Storage).

bx-audio voices                       # the voices you can use, from the command line
bx-audio voices --excluded            # the voices that are not offered, and why
bx-audio voices joe                   # one voice in detail
bx-audio install joe                  # download a voice ahead of time
bx-audio speak "Hello" --voice=joe     # or just use it, it installs itself

audio = audioSpeak( text="Hello from BoxLang", voice="joe" );
audioSave( audio, "hello.mp3" );

Licenses

Only voices whose model card states an open license are listed: CC0, public domain, CC BY, CC BY-SA, Apache 2.0 or the Unlicense. The license column is the identifier we map the card's wording to, and the card itself stays the authority, so read it when it matters (the link in the last column leads to the training data). A voice licensed CC BY asks for credit, and CC BY-SA also asks that what you make from it is shared under the same terms. Voices whose card says non-commercial, names a custom license, says only "See URL", or says nothing are not listed.

Available voices

Use a voice by its full id, or by its short name when only one voice has that name (joe, but not ljspeech, which comes in two qualities).

Not offered

Every voice of the collection that is not offered, and why. bx-audio voices --excluded prints the same list, and audioVoices( status="excluded" ) returns it.

British English voices (en_GB) need the en_uk dictionary of the Voices engine, which is licensed GPL 3, so they are not offered. Other languages need a phonemizer the engine does not have yet.

Updating this list

This page and voices.json are generated. Run boxlang tools/update-voices.bxs in the module repository to read the current voices and their model cards again, and review the difference.