Class TextToSpeechClient (2.38.0)

Version 2.38.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.9
• 2.3.0
• 2.2.1
• 2.1.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

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:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   String languageCode = "languageCode-2092349083";
   ListVoicesResponse response = textToSpeechClient.listVoices(languageCode);
 }
 

Note: close() needs to be called on the TextToSpeechClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
ListVoices	Returns a list of Voice supported for synthesis.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listVoices(ListVoicesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listVoices(String languageCode) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listVoicesCallable()
SynthesizeSpeech	Synthesizes speech synchronously: receive results after all text input has been processed.	Request object method variants only take one parameter, a request object, which must be constructed before the call. synthesizeSpeech(SynthesizeSpeechRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. synthesizeSpeech(SynthesisInput input, VoiceSelectionParams voice, AudioConfig audioConfig) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. synthesizeSpeechCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TextToSpeechSettings to create(). For example:

To customize credentials:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TextToSpeechSettings textToSpeechSettings =
     TextToSpeechSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TextToSpeechClient textToSpeechClient = TextToSpeechClient.create(textToSpeechSettings);
 

To customize the endpoint:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TextToSpeechSettings textToSpeechSettings =
     TextToSpeechSettings.newBuilder().setEndpoint(myEndpoint).build();
 TextToSpeechClient textToSpeechClient = TextToSpeechClient.create(textToSpeechSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TextToSpeechSettings textToSpeechSettings = TextToSpeechSettings.newHttpJsonBuilder().build();
 TextToSpeechClient textToSpeechClient = TextToSpeechClient.create(textToSpeechSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TextToSpeechClient

Static Methods

create()

public static final TextToSpeechClient create()

Constructs an instance of TextToSpeechClient with default settings.

Returns
Type	Description
TextToSpeechClient

Exceptions
Type	Description
IOException

create(TextToSpeechSettings settings)

public static final TextToSpeechClient create(TextToSpeechSettings settings)

Constructs an instance of TextToSpeechClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	TextToSpeechSettings

Returns
Type	Description
TextToSpeechClient

Exceptions
Type	Description
IOException

create(TextToSpeechStub stub)

public static final TextToSpeechClient create(TextToSpeechStub stub)

Constructs an instance of TextToSpeechClient, using the given stub for making calls. This is for advanced usage - prefer using create(TextToSpeechSettings).

Parameter
Name	Description
stub	TextToSpeechStub

Returns
Type	Description
TextToSpeechClient

Constructors

TextToSpeechClient(TextToSpeechSettings settings)

protected TextToSpeechClient(TextToSpeechSettings settings)

Constructs an instance of TextToSpeechClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
settings	TextToSpeechSettings

TextToSpeechClient(TextToSpeechStub stub)

protected TextToSpeechClient(TextToSpeechStub stub)

Parameter
Name	Description
stub	TextToSpeechStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

getSettings()

public final TextToSpeechSettings getSettings()

Returns
Type	Description
TextToSpeechSettings

getStub()

public TextToSpeechStub getStub()

Returns
Type	Description
TextToSpeechStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listVoices(ListVoicesRequest request)

public final ListVoicesResponse listVoices(ListVoicesRequest request)

Returns a list of Voice supported for synthesis.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   ListVoicesRequest request =
       ListVoicesRequest.newBuilder().setLanguageCode("languageCode-2092349083").build();
   ListVoicesResponse response = textToSpeechClient.listVoices(request);
 }
 

Parameter
Name	Description
request	ListVoicesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ListVoicesResponse

listVoices(String languageCode)

public final ListVoicesResponse listVoices(String languageCode)

Returns a list of Voice supported for synthesis.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   String languageCode = "languageCode-2092349083";
   ListVoicesResponse response = textToSpeechClient.listVoices(languageCode);
 }
 

Parameter
Name	Description
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.

Returns
Type	Description
ListVoicesResponse

listVoicesCallable()

public final UnaryCallable<ListVoicesRequest,ListVoicesResponse> listVoicesCallable()

Returns a list of Voice supported for synthesis.

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   ListVoicesRequest request =
       ListVoicesRequest.newBuilder().setLanguageCode("languageCode-2092349083").build();
   ApiFuture<ListVoicesResponse> future =
       textToSpeechClient.listVoicesCallable().futureCall(request);
   // Do something.
   ListVoicesResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ListVoicesRequest,ListVoicesResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

synthesizeSpeech(SynthesisInput input, VoiceSelectionParams voice, AudioConfig audioConfig)

public final SynthesizeSpeechResponse synthesizeSpeech(SynthesisInput input, VoiceSelectionParams voice, AudioConfig audioConfig)

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

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   SynthesisInput input = SynthesisInput.newBuilder().build();
   VoiceSelectionParams voice = VoiceSelectionParams.newBuilder().build();
   AudioConfig audioConfig = AudioConfig.newBuilder().build();
   SynthesizeSpeechResponse response =
       textToSpeechClient.synthesizeSpeech(input, voice, audioConfig);
 }
 

Parameters
Name	Description
input	SynthesisInput Required. The Synthesizer requires either plain text or SSML as input.
voice	VoiceSelectionParams Required. The desired voice of the synthesized audio.
audioConfig	AudioConfig Required. The configuration of the synthesized audio.

Returns
Type	Description
SynthesizeSpeechResponse

synthesizeSpeech(SynthesizeSpeechRequest request)

public final SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest request)

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

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   SynthesizeSpeechRequest request =
       SynthesizeSpeechRequest.newBuilder()
           .setInput(SynthesisInput.newBuilder().build())
           .setVoice(VoiceSelectionParams.newBuilder().build())
           .setAudioConfig(AudioConfig.newBuilder().build())
           .addAllEnableTimePointing(new ArrayList<SynthesizeSpeechRequest.TimepointType>())
           .build();
   SynthesizeSpeechResponse response = textToSpeechClient.synthesizeSpeech(request);
 }
 

Parameter
Name	Description
request	SynthesizeSpeechRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SynthesizeSpeechResponse

synthesizeSpeechCallable()

public final UnaryCallable<SynthesizeSpeechRequest,SynthesizeSpeechResponse> synthesizeSpeechCallable()

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

Sample code:

 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
   SynthesizeSpeechRequest request =
       SynthesizeSpeechRequest.newBuilder()
           .setInput(SynthesisInput.newBuilder().build())
           .setVoice(VoiceSelectionParams.newBuilder().build())
           .setAudioConfig(AudioConfig.newBuilder().build())
           .addAllEnableTimePointing(new ArrayList<SynthesizeSpeechRequest.TimepointType>())
           .build();
   ApiFuture<SynthesizeSpeechResponse> future =
       textToSpeechClient.synthesizeSpeechCallable().futureCall(request);
   // Do something.
   SynthesizeSpeechResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SynthesizeSpeechRequest,SynthesizeSpeechResponse>