Package com.google.cloud.texttospeech.v1 (2.16.0)

A client to Cloud Text-to-Speech API

The interfaces provided are listed below, along with usage samples.

TextToSpeechClient

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

Sample for TextToSpeechClient:


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

TextToSpeechLongAudioSynthesizeClient

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

Sample for TextToSpeechLongAudioSynthesizeClient:


 // 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 (TextToSpeechLongAudioSynthesizeClient textToSpeechLongAudioSynthesizeClient =
     TextToSpeechLongAudioSynthesizeClient.create()) {
   SynthesizeLongAudioRequest request =
       SynthesizeLongAudioRequest.newBuilder()
           .setParent("parent-995424086")
           .setInput(SynthesisInput.newBuilder().build())
           .setAudioConfig(AudioConfig.newBuilder().build())
           .setOutputGcsUri("outputGcsUri-489598154")
           .setVoice(VoiceSelectionParams.newBuilder().build())
           .build();
   SynthesizeLongAudioResponse response =
       textToSpeechLongAudioSynthesizeClient.synthesizeLongAudioAsync(request).get();
 }

Classes

AudioConfig

Description of audio data to be synthesized.

Protobuf type google.cloud.texttospeech.v1.AudioConfig

AudioConfig.Builder

Description of audio data to be synthesized.

Protobuf type google.cloud.texttospeech.v1.AudioConfig

CustomVoiceParams

Description of the custom voice to be synthesized.

Protobuf type google.cloud.texttospeech.v1.CustomVoiceParams

CustomVoiceParams.Builder

Description of the custom voice to be synthesized.

Protobuf type google.cloud.texttospeech.v1.CustomVoiceParams

ListVoicesRequest

The top-level message sent by the client for the ListVoices method.

Protobuf type google.cloud.texttospeech.v1.ListVoicesRequest

ListVoicesRequest.Builder

The top-level message sent by the client for the ListVoices method.

Protobuf type google.cloud.texttospeech.v1.ListVoicesRequest

ListVoicesResponse

The message returned to the client by the ListVoices method.

Protobuf type google.cloud.texttospeech.v1.ListVoicesResponse

ListVoicesResponse.Builder

The message returned to the client by the ListVoices method.

Protobuf type google.cloud.texttospeech.v1.ListVoicesResponse

SynthesisInput

Contains text input to be synthesized. Either text or ssml must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.

Protobuf type google.cloud.texttospeech.v1.SynthesisInput

SynthesisInput.Builder

Contains text input to be synthesized. Either text or ssml must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.

Protobuf type google.cloud.texttospeech.v1.SynthesisInput

SynthesizeLongAudioMetadata

Metadata for response returned by the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioMetadata

SynthesizeLongAudioMetadata.Builder

Metadata for response returned by the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioMetadata

SynthesizeLongAudioRequest

The top-level message sent by the client for the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioRequest

SynthesizeLongAudioRequest.Builder

The top-level message sent by the client for the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioRequest

SynthesizeLongAudioResponse

The message returned to the client by the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioResponse

SynthesizeLongAudioResponse.Builder

The message returned to the client by the SynthesizeLongAudio method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeLongAudioResponse

SynthesizeSpeechRequest

The top-level message sent by the client for the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechRequest

SynthesizeSpeechRequest.Builder

The top-level message sent by the client for the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechRequest

SynthesizeSpeechResponse

The message returned to the client by the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechResponse

SynthesizeSpeechResponse.Builder

The message returned to the client by the SynthesizeSpeech method.

Protobuf type google.cloud.texttospeech.v1.SynthesizeSpeechResponse

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:


 // 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:

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.
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.
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.newHttpJsonBuilder().build();
 TextToSpeechClient textToSpeechClient = TextToSpeechClient.create(textToSpeechSettings);

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

TextToSpeechGrpc

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

TextToSpeechGrpc.TextToSpeechBlockingStub

A stub to allow clients to do synchronous rpc calls to service TextToSpeech.

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

TextToSpeechGrpc.TextToSpeechFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service TextToSpeech.

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

TextToSpeechGrpc.TextToSpeechImplBase

Base class for the server implementation of the service TextToSpeech.

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

TextToSpeechGrpc.TextToSpeechStub

A stub to allow clients to do asynchronous rpc calls to service TextToSpeech.

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

TextToSpeechLongAudioSynthesisProto

TextToSpeechLongAudioSynthesizeClient

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 (TextToSpeechLongAudioSynthesizeClient textToSpeechLongAudioSynthesizeClient =
     TextToSpeechLongAudioSynthesizeClient.create()) {
   SynthesizeLongAudioRequest request =
       SynthesizeLongAudioRequest.newBuilder()
           .setParent("parent-995424086")
           .setInput(SynthesisInput.newBuilder().build())
           .setAudioConfig(AudioConfig.newBuilder().build())
           .setOutputGcsUri("outputGcsUri-489598154")
           .setVoice(VoiceSelectionParams.newBuilder().build())
           .build();
   SynthesizeLongAudioResponse response =
       textToSpeechLongAudioSynthesizeClient.synthesizeLongAudioAsync(request).get();
 }

Note: close() needs to be called on the TextToSpeechLongAudioSynthesizeClient 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:

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

This class can be customized by passing in a custom instance of TextToSpeechLongAudioSynthesizeSettings 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
 TextToSpeechLongAudioSynthesizeSettings textToSpeechLongAudioSynthesizeSettings =
     TextToSpeechLongAudioSynthesizeSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TextToSpeechLongAudioSynthesizeClient textToSpeechLongAudioSynthesizeClient =
     TextToSpeechLongAudioSynthesizeClient.create(textToSpeechLongAudioSynthesizeSettings);

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
 TextToSpeechLongAudioSynthesizeSettings textToSpeechLongAudioSynthesizeSettings =
     TextToSpeechLongAudioSynthesizeSettings.newBuilder().setEndpoint(myEndpoint).build();
 TextToSpeechLongAudioSynthesizeClient textToSpeechLongAudioSynthesizeClient =
     TextToSpeechLongAudioSynthesizeClient.create(textToSpeechLongAudioSynthesizeSettings);

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
 TextToSpeechLongAudioSynthesizeSettings textToSpeechLongAudioSynthesizeSettings =
     TextToSpeechLongAudioSynthesizeSettings.newHttpJsonBuilder().build();
 TextToSpeechLongAudioSynthesizeClient textToSpeechLongAudioSynthesizeClient =
     TextToSpeechLongAudioSynthesizeClient.create(textToSpeechLongAudioSynthesizeSettings);

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

TextToSpeechLongAudioSynthesizeGrpc

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

TextToSpeechLongAudioSynthesizeGrpc.TextToSpeechLongAudioSynthesizeBlockingStub

A stub to allow clients to do synchronous rpc calls to service TextToSpeechLongAudioSynthesize.

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

TextToSpeechLongAudioSynthesizeGrpc.TextToSpeechLongAudioSynthesizeFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service TextToSpeechLongAudioSynthesize.

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

TextToSpeechLongAudioSynthesizeGrpc.TextToSpeechLongAudioSynthesizeImplBase

Base class for the server implementation of the service TextToSpeechLongAudioSynthesize.

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

TextToSpeechLongAudioSynthesizeGrpc.TextToSpeechLongAudioSynthesizeStub

A stub to allow clients to do asynchronous rpc calls to service TextToSpeechLongAudioSynthesize.

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

TextToSpeechLongAudioSynthesizeSettings

Settings class to configure an instance of TextToSpeechLongAudioSynthesizeClient.

The default instance has everything set to sensible defaults:

The default service address (texttospeech.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of synthesizeLongAudio to 30 seconds:


 // 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
 TextToSpeechLongAudioSynthesizeSettings.Builder textToSpeechLongAudioSynthesizeSettingsBuilder =
     TextToSpeechLongAudioSynthesizeSettings.newBuilder();
 textToSpeechLongAudioSynthesizeSettingsBuilder
     .synthesizeLongAudioSettings()
     .setRetrySettings(
         textToSpeechLongAudioSynthesizeSettingsBuilder
             .synthesizeLongAudioSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TextToSpeechLongAudioSynthesizeSettings textToSpeechLongAudioSynthesizeSettings =
     textToSpeechLongAudioSynthesizeSettingsBuilder.build();

TextToSpeechLongAudioSynthesizeSettings.Builder

Builder for TextToSpeechLongAudioSynthesizeSettings.

TextToSpeechProto

TextToSpeechSettings

Settings class to configure an instance of TextToSpeechClient.

The default instance has everything set to sensible defaults:

The default service address (texttospeech.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of listVoices to 30 seconds:


 // 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.Builder textToSpeechSettingsBuilder = TextToSpeechSettings.newBuilder();
 textToSpeechSettingsBuilder
     .listVoicesSettings()
     .setRetrySettings(
         textToSpeechSettingsBuilder
             .listVoicesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TextToSpeechSettings textToSpeechSettings = textToSpeechSettingsBuilder.build();