UtteranceProgressListener.OnStop(String, Boolean) Method

Definition

Called when an utterance has been stopped while in progress or flushed from the synthesis queue.

[Android.Runtime.Register("onStop", "(Ljava/lang/String;Z)V", "GetOnStop_Ljava_lang_String_ZHandler", ApiSince=23)]
public virtual void OnStop (string? utteranceId, bool interrupted);
[<Android.Runtime.Register("onStop", "(Ljava/lang/String;Z)V", "GetOnStop_Ljava_lang_String_ZHandler", ApiSince=23)>]
abstract member OnStop : string * bool -> unit
override this.OnStop : string * bool -> unit

Parameters

utteranceId
String

The utterance ID of the utterance.

interrupted
Boolean

If true, then the utterance was interrupted while being synthesized and its output is incomplete. If false, then the utterance was flushed before the synthesis started.

Attributes

Remarks

Called when an utterance has been stopped while in progress or flushed from the synthesis queue. This can happen if a client calls TextToSpeech#stop() or uses TextToSpeech#QUEUE_FLUSH as an argument with the TextToSpeech#speak or TextToSpeech#synthesizeToFile methods.

Java documentation for android.speech.tts.UtteranceProgressListener.onStop(java.lang.String, boolean).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to