Nectar of the Programming Masses
Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

@google-cloud/text-to-speech

0.5.0 • Public • Published
Google Cloud Platform logo

Google Cloud Text-to-Speech API: Node.js Client

release level npm version codecov

Node.js idiomatic client for Cloud Text-to-Speech API.

The Cloud Text-to-Speech API converts text or Speech Synthesis Markup Language (SSML) input into audio data of natural human speech.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Cloud Text-to-Speech API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save @google-cloud/text-to-speech

Using the client library

const fs = require('fs');
 
// Imports the Google Cloud client library
const textToSpeech = require('@google-cloud/text-to-speech');
 
// Creates a client
const client = new textToSpeech.TextToSpeechClient();
 
// The text to synthesize
const text = 'Hello, world!';
 
// Construct the request
const request = {
  input: {text: text},
  // Select the language and SSML Voice Gender (optional)
  voice: {languageCode: 'en-US', ssmlGender: 'NEUTRAL'},
  // Select the type of audio encoding
  audioConfig: {audioEncoding: 'MP3'},
};
 
// Performs the Text-to-Speech request
client.synthesizeSpeech(request, (err, response) => {
  if (err) {
    console.error('ERROR:', err);
    return;
  }
 
  // Write the binary audio content to a local file
  fs.writeFile('output.mp3', response.audioContent, 'binary', err => {
    if (err) {
      console.error('ERROR:', err);
      return;
    }
    console.log('Audio content written to file: output.mp3');
  });
});

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Synthesize Speech source code Open in Cloud Shell
List supported voices source code Open in Cloud Shell

The Cloud Text-to-Speech API Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

install

npm i @google-cloud/text-to-speech

Downloadsweekly downloads

6,245

version

0.5.0

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability