Cloud Text-to-Speech V1 Client - Class TextToSpeechClient (1.4.5)

Reference documentation and code samples for the Cloud Text-to-Speech V1 Client class TextToSpeechClient.

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$textToSpeechClient = new TextToSpeechClient();
try {
    $response = $textToSpeechClient->listVoices();
} finally {
    $textToSpeechClient->close();
}

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed {@see} object or {@see} object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see {@see} .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated {@see} object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the {@see} and {@see} methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

listVoices

Returns a list of Voice supported for synthesis.

Sample code:

$textToSpeechClient = new TextToSpeechClient();
try {
    $response = $textToSpeechClient->listVoices();
} finally {
    $textToSpeechClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ languageCode`	`string` Optional. Recommended. BCP-47 language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both `"no-\"` (Norwegian) and `"nb-\"` (Norwegian Bokmal) voices will be returned.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\TextToSpeech\V1\ListVoicesResponse`

synthesizeSpeech

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

Sample code:

$textToSpeechClient = new TextToSpeechClient();
try {
    $input = new SynthesisInput();
    $voice = new VoiceSelectionParams();
    $audioConfig = new AudioConfig();
    $response = $textToSpeechClient->synthesizeSpeech($input, $voice, $audioConfig);
} finally {
    $textToSpeechClient->close();
}

Parameters
Name	Description
`input`	`Google\Cloud\TextToSpeech\V1\SynthesisInput` Required. The Synthesizer requires either plain text or SSML as input.
`voice`	`Google\Cloud\TextToSpeech\V1\VoiceSelectionParams` Required. The desired voice of the synthesized audio.
`audioConfig`	`Google\Cloud\TextToSpeech\V1\AudioConfig` Required. The configuration of the synthesized audio.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\TextToSpeech\V1\SynthesizeSpeechResponse`

Constants

SERVICE_NAME

Value: 'google.cloud.texttospeech.v1.TextToSpeech'

The name of the service.

SERVICE_ADDRESS

Value: 'texttospeech.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.