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.Voice The voice to use for synthesis.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accept
protected java.lang.String	customizationId
protected java.lang.String	text
protected java.util.List<java.lang.String>	timings
protected java.lang.String	voice

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SynthesizeOptions(SynthesizeOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	accept() Gets the accept.
java.lang.String	customizationId() Gets the customizationId.
java.util.List<java.lang.String>	getTimings() Gets the timings.
SynthesizeOptions.Builder	newBuilder() New builder.
java.lang.String	text() Gets the text.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

text

protected java.lang.String text

accept

protected java.lang.String accept

voice

protected java.lang.String voice

customizationId

protected java.lang.String customizationId

timings

protected java.util.List<java.lang.String> timings

Constructor Detail

SynthesizeOptions

protected SynthesizeOptions(SynthesizeOptions.Builder builder)

Method Detail

newBuilder

public SynthesizeOptions.Builder newBuilder()

New builder.

Returns:

a SynthesizeOptions builder

text

public java.lang.String text()

Gets the text.

The text to synthesize.

Returns:

the text

accept

public java.lang.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 java.lang.String voice()

Gets the voice.

The voice to use for synthesis.

Returns:

the voice

customizationId

public java.lang.String customizationId()

Gets the customizationId.

The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice 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 java.util.List<java.lang.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