1.4.0 • Published 3 years ago

txt2audio v1.4.0

Weekly downloads
38
License
ISC
Repository
github
Last release
3 years ago

txt2audio

A small lib to convert text strings to audio files (mp3 & ogg) using Google Text to Speech api.

It uses:

Important!

To use Google Text to Speech Api you should, first, enable the api and set up an authentication method. You can read more here.

Installation

npm install txt2audio

How to use it

const Txt2Audio = require('txt2audio')

Then you should declare an object with the options you need.

const path = require('path')

let txt2audio = Txt2Audio({
  text: 'Fuck corona virus',
  filename: 'fck-corona',
  path: path.resolve(__dirname, 'audio'),
  languageCode: 'en-US',
  gender: 'female',
  ogg: true,
  debug: true
})

The Txt2Audio will return another function, generateAudio, which will generate the audio files and save them in the given path.

txt2audio.generateAudio()

Options

ArgumentTypeDefaultDescription
textstringtext from which the audio file will be generated
filenamestringname of the generated file
pathstringfolder where the file will be saved
languageCodestringen-USset the language for the api
genderstringfemalemale or female
oggboolfalsegenerate ogg version from the audio file
debugboolfalseprints the request object in the terminal

You can find a list of languageCode and gender in the Google Text to Speech Api documentation.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

Gustavo Cardoso
Gustavo Cardoso

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.