com.google.cloud.texttospeech.v1beta1

Class TextToSpeechClient

java.lang.Object

com.google.cloud.texttospeech.v1beta1.TextToSpeechClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class TextToSpeechClient
extends Object
implements BackgroundResource

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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.newBuilder()
         .setTransportChannelProvider(
             TextToSpeechSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 TextToSpeechClient textToSpeechClient = TextToSpeechClient.create(textToSpeechSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextToSpeechClient(TextToSpeechSettings settings) Constructs an instance of TextToSpeechClient, using the given settings.
protected	TextToSpeechClient(TextToSpeechStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TextToSpeechClient	create() Constructs an instance of TextToSpeechClient with default settings.
static TextToSpeechClient	create(TextToSpeechSettings settings) Constructs an instance of TextToSpeechClient, using the given settings.
static TextToSpeechClient	create(TextToSpeechStub stub) Constructs an instance of TextToSpeechClient, using the given stub for making calls.
TextToSpeechSettings	getSettings()
TextToSpeechStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ListVoicesResponse	listVoices(ListVoicesRequest request) Returns a list of Voice supported for synthesis.
ListVoicesResponse	listVoices(String languageCode) Returns a list of Voice supported for synthesis.
UnaryCallable<ListVoicesRequest,ListVoicesResponse>	listVoicesCallable() Returns a list of Voice supported for synthesis.
void	shutdown()
void	shutdownNow()
SynthesizeSpeechResponse	synthesizeSpeech(SynthesisInput input, VoiceSelectionParams voice, AudioConfig audioConfig) Synthesizes speech synchronously: receive results after all text input has been processed.
SynthesizeSpeechResponse	synthesizeSpeech(SynthesizeSpeechRequest request) Synthesizes speech synchronously: receive results after all text input has been processed.
UnaryCallable<SynthesizeSpeechRequest,SynthesizeSpeechResponse>	synthesizeSpeechCallable() Synthesizes speech synchronously: receive results after all text input has been processed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextToSpeechClient

protected TextToSpeechClient(TextToSpeechSettings settings)
                      throws IOException

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.

Throws:

IOException

TextToSpeechClient

protected TextToSpeechClient(TextToSpeechStub stub)

Method Detail

create

public static final TextToSpeechClient create()
                                       throws IOException

Constructs an instance of TextToSpeechClient with default settings.

Throws:

IOException

create

public static final TextToSpeechClient create(TextToSpeechSettings settings)
                                       throws IOException

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.

Throws:

IOException

create

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).

getSettings

public final TextToSpeechSettings getSettings()

getStub

public TextToSpeechStub getStub()

listVoices

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);
 }
 

Parameters:

languageCode - Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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.

Throws:

ApiException - if the remote call fails

listVoices

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

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();
 }
 

synthesizeSpeech

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:

input - Required. The Synthesizer requires either plain text or SSML as input.

voice - Required. The desired voice of the synthesized audio.

audioConfig - Required. The configuration of the synthesized audio.

Throws:

ApiException - if the remote call fails

synthesizeSpeech

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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException