Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googleapis/nodejs-text-to-speech

This repository is deprecated. All of its content and history has been moved to googleapis/google-cloud-node.
https://github.com/googleapis/nodejs-text-to-speech

Last synced: 3 months ago
JSON representation

This repository is deprecated. All of its content and history has been moved to googleapis/google-cloud-node.

Host: GitHub
URL: https://github.com/googleapis/nodejs-text-to-speech
Owner: googleapis
License: apache-2.0
Archived: true
Created: 2018-03-15T21:39:27.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2023-07-13T00:43:21.000Z (over 1 year ago)
Last Synced: 2024-07-31T19:44:15.724Z (5 months ago)
Size: 1.91 MB
Stars: 368
Watchers: 50
Forks: 95
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-fe-resources - nodejs-text-to-speech

README

        **_THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TO [GOOGLE-CLOUD-NODE](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-texttospeech)_**

[//]: # "This README.md file is auto-generated, all changes to this file will be lost."

[//]: # "To regenerate it, use `python -m synthtool`."



# [Google Cloud Text-to-Speech: Node.js Client](https://github.com/googleapis/nodejs-text-to-speech)

[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)

[![npm version](https://img.shields.io/npm/v/@google-cloud/text-to-speech.svg)](https://www.npmjs.org/package/@google-cloud/text-to-speech)

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

A comprehensive list of changes in each version may be found in

[the CHANGELOG](https://github.com/googleapis/nodejs-text-to-speech/blob/main/CHANGELOG.md).

* [Google Cloud Text-to-Speech Node.js Client API Reference][client-docs]

* [Google Cloud Text-to-Speech Documentation][product-docs]

* [github.com/googleapis/nodejs-text-to-speech](https://github.com/googleapis/nodejs-text-to-speech)

Read more about the client libraries for Cloud APIs, including the older

Google APIs Client Libraries, in [Client Libraries Explained][explained].

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

**Table of contents:**

* [Quickstart](#quickstart)

  * [Before you begin](#before-you-begin)

  * [Installing the client library](#installing-the-client-library)

  * [Using the client library](#using-the-client-library)

* [Samples](#samples)

* [Versioning](#versioning)

* [Contributing](#contributing)

* [License](#license)

## Quickstart

### Before you begin

1.  [Select or create a Cloud Platform project][projects].

1.  [Enable billing for your project][billing].

1.  [Enable the Google Cloud Text-to-Speech API][enable_api].

1.  [Set up authentication with a service account][auth] so you can access the

    API from your local workstation.

### Installing the client library

```bash

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

```

### Using the client library

```javascript

// Imports the Google Cloud client library

const textToSpeech = require('@google-cloud/text-to-speech');

// Import other required libraries

const fs = require('fs');

const util = require('util');

// Creates a client

const client = new textToSpeech.TextToSpeechClient();

async function quickStart() {

  // 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

  const [response] = await client.synthesizeSpeech(request);

  // Write the binary audio content to a local file

  const writeFile = util.promisify(fs.writeFile);

  await writeFile('output.mp3', response.audioContent, 'binary');

  console.log('Audio content written to file: output.mp3');

}

quickStart();

```

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/nodejs-text-to-speech/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample                      | Source Code                       | Try it |

| --------------------------- | --------------------------------- | ------ |

| Audio Profile | [source code](https://github.com/googleapis/nodejs-text-to-speech/blob/main/samples/audioProfile.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-text-to-speech&page=editor&open_in_editor=samples/audioProfile.js,samples/README.md) |

| List Voices | [source code](https://github.com/googleapis/nodejs-text-to-speech/blob/main/samples/listVoices.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-text-to-speech&page=editor&open_in_editor=samples/listVoices.js,samples/README.md) |

| Quickstart | [source code](https://github.com/googleapis/nodejs-text-to-speech/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-text-to-speech&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |

| Ssml Addresses | [source code](https://github.com/googleapis/nodejs-text-to-speech/blob/main/samples/ssmlAddresses.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-text-to-speech&page=editor&open_in_editor=samples/ssmlAddresses.js,samples/README.md) |

| Synthesize | [source code](https://github.com/googleapis/nodejs-text-to-speech/blob/main/samples/synthesize.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-text-to-speech&page=editor&open_in_editor=samples/synthesize.js,samples/README.md) |

The [Google Cloud Text-to-Speech Node.js Client API Reference][client-docs] documentation

also contains samples.

## Supported Node.js Versions

Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).

Libraries are compatible with all current _active_ and _maintenance_ versions of

Node.js.

If you are using an end-of-life version of Node.js, we recommend that you update

as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a

best-efforts basis with the following warnings:

* Legacy versions are not tested in continuous integration.

* Some security patches and features cannot be backported.

* Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and

can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).

The dist-tags follow the naming convention `legacy-(version)`.

For example, `npm install @google-cloud/text-to-speech@legacy-8` installs client libraries

for versions compatible with Node.js 8.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways

unless absolutely necessary (e.g. because of critical security issues) or with

an extensive deprecation period. Issues and requests against **stable** libraries

are addressed with the highest priority.

More Information: [Google Cloud Platform Launch Stages][launch_stages]

[launch_stages]: https://cloud.google.com/terms/launch-stages

## Contributing

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-text-to-speech/blob/main/CONTRIBUTING.md).

Please note that this `README.md`, the `samples/README.md`,

and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)

are generated from a central template. To edit one of these files, make an edit

to its templates in

[directory](https://github.com/googleapis/synthtool).

## License

Apache Version 2.0

See [LICENSE](https://github.com/googleapis/nodejs-text-to-speech/blob/main/LICENSE)

[client-docs]: https://googleapis.dev/nodejs/text-to-speech/latest

[product-docs]: https://cloud.google.com/text-to-speech

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[projects]: https://console.cloud.google.com/project

[billing]: https://support.google.com/cloud/answer/6293499#enable-billing

[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=texttospeech.googleapis.com

[auth]: https://cloud.google.com/docs/authentication/getting-started