public class SynthesizeOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
SynthesizeOptions.Builder
Builder.
|
static interface |
SynthesizeOptions.Voice
The voice to use for synthesis.
|
Modifier and Type | Method and Description |
---|---|
String |
accept()
Gets the accept.
|
String |
customizationId()
Gets the customizationId.
|
List<String> |
getTimings()
Gets the timings.
|
SynthesizeOptions.Builder |
newBuilder()
New builder.
|
String |
text()
Gets the text.
|
String |
voice()
Gets the voice.
|
public SynthesizeOptions.Builder newBuilder()
public String text()
The text to synthesize.
public String accept()
The requested format (MIME type) of the audio. You can use the `Accept` header or the `accept` parameter to specify the audio format. For more information about specifying an audio format, see **Audio formats (accept types)** in the method description.
public String voice()
The voice to use for synthesis. If you omit the `voice` parameter, the service uses a default voice, which depends on the version of the service that you are using: * _For IBM Cloud,_ the service always uses the US English `en-US_MichaelV3Voice` by default. * _For IBM Cloud Pak for Data,_ the default voice depends on the voices that you installed. If you installed the _enhanced neural voices_, the service uses the US English `en-US_MichaelV3Voice` by default; if that voice is not installed, you must specify a voice. If you installed the _neural voices_, the service always uses the Australian English `en-AU_MadisonVoice` by default.
**See also:** See also [Using languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices).
public String customizationId()
The customization ID (GUID) of a custom model to use for the synthesis. If a custom model is specified, it works only if it matches the language of the indicated voice. You must make the request with credentials for the instance of the service that owns the custom model. Omit the parameter to use the specified voice with no customization.
public List<String> getTimings()
An array that specifies whether the service is to return word timing information for all strings of the input text. Specify `words` as the element of the array to request word timing information. The service returns the start and end time of each word of the input. Specify an empty array or omit the parameter to receive no word timing information. Not supported for Japanese input text.
NOTE: This parameter only works for the `synthesizeUsingWebSocket` method.
Copyright © 2022 IBM Cloud. All rights reserved.