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

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

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

# SpeakHandle

[common]\
interface [SpeakHandle](index.md)

A running synthesis. [cancel](cancel.md) may be called from any thread. The model library runs an utterance to its end, so a cancel does not shorten the wait: the clip is dropped when the synthesis returns, [SpeakListener.onClip](../SpeakListener/onClip.md) is not called, and [SpeakListener.onDone](../SpeakListener/onDone.md) arrives with [SpeakReport.canceled](../SpeakReport/canceled.md) true.

## Properties

| Name | Summary |
|---|---|
| [isDone](isDone.md) | [common]<br>abstract val [isDone](isDone.md): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)<br>True once the listener's terminal call has been made. |

## Functions

| Name | Summary |
|---|---|
| [cancel](cancel.md) | [common]<br>abstract fun [cancel](cancel.md)() |