TextToSpeech.PlayEarcon Method

Definition

Namespace:

Android.Speech.Tts

Assembly:

Mono.Android.dll

Overloads

PlayEarcon(String, QueueMode, IDictionary<String,String>)	Obsolete. Plays the earcon using the specified queueing mode and parameters.
PlayEarcon(String, QueueMode, Bundle, String)	Plays the earcon using the specified queueing mode and parameters.

PlayEarcon(String, QueueMode, IDictionary<String,String>)

Caution

deprecated

Plays the earcon using the specified queueing mode and parameters.

[Android.Runtime.Register("playEarcon", "(Ljava/lang/String;ILjava/util/HashMap;)I", "GetPlayEarcon_Ljava_lang_String_ILjava_util_HashMap_Handler")]
[System.Obsolete("deprecated")]
public virtual Android.Speech.Tts.OperationResult PlayEarcon (string? earcon, Android.Speech.Tts.QueueMode queueMode, System.Collections.Generic.IDictionary<string,string>? params);

[<Android.Runtime.Register("playEarcon", "(Ljava/lang/String;ILjava/util/HashMap;)I", "GetPlayEarcon_Ljava_lang_String_ILjava_util_HashMap_Handler")>]
[<System.Obsolete("deprecated")>]
abstract member PlayEarcon : string * Android.Speech.Tts.QueueMode * System.Collections.Generic.IDictionary<string, string> -> Android.Speech.Tts.OperationResult
override this.PlayEarcon : string * Android.Speech.Tts.QueueMode * System.Collections.Generic.IDictionary<string, string> -> Android.Speech.Tts.OperationResult

Parameters

earcon

String

The earcon that should be played

queueMode

QueueMode

#QUEUE_ADD or #QUEUE_FLUSH.

params

IDictionary<String,String>

Parameters for the request. Can be null. Supported parameter names: Engine#KEY_PARAM_STREAM, 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 playEarcon operation.

Attributes

RegisterAttribute ObsoleteAttribute

Remarks

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with #addEarcon(String, String) or #addEarcon(String, String, int). 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 #playEarcon(String, int, Bundle, String).

Java documentation for android.speech.tts.TextToSpeech.playEarcon(java.lang.String, 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.

PlayEarcon(String, QueueMode, Bundle, String)

Plays the earcon using the specified queueing mode and parameters.

[Android.Runtime.Register("playEarcon", "(Ljava/lang/String;ILandroid/os/Bundle;Ljava/lang/String;)I", "GetPlayEarcon_Ljava_lang_String_ILandroid_os_Bundle_Ljava_lang_String_Handler")]
public virtual Android.Speech.Tts.OperationResult PlayEarcon (string? earcon, Android.Speech.Tts.QueueMode queueMode, Android.OS.Bundle? params, string? utteranceId);

[<Android.Runtime.Register("playEarcon", "(Ljava/lang/String;ILandroid/os/Bundle;Ljava/lang/String;)I", "GetPlayEarcon_Ljava_lang_String_ILandroid_os_Bundle_Ljava_lang_String_Handler")>]
abstract member PlayEarcon : string * Android.Speech.Tts.QueueMode * Android.OS.Bundle * string -> Android.Speech.Tts.OperationResult
override this.PlayEarcon : string * Android.Speech.Tts.QueueMode * Android.OS.Bundle * string -> Android.Speech.Tts.OperationResult

Parameters

earcon

String

The earcon that should be played

queueMode

QueueMode

#QUEUE_ADD or #QUEUE_FLUSH.

params

Bundle

Parameters for the request. Can be null. Supported parameter names: Engine#KEY_PARAM_STREAM, 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.

utteranceId

String

Returns

OperationResult

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

Attributes

RegisterAttribute

Remarks

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with #addEarcon(String, String) or #addEarcon(String, String, int). 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.

Java documentation for android.speech.tts.TextToSpeech.playEarcon(java.lang.String, int, android.os.Bundle, 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.