txt2audio
v1.4.0
Published
A small lib to convert text strings to audio files (mp3 & ogg) using Google Text to Speech api.
Downloads
35
Maintainers
Readme
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
| Argument | Type | Default | Description |
| -------------- | -------- | ------- | ------------------------------------------------ |
| text
| string | | text from which the audio file will be generated |
| filename
| string | | name of the generated file |
| path
| string | | folder where the file will be saved |
| languageCode
| string | en-US | set the language for the api |
| gender
| string | female | male or female |
| ogg
| bool | false | generate ogg version from the audio file |
| debug
| bool | false | prints 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 |
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.