Package org.springframework.ai.audio.tts

Class DefaultTextToSpeechOptions

java.lang.Object

org.springframework.ai.audio.tts.DefaultTextToSpeechOptions

All Implemented Interfaces:

TextToSpeechOptions, ModelOptions

public final class DefaultTextToSpeechOptions
extends Object
implements TextToSpeechOptions

Default implementation of the TextToSpeechOptions interface.

Author:

Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultTextToSpeechOptions.Builder

Method Summary

Modifier and Type	Method	Description
static DefaultTextToSpeechOptions.Builder	builder()	Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.
DefaultTextToSpeechOptions	copy()	Returns a copy of this TextToSpeechOptions.
boolean	equals(Object o)
String	getFormat()	Returns the output format for the generated audio.
String	getModel()	Returns the model to use for text-to-speech.
Double	getSpeed()	Returns the speed of the generated speech.
String	getVoice()	Returns the voice to use for text-to-speech.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static DefaultTextToSpeechOptions.Builder builder()

Description copied from interface: TextToSpeechOptions

Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.

Returns:

Returns a new TextToSpeechOptions.Builder.

getModel

public String getModel()

Description copied from interface: TextToSpeechOptions

Returns the model to use for text-to-speech.

Specified by:

getModel in interface TextToSpeechOptions

Returns:

The model name.

getVoice

public String getVoice()

Description copied from interface: TextToSpeechOptions

Returns the voice to use for text-to-speech.

Specified by:

getVoice in interface TextToSpeechOptions

Returns:

The voice identifier.

getFormat

public String getFormat()

Description copied from interface: TextToSpeechOptions

Returns the output format for the generated audio.

Specified by:

getFormat in interface TextToSpeechOptions

Returns:

The output format (e.g., "mp3", "wav").

getSpeed

public Double getSpeed()

Description copied from interface: TextToSpeechOptions

Returns the speed of the generated speech.

Specified by:

getSpeed in interface TextToSpeechOptions

Returns:

The speech speed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

copy

public DefaultTextToSpeechOptions copy()

Description copied from interface: TextToSpeechOptions

Returns a copy of this TextToSpeechOptions.

Specified by:

copy in interface TextToSpeechOptions

Returns:

a copy of this TextToSpeechOptions