Service that implements Google Cloud Text-to-Speech API. v1beta1
Package
@google-cloud/text-to-speechConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of TextToSpeechLongAudioSynthesizeClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
operationsClient
operationsClient: gax.OperationsClient;
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
textToSpeechLongAudioSynthesizeStub
textToSpeechLongAudioSynthesizeStub?: Promise<{
[name: string]: Function;
}>;
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkSynthesizeLongAudioProgress(name)
checkSynthesizeLongAudioProgress(name: string): Promise<LROperation<protos.google.cloud.texttospeech.v1beta1.SynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.SynthesizeLongAudioMetadata>>;
Check the status of the long running operation returned by synthesizeLongAudio()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.texttospeech.v1beta1.SynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.SynthesizeLongAudioMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource states of the request in the form of
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. The Synthesizer requires either plain text or SSML as input.
*/
// const input = {}
/**
* Required. The configuration of the synthesized audio.
*/
// const audioConfig = {}
/**
* Required. Specifies a Cloud Storage URI for the synthesis results. Must be
* specified in the format: `gs://bucket_name/object_name`, and the bucket
* must already exist.
*/
// const outputGcsUri = 'abc123'
/**
* Required. The desired voice of the synthesized audio.
*/
// const voice = {}
// Imports the Texttospeech library
const {TextToSpeechLongAudioSynthesizeClient} = require('@google-cloud/text-to-speech').v1beta1;
// Instantiates a client
const texttospeechClient = new TextToSpeechLongAudioSynthesizeClient();
async function callSynthesizeLongAudio() {
// Construct request
const request = {
input,
audioConfig,
outputGcsUri,
voice,
};
// Run request
const [operation] = await texttospeechClient.synthesizeLongAudio(request);
const [response] = await operation.promise();
console.log(response);
}
callSynthesizeLongAudio();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed. |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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 | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub. |
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
gax.CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> |
{Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
synthesizeLongAudio(request, options)
synthesizeLongAudio(request?: protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Synthesizes long form text asynchronously.
Parameters | |
---|---|
Name | Description |
request |
ISynthesizeLongAudioRequest
The request object that will be sent. |
options |
gax.CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The resource states of the request in the form of
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. The Synthesizer requires either plain text or SSML as input.
*/
// const input = {}
/**
* Required. The configuration of the synthesized audio.
*/
// const audioConfig = {}
/**
* Required. Specifies a Cloud Storage URI for the synthesis results. Must be
* specified in the format: `gs://bucket_name/object_name`, and the bucket
* must already exist.
*/
// const outputGcsUri = 'abc123'
/**
* Required. The desired voice of the synthesized audio.
*/
// const voice = {}
// Imports the Texttospeech library
const {TextToSpeechLongAudioSynthesizeClient} = require('@google-cloud/text-to-speech').v1beta1;
// Instantiates a client
const texttospeechClient = new TextToSpeechLongAudioSynthesizeClient();
async function callSynthesizeLongAudio() {
// Construct request
const request = {
input,
audioConfig,
outputGcsUri,
voice,
};
// Run request
const [operation] = await texttospeechClient.synthesizeLongAudio(request);
const [response] = await operation.promise();
console.log(response);
}
callSynthesizeLongAudio();
synthesizeLongAudio(request, options, callback)
synthesizeLongAudio(request: protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISynthesizeLongAudioRequest
|
options |
gax.CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
synthesizeLongAudio(request, callback)
synthesizeLongAudio(request: protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioRequest, callback: Callback<LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISynthesizeLongAudioRequest
|
callback |
Callback<LROperation<protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioResponse, protos.google.cloud.texttospeech.v1beta1.ISynthesizeLongAudioMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |