---
title: "SpeakOptions"
sidebar_label: "SpeakOptions"
description: "Kotlin binding reference: SpeakOptions."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

//[clika-runtime](../../../index.md)/[io.clika.modelverse](../index.md)/[SpeakOptions](index.md)

# SpeakOptions

[common]\
data class [SpeakOptions](index.md)(val exaggeration: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, val temperature: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, val cfgScale: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, val steps: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, val seed: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) = -1, val maxSpeechTokens: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, val language: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null)

The synthesis knobs of one request. A null knob, or the value [SpeakKnob.keepsDefault](../SpeakKnob/keepsDefault.md) names for it, keeps the family's own trained default (the chatterbox family: exaggeration 0.5, temperature 0.6, guidance 1.0, ten refinement steps, no seed, the text-length budget). A value under a knob's [SpeakKnob.min](../SpeakKnob/min.md) is refused before the model runs.

## Constructors

| | |
|---|---|
| [SpeakOptions](SpeakOptions.md) | [common]<br>constructor(exaggeration: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, temperature: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, cfgScale: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null, steps: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, seed: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) = -1, maxSpeechTokens: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, language: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null) |

## Properties

| Name | Summary |
|---|---|
| [cfgScale](cfgScale.md) | [common]<br>val [cfgScale](cfgScale.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null<br>The classifier-free-guidance strength, 0 or more; 0 turns the guidance off. |
| [exaggeration](exaggeration.md) | [common]<br>val [exaggeration](exaggeration.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null<br>Emotion exaggeration, 0 or more: about 0.25 reads neutral, 1.0 intense. |
| [language](language.md) | [common]<br>val [language](language.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null<br>The utterance's language, by the family's own code (`en`, `fr`); null keeps the model's default. A model that interprets no language refuses a set one, and the request ends in [SpeakListener.onError](../SpeakListener/onError.md). |
| [maxSpeechTokens](maxSpeechTokens.md) | [common]<br>val [maxSpeechTokens](maxSpeechTokens.md): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0<br>The speech-token budget ceiling, 0 or more; 0 keeps the plan the text's length sets. A smaller value may cut a long utterance, which the model refuses rather than truncates. |
| [seed](seed.md) | [common]<br>val [seed](seed.md): [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)<br>The random seed; 0 or more makes the synthesis repeatable, -1 seeds nothing. |
| [steps](steps.md) | [common]<br>val [steps](steps.md): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0<br>Refinement steps per decode block, 0 or more; 0 keeps the family's default. |
| [temperature](temperature.md) | [common]<br>val [temperature](temperature.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)? = null<br>The sampling temperature of the speech-token decode, 0 or more; 0 decodes greedily. |