com.ibm.watson.text_to_speech.v1.model

Class SynthesizeOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.text_to_speech.v1.model.SynthesizeOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SynthesizeOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The synthesize options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynthesizeOptions.Builder Builder.
static interface	SynthesizeOptions.SpellOutMode *For German voices,* indicates how the service is to spell out strings of individual letters.
static interface	SynthesizeOptions.Voice The voice to use for speech synthesis.

Method Summary

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	spellOutMode() Gets the spellOutMode.
String	text() Gets the text.
String	voice() Gets the voice.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SynthesizeOptions.Builder newBuilder()

New builder.

Returns:

a SynthesizeOptions builder

text

public String text()

Gets the text.

The text to synthesize.

Returns:

the text

accept

public String accept()

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

Returns:

the accept

voice

public String voice()

Gets the voice.

The voice to use for speech synthesis. If you omit the `voice` parameter, the service uses the US English `en-US_MichaelV3Voice` by default.

_For IBM Cloud Pak for Data,_ if you do not install the `en-US_MichaelV3Voice`, you must either specify a voice with the request or specify a new default voice for your installation of the service.

**See also:** * [Using languages and voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices) * [The default voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#specify-voice-default).

Returns:

the voice

customizationId

public String customizationId()

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

Returns:

the customizationId

getTimings

public List<String> getTimings()

Gets the timings.

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.

Returns:

the timings

spellOutMode

public String spellOutMode()

Gets the spellOutMode.

*For German voices,* indicates how the service is to spell out strings of individual letters. To indicate the pace of the spelling, specify one of the following values: * `default` - The service reads the characters at the rate at which it synthesizes speech for the request. You can also omit the parameter entirely to achieve the default behavior. * `singles` - The service reads the characters one at a time, with a brief pause between each character. * `pairs` - The service reads the characters two at a time, with a brief pause between each pair. * `triples` - The service reads the characters three at a time, with a brief pause between each triplet.

The parameter is available only for IBM Cloud.

**See also:** [Specifying how strings are spelled out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-spell-out-mode).

Returns:

the spellOutMode