This repository has been archived by the owner on Dec 19, 2023. It is now read-only.
/
text_to_speech_client.ts
471 lines (443 loc) · 17.7 KB
/
text_to_speech_client.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
/* global window */
import * as gax from 'google-gax';
import {Callback, CallOptions, Descriptors, ClientOptions} from 'google-gax';
import * as protos from '../../protos/protos';
import jsonProtos = require('../../protos/protos.json');
/**
* Client JSON configuration object, loaded from
* `src/v1/text_to_speech_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
import * as gapicConfig from './text_to_speech_client_config.json';
const version = require('../../../package.json').version;
/**
* Service that implements Google Cloud Text-to-Speech API.
* @class
* @memberof v1
*/
export class TextToSpeechClient {
private _terminated = false;
private _opts: ClientOptions;
private _providedCustomServicePath: boolean;
private _gaxModule: typeof gax | typeof gax.fallback;
private _gaxGrpc: gax.GrpcClient | gax.fallback.GrpcClient;
private _protos: {};
private _defaults: {[method: string]: gax.CallSettings};
auth: gax.GoogleAuth;
descriptors: Descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {[name: string]: Function};
textToSpeechStub?: Promise<{[name: string]: Function}>;
/**
* Construct an instance of TextToSpeechClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - 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.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - 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
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
* In fallback mode, a special browser-compatible transport implementation is used
* instead of gRPC transport. In browser context (if the `window` object is defined)
* the fallback mode is enabled automatically; set `options.fallback` to `false`
* if you need to override this behavior.
*/
constructor(opts?: ClientOptions) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor as typeof TextToSpeechClient;
const servicePath =
opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
this._providedCustomServicePath = !!(
opts?.servicePath || opts?.apiEndpoint
);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback =
opts?.fallback ??
(typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({servicePath, port, clientConfig, fallback}, opts);
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gax.fallback : gax;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth as gax.GoogleAuth;
// Set the default scopes in auth client if needed.
if (servicePath === staticMembers.servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
if (typeof process !== 'undefined' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
} else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings(
'google.cloud.texttospeech.v1.TextToSpeech',
gapicConfig as gax.ClientConfig,
opts.clientConfig || {},
{'x-goog-api-client': clientHeader.join(' ')}
);
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = gax.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.textToSpeechStub) {
return this.textToSpeechStub;
}
// Put together the "service stub" for
// google.cloud.texttospeech.v1.TextToSpeech.
this.textToSpeechStub = this._gaxGrpc.createStub(
this._opts.fallback
? (this._protos as protobuf.Root).lookupService(
'google.cloud.texttospeech.v1.TextToSpeech'
)
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
(this._protos as any).google.cloud.texttospeech.v1.TextToSpeech,
this._opts,
this._providedCustomServicePath
) as Promise<{[method: string]: Function}>;
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const textToSpeechStubMethods = ['listVoices', 'synthesizeSpeech'];
for (const methodName of textToSpeechStubMethods) {
const callPromise = this.textToSpeechStub.then(
stub =>
(...args: Array<{}>) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
},
(err: Error | null | undefined) => () => {
throw err;
}
);
const descriptor = undefined;
const apiCall = this._gaxModule.createApiCall(
callPromise,
this._defaults[methodName],
descriptor
);
this.innerApiCalls[methodName] = apiCall;
}
return this.textToSpeechStub;
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
return 'texttospeech.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath(),
* exists for compatibility reasons.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
return 'texttospeech.googleapis.com';
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return ['https://www.googleapis.com/auth/cloud-platform'];
}
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(
callback?: Callback<string, undefined, undefined>
): Promise<string> | void {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
// -------------------
// -- Service calls --
// -------------------
listVoices(
request?: protos.google.cloud.texttospeech.v1.IListVoicesRequest,
options?: CallOptions
): Promise<
[
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
protos.google.cloud.texttospeech.v1.IListVoicesRequest | undefined,
{} | undefined
]
>;
listVoices(
request: protos.google.cloud.texttospeech.v1.IListVoicesRequest,
options: CallOptions,
callback: Callback<
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
protos.google.cloud.texttospeech.v1.IListVoicesRequest | null | undefined,
{} | null | undefined
>
): void;
listVoices(
request: protos.google.cloud.texttospeech.v1.IListVoicesRequest,
callback: Callback<
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
protos.google.cloud.texttospeech.v1.IListVoicesRequest | null | undefined,
{} | null | undefined
>
): void;
/**
* Returns a list of Voice supported for synthesis.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} [request.languageCode]
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [ListVoicesResponse]{@link google.cloud.texttospeech.v1.ListVoicesResponse}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* const [response] = await client.listVoices(request);
*/
listVoices(
request?: protos.google.cloud.texttospeech.v1.IListVoicesRequest,
optionsOrCallback?:
| CallOptions
| Callback<
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
| protos.google.cloud.texttospeech.v1.IListVoicesRequest
| null
| undefined,
{} | null | undefined
>,
callback?: Callback<
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
protos.google.cloud.texttospeech.v1.IListVoicesRequest | null | undefined,
{} | null | undefined
>
): Promise<
[
protos.google.cloud.texttospeech.v1.IListVoicesResponse,
protos.google.cloud.texttospeech.v1.IListVoicesRequest | undefined,
{} | undefined
]
> | void {
request = request || {};
let options: CallOptions;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
} else {
options = optionsOrCallback as CallOptions;
}
options = options || {};
this.initialize();
return this.innerApiCalls.listVoices(request, options, callback);
}
synthesizeSpeech(
request?: protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest,
options?: CallOptions
): Promise<
[
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest | undefined,
{} | undefined
]
>;
synthesizeSpeech(
request: protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest,
options: CallOptions,
callback: Callback<
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
| protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest
| null
| undefined,
{} | null | undefined
>
): void;
synthesizeSpeech(
request: protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest,
callback: Callback<
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
| protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest
| null
| undefined,
{} | null | undefined
>
): void;
/**
* Synthesizes speech synchronously: receive results after all text input
* has been processed.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.texttospeech.v1.SynthesisInput} request.input
* Required. The Synthesizer requires either plain text or SSML as input.
* @param {google.cloud.texttospeech.v1.VoiceSelectionParams} request.voice
* Required. The desired voice of the synthesized audio.
* @param {google.cloud.texttospeech.v1.AudioConfig} request.audioConfig
* Required. The configuration of the synthesized audio.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [SynthesizeSpeechResponse]{@link google.cloud.texttospeech.v1.SynthesizeSpeechResponse}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* const [response] = await client.synthesizeSpeech(request);
*/
synthesizeSpeech(
request?: protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest,
optionsOrCallback?:
| CallOptions
| Callback<
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
| protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest
| null
| undefined,
{} | null | undefined
>,
callback?: Callback<
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
| protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest
| null
| undefined,
{} | null | undefined
>
): Promise<
[
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechResponse,
protos.google.cloud.texttospeech.v1.ISynthesizeSpeechRequest | undefined,
{} | undefined
]
> | void {
request = request || {};
let options: CallOptions;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
} else {
options = optionsOrCallback as CallOptions;
}
options = options || {};
this.initialize();
return this.innerApiCalls.synthesizeSpeech(request, options, callback);
}
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close(): Promise<void> {
this.initialize();
if (!this._terminated) {
return this.textToSpeechStub!.then(stub => {
this._terminated = true;
stub.close();
});
}
return Promise.resolve();
}
}