Constructor

TextToSpeechClient

new TextToSpeechClient(options)

Construct an instance of TextToSpeechClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

listVoices

listVoices(request, options, callback) returns Promise

Returns a list of Voice supported for synthesis.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

languageCode

Optional

string

Optional (but recommended) BCP-47 language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-" voices; when specifying "no", you will get supported "no-" (Norwegian) and "nb-" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-" voices; specifying "zh-hk" will also get supported "yue-*" voices.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ListVoicesResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing ListVoicesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const textToSpeech = require('text-to-speech.v1beta1');

const client = new textToSpeech.v1beta1.TextToSpeechClient({
  // optional auth parameters.
});


client.listVoices({})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

synthesizeSpeech

synthesizeSpeech(request, options, callback) returns Promise

Synthesizes speech synchronously: receive results after all text input has been processed.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

input

Object

Required. The Synthesizer requires either plain text or SSML as input.

This object should have the same structure as SynthesisInput

voice

Object

Required. The desired voice of the synthesized audio.

This object should have the same structure as VoiceSelectionParams

audioConfig

Object

Required. The configuration of the synthesized audio.

This object should have the same structure as AudioConfig

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing SynthesizeSpeechResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing SynthesizeSpeechResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const textToSpeech = require('text-to-speech.v1beta1');

const client = new textToSpeech.v1beta1.TextToSpeechClient({
  // optional auth parameters.
});

const input = {};
const voice = {};
const audioConfig = {};
const request = {
  input: input,
  voice: voice,
  audioConfig: audioConfig,
};
client.synthesizeSpeech(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });