@audc/salute-tts
Version:
Synthesis client for Node.js
166 lines (165 loc) • 8.47 kB
TypeScript
import * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import type * as protos from '../../../protos/protos.js';
/**
* @class
* @memberof v1
*/
export declare class SmartSpeechClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
smartSpeechStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of SmartSpeechClient.
*
* @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/main/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://cloud.google.com/docs/authentication/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 | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new SmartSpeechClient({fallback: 'rest'}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath,
* exists for compatibility reasons.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): never[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.requestFileId
* @param {smartspeech.synthesis.v1.SynthesisRequest.AudioEncoding} request.audioEncoding
* @param {string} request.voice
* @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 {@link protos.smartspeech.task.v1.Task|Task}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/smart_speech.async_synthesize.js</caption>
* region_tag:sber_v1_generated_SmartSpeech_AsyncSynthesize_async
*/
asyncSynthesize(request?: protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest, options?: CallOptions): Promise<[
protos.smartspeech.task.v1.ITask,
protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest | undefined,
{} | undefined
]>;
asyncSynthesize(request: protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest, options: CallOptions, callback: Callback<protos.smartspeech.task.v1.ITask, protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest | null | undefined, {} | null | undefined>): void;
asyncSynthesize(request: protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest, callback: Callback<protos.smartspeech.task.v1.ITask, protos.smartspeech.synthesis.v1.IAsyncSynthesisRequest | null | undefined, {} | null | undefined>): void;
/**
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.text
* @param {smartspeech.synthesis.v1.SynthesisRequest.AudioEncoding} request.audioEncoding
* @param {string} request.language
* @param {smartspeech.synthesis.v1.SynthesisRequest.ContentType} request.contentType
* @param {string} request.voice
* @param {boolean} request.rebuildCache
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits {@link protos.smartspeech.synthesis.v1.SynthesisResponse|SynthesisResponse} on 'data' event.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/smart_speech.synthesize.js</caption>
* region_tag:sber_v1_generated_SmartSpeech_Synthesize_async
*/
synthesize(request?: protos.smartspeech.synthesis.v1.ISynthesisRequest, options?: CallOptions): gax.CancellableStream;
/**
* 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>;
}