AWS Polly Voices

A lightweight library to get the VoiceID programmatically without install or call the heavyweight aws-sdk for nodejs. https://docs.aws.amazon.com/polly/latest/dg/voicelist.html

Getting Started

Prerequisites

node -v
node: v6.0.0

Installing

Using npm

npm install --save aws-polly-voices

Using Yarn

yarn add aws-polly-voices

How to use

Importing with Commonjs style

const Voices = require('aws-polly-voices')
const voices = new Voices()

Importing with ES6 modules style

import Voices from 'aws-polly-voices'
const voices = new Voices()

Examples

With SINGLE VoiceId

const Voices = require('aws-polly-voices')
const voices = new Voices()

const brazilianFemaleVoice = voices.brazilian().female()

// Returns the array with the voice(s) data.
// Depending on the selected language this array can have more than one element.
const voiceData = brazilianFemaleVoice.val

console.log(voiceData)
/**
 [{
  Gender: 'Female',
  Name: 'Vitória',
  LanguageName: 'Brazilian Portuguese',
  Id: 'Vitoria',
  LanguageCode: 'pt-BR'
 }]
 */

// Get the VoiceId.
// If there is only one element in voiceData array then it will return that voiceId.
// Otherwise it will return a random voiceId based on the criteria (chained methods and/or filters).
// See the next example for clarity.
const voiceId = brazilianFemaleVoice.id // Vitoria

With MULTIPLE VoiceId

const Voices = require('aws-polly-voices')
const voices = new Voices()

const englishMaleVoices = voices.english().male()

const voiceData = englishMaleVoices.val
console.log(voiceData)
/**
 [{
  Gender: 'Male',
  Name: 'Matthew',
  LanguageName: 'US English',
  Id: 'Matthew',
  LanguageCode: 'en-US'
},
{
  Gender: 'Male',
  Name: 'Justin',
  LanguageName: 'US English',
  Id: 'Justin',
  LanguageCode: 'en-US'
 }]
 */

const voiceId = englishMaleVoices.id // random value: [Matthew, Justin]
const matthew = voiceData[0].Id // Matthew
const justin = voiceData[1].Id // Justin

Full API reference

Most of the methods are chainable.

const Voices = require('aws-polly-voices')
const voices = new Voices()

// available languages by name
// this parameter can be: ['Gender', 'Name', 'LanguageName', 'Id', 'LanguageCode']
// defaults to: LanguageName
const allLanguages = voices.languages()

// available Voice Id
const allVoicesId = voices.languages('Id')

// by language: english
const english = voices.english() || voices.byLang('english')

// by language code: nl-NL
const dutch = voices.dutch() || voice.byLangCode('nl-NL')

// by gender: male || female
const portuguese = voices.portuguese().male() || voices.brazilian().male()

// by voice id
const vitoria = voices.byId('Vitoria')

// reseting the filter
const portuguese = voices.portuguese().male()

voices.reset()

const dutch = voices.dutch().female()

Running the tests

To run the tests, go to the terminal and enter npm run test

TODO

100% unit test coverage
Documentation (this file)
CI/CD with sematinc-release integrating with Travis, Github and NPM registry
Add missing helper methods to other languages/nationalities. E.g.: french, italian, spanish and so on

Contributing

If you want to collaborate, please feel free. I appreciate any help :)

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.

Authors

Cleber Gasparoto - Profile

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

License

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

daltlc / aws-polly-voices