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

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

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

# SpeakKnob

[common]\
data class [SpeakKnob](index.md)(val name: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val min: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html), val max: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?, val keepsDefault: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?)

One synthesis knob a text-to-speech model reads ([Capabilities.speakKnobs](../Capabilities/speakKnobs.md)), named as the constants here spell it, with the range the binding accepts.

## Constructors

| | |
|---|---|
| [SpeakKnob](SpeakKnob.md) | [common]<br>constructor(name: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), min: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html), max: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?, keepsDefault: [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?) |

## Types

| Name | Summary |
|---|---|
| [Companion](Companion/index.md) | [common]<br>object [Companion](Companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [keepsDefault](keepsDefault.md) | [common]<br>val [keepsDefault](keepsDefault.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?<br>The value that keeps the family's own default for this knob; null when a null [SpeakOptions](../SpeakOptions/index.md) field does it instead. |
| [max](max.md) | [common]<br>val [max](max.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)?<br>The largest value accepted; null when the range is open above. |
| [min](min.md) | [common]<br>val [min](min.md): [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)<br>The smallest value accepted; a request under it is refused. |
| [name](name.md) | [common]<br>val [name](name.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)<br>The knob: one of the constants below, each the name of a [SpeakOptions](../SpeakOptions/index.md) field. |