com.ibm.watson.text_to_speech.v1.model

Class GetPronunciationOptions

java.lang.Object

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

com.ibm.watson.text_to_speech.v1.model.GetPronunciationOptions

All Implemented Interfaces:

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

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

The getPronunciation options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetPronunciationOptions.Builder Builder.
static interface	GetPronunciationOptions.Format The phoneme format in which to return the pronunciation.
static interface	GetPronunciationOptions.Voice A voice that specifies the language in which the pronunciation is to be returned.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	customizationId
protected java.lang.String	format
protected java.lang.String	text
protected java.lang.String	voice

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	customizationId() Gets the customizationId.
java.lang.String	format() Gets the format.
GetPronunciationOptions.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

voice

protected java.lang.String voice

format

protected java.lang.String format

customizationId

protected java.lang.String customizationId

Constructor Detail

GetPronunciationOptions

protected GetPronunciationOptions(GetPronunciationOptions.Builder builder)

Method Detail

newBuilder

public GetPronunciationOptions.Builder newBuilder()

New builder.

Returns:

a GetPronunciationOptions builder

text

public java.lang.String text()

Gets the text.

The word for which the pronunciation is requested.

Returns:

the text

voice

public java.lang.String voice()

Gets the voice.

A voice that specifies the language in which the pronunciation is to be returned. All voices for the same language (for example, `en-US`) return the same translation.

Returns:

the voice

format

public java.lang.String format()

Gets the format.

The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format.

Returns:

the format

customizationId

public java.lang.String customizationId()

Gets the customizationId.

The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language of a specified custom model must match the language of the specified voice. If the word is not defined in the specified custom model, the service returns the default translation for the custom model's language. You must make the request with credentials for the instance of the service that owns the custom model. Omit the parameter to see the translation for the specified voice with no customization.

Returns:

the customizationId