class inner

v1.TextToSpeechClient

Source: v1/text_to_speech_client.js:57

Service that implements Google Cloud Text-to-Speech API.

Properties

apiEndpoint
port
scopes
servicePath

Methods

getProjectId(callback)
listVoices(request[, options][, callback])
synthesizeSpeech(request[, options][, callback])

new TextToSpeechClient([options])

Construct an instance of TextToSpeechClient.

Parameters

Name Type Optional Description

options

 

Yes

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

Values in options have the following properties:

Name Type Optional Description

credentials

 

Yes

Credentials object.

credentials.client_email

 

Yes

credentials.private_key

 

Yes

email

 

Yes

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

keyFilename

 

Yes

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

 

Yes

The port on which to connect to the remote host.

projectId

 

Yes

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

 

Yes

Custom promise module to use instead of native Promises.

servicePath

 

Yes

The domain name of the API remote host.

Properties

static

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

static

port

The port for this API service.

static

scopes

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

static

servicePath

The DNS address for this API service.

Methods

getProjectId(callback)

Return the project ID used by this class.

Parameter

Name Type Optional Description

callback

function(Error, string)

 

the callback to be called with the current project Id.

listVoices(request[, options][, callback]) → Promise

Returns a list of Voice supported for synthesis.

Example 

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

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


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

Parameters

Name Type Optional Description

request

Object

 

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

languageCode

string

Yes

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

Object

Yes

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

callback

function(nullable Error, nullable Object)

Yes

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.

synthesizeSpeech(request[, options][, callback]) → Promise

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

Example 

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

const client = new textToSpeech.v1.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);
  });

Parameters

Name Type Optional Description

request

Object

 

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

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

Object

Yes

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

callback

function(nullable Error, nullable Object)

Yes

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.