TextToSpeechClient

TextToSpeechClient

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

Constructor

new TextToSpeechClient(optionsopt)

Construct an instance of TextToSpeechClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

listVoices(request, optionsopt, callbackopt) → {Promise}

Returns a list of Voice supported for synthesis.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
languageCode string <optional>

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

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

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

The second parameter to the callback is an object representing ListVoicesResponse.
Source:
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);
  });

synthesizeSpeech(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type 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 <optional>

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

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

The second parameter to the callback is an object representing SynthesizeSpeechResponse.
Source:
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);
  });