@Generated(value="by gapic-generator") @BetaApi public class TextToSpeechClient extends Object implements BackgroundResource
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:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
String languageCode = "";
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:
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:
TextToSpeechSettings textToSpeechSettings =
TextToSpeechSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TextToSpeechClient textToSpeechClient =
TextToSpeechClient.create(textToSpeechSettings);
To customize the endpoint:
TextToSpeechSettings textToSpeechSettings =
TextToSpeechSettings.newBuilder().setEndpoint(myEndpoint).build();
TextToSpeechClient textToSpeechClient =
TextToSpeechClient.create(textToSpeechSettings);
Modifier | Constructor and Description |
---|---|
protected |
TextToSpeechClient(TextToSpeechSettings settings)
Constructs an instance of TextToSpeechClient, using the given settings.
|
protected |
TextToSpeechClient(TextToSpeechStub stub) |
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() |
com.google.cloud.texttospeech.v1.ListVoicesResponse |
listVoices(com.google.cloud.texttospeech.v1.ListVoicesRequest request)
Returns a list of Voice supported for synthesis.
|
com.google.cloud.texttospeech.v1.ListVoicesResponse |
listVoices(String languageCode)
Returns a list of Voice supported for synthesis.
|
UnaryCallable<com.google.cloud.texttospeech.v1.ListVoicesRequest,com.google.cloud.texttospeech.v1.ListVoicesResponse> |
listVoicesCallable()
Returns a list of Voice supported for synthesis.
|
void |
shutdown() |
void |
shutdownNow() |
com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse |
synthesizeSpeech(com.google.cloud.texttospeech.v1.SynthesisInput input,
com.google.cloud.texttospeech.v1.VoiceSelectionParams voice,
com.google.cloud.texttospeech.v1.AudioConfig audioConfig)
Synthesizes speech synchronously: receive results after all text input has been processed.
|
com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse |
synthesizeSpeech(com.google.cloud.texttospeech.v1.SynthesizeSpeechRequest request)
Synthesizes speech synchronously: receive results after all text input has been processed.
|
UnaryCallable<com.google.cloud.texttospeech.v1.SynthesizeSpeechRequest,com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse> |
synthesizeSpeechCallable()
Synthesizes speech synchronously: receive results after all text input has been processed.
|
protected TextToSpeechClient(TextToSpeechSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected TextToSpeechClient(TextToSpeechStub stub)
public static final TextToSpeechClient create() throws IOException
IOException
public static final TextToSpeechClient create(TextToSpeechSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final TextToSpeechClient create(TextToSpeechStub stub)
public final TextToSpeechSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public TextToSpeechStub getStub()
public final com.google.cloud.texttospeech.v1.ListVoicesResponse listVoices(String languageCode)
Sample code:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
String languageCode = "";
ListVoicesResponse response = textToSpeechClient.listVoices(languageCode);
}
languageCode
- Optional (but recommended)
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the
ListVoices call will only return voices that can be used to synthesize this language_code.
E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying
"no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal)
voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will
also get supported "yue-*" voices.ApiException
- if the remote call failspublic final com.google.cloud.texttospeech.v1.ListVoicesResponse listVoices(com.google.cloud.texttospeech.v1.ListVoicesRequest request)
Sample code:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
ListVoicesRequest request = ListVoicesRequest.newBuilder().build();
ListVoicesResponse response = textToSpeechClient.listVoices(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.texttospeech.v1.ListVoicesRequest,com.google.cloud.texttospeech.v1.ListVoicesResponse> listVoicesCallable()
Sample code:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
ListVoicesRequest request = ListVoicesRequest.newBuilder().build();
ApiFuture<ListVoicesResponse> future = textToSpeechClient.listVoicesCallable().futureCall(request);
// Do something
ListVoicesResponse response = future.get();
}
public final com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse synthesizeSpeech(com.google.cloud.texttospeech.v1.SynthesisInput input, com.google.cloud.texttospeech.v1.VoiceSelectionParams voice, com.google.cloud.texttospeech.v1.AudioConfig audioConfig)
Sample code:
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);
}
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.ApiException
- if the remote call failspublic final com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse synthesizeSpeech(com.google.cloud.texttospeech.v1.SynthesizeSpeechRequest request)
Sample code:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
SynthesisInput input = SynthesisInput.newBuilder().build();
VoiceSelectionParams voice = VoiceSelectionParams.newBuilder().build();
AudioConfig audioConfig = AudioConfig.newBuilder().build();
SynthesizeSpeechRequest request = SynthesizeSpeechRequest.newBuilder()
.setInput(input)
.setVoice(voice)
.setAudioConfig(audioConfig)
.build();
SynthesizeSpeechResponse response = textToSpeechClient.synthesizeSpeech(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.cloud.texttospeech.v1.SynthesizeSpeechRequest,com.google.cloud.texttospeech.v1.SynthesizeSpeechResponse> synthesizeSpeechCallable()
Sample code:
try (TextToSpeechClient textToSpeechClient = TextToSpeechClient.create()) {
SynthesisInput input = SynthesisInput.newBuilder().build();
VoiceSelectionParams voice = VoiceSelectionParams.newBuilder().build();
AudioConfig audioConfig = AudioConfig.newBuilder().build();
SynthesizeSpeechRequest request = SynthesizeSpeechRequest.newBuilder()
.setInput(input)
.setVoice(voice)
.setAudioConfig(audioConfig)
.build();
ApiFuture<SynthesizeSpeechResponse> future = textToSpeechClient.synthesizeSpeechCallable().futureCall(request);
// Do something
SynthesizeSpeechResponse response = future.get();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.