TextToSpeech.PlaySilence Method

Reference

Definition

Namespace:: Android.Speech.Tts

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

deprecated

Plays silence for the specified amount of time using the specified queue mode.

[Android.Runtime.Register("playSilence", "(JILjava/util/HashMap;)I", "GetPlaySilence_JILjava_util_HashMap_Handler")]
[System.Obsolete("deprecated")]
public virtual Android.Speech.Tts.OperationResult PlaySilence (long durationInMs, Android.Speech.Tts.QueueMode queueMode, System.Collections.Generic.IDictionary<string,string>? params);

[<Android.Runtime.Register("playSilence", "(JILjava/util/HashMap;)I", "GetPlaySilence_JILjava_util_HashMap_Handler")>]
[<System.Obsolete("deprecated")>]
abstract member PlaySilence : int64 * Android.Speech.Tts.QueueMode * System.Collections.Generic.IDictionary<string, string> -> Android.Speech.Tts.OperationResult
override this.PlaySilence : int64 * Android.Speech.Tts.QueueMode * System.Collections.Generic.IDictionary<string, string> -> Android.Speech.Tts.OperationResult

Parameters

durationInMs: Int64

The duration of the silence.

queueMode: QueueMode

#QUEUE_ADD or #QUEUE_FLUSH.

params: IDictionary<String,String>

Parameters for the request. Can be null. Supported parameter names: Engine#KEY_PARAM_UTTERANCE_ID. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used.

Returns

OperationResult

#ERROR or #SUCCESS of <b>queuing</b> the playSilence operation.

Attributes: RegisterAttribute ObsoleteAttribute

Remarks

Plays silence for the specified amount of time using the specified queue mode. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see #setOnUtteranceProgressListener) and using the Engine#KEY_PARAM_UTTERANCE_ID parameter.

This member is deprecated. As of API level 21, replaced by #playSilentUtterance(long, int, String).

Java documentation for android.speech.tts.TextToSpeech.playSilence(long, int, java.util.HashMap<java.lang.String, java.lang.String>).

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