# com.google.mlkit.genai.speechrecognition

## Classes

|---|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions` | Options for speech recognition in `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions.Builder` | Builder class for `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizer` | Provides an interface for performing on-device speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions` | Options for `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizer`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions.Builder` | Builder class for `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest` | Request for `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizer`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest.Builder` | Builder class for `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest`. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse` | The response from the speech recognizer. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.AudioLevelResponse` | Represents the audio level detected during speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.ErrorResponse` | An error during speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.FinalTextResponse` | Final recognition result from speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.PartialTextResponse` | Partial recognition result from speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.WordTiming` | Represents timing metadata for a recognized word. |

## Objects

|---|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognition` | Entry class to get a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizer` for speech recognition. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerResponse.CompletedResponse` | Indicates that speech recognition is complete. |

## Annotations

|---|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions.Mode` | Defines options for execution mode. |

## Top-level functions summary

|---|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/package-summary#recognitionOptions(kotlin.Function1)(init: https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions.Builder.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions` in a DSL-like manner. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/package-summary#speechRecognizerOptions(kotlin.Function1)(init: https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions.Builder.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions` in a DSL-like manner. |
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/package-summary#speechRecognizerRequest(kotlin.Function1)(init: https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest.Builder.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest` in a DSL-like manner. |

## Top-level functions

### recognitionOptions

```
fun recognitionOptions(init: RecognitionOptions.Builder.() -> Unit): RecognitionOptions
```

Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/RecognitionOptions` in a DSL-like manner.

Example usage:

```kotlin
recognitionOptions {
  enableWordTiming = true
}
```

### speechRecognizerOptions

```
fun speechRecognizerOptions(init: SpeechRecognizerOptions.Builder.() -> Unit): SpeechRecognizerOptions
```

Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerOptions` in a DSL-like manner.

Example usage:

```kotlin
speechRecognizerOptions {
  executor = workerThread
  locale = Locale.US
  preferredMode = SpeechRecognizerOptions.Mode.MODE_BASIC
}
```

### speechRecognizerRequest

```
fun speechRecognizerRequest(init: SpeechRecognizerRequest.Builder.() -> Unit): SpeechRecognizerRequest
```

Helper method to construct a `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/speechrecognition/SpeechRecognizerRequest` in a DSL-like manner.

Example usage:

```kotlin
speechRecognizerRequest {
  audioSource = myAudioSource
}
```