Android.Speech.Tts.TextToSpeech.PlayEarcon Method
Plays the earcon using the specified queueing mode and parameters.

Syntax

[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")]
[return:Android.Runtime.GeneratedEnum]
public virtual OperationResult PlayEarcon (string earcon, [Android.Runtime.GeneratedEnum] QueueMode queueMode, Android.OS.Bundle params, string utteranceId)

Parameters

earcon
The earcon that should be played
queueMode
TextToSpeech.QUEUE_ADD or TextToSpeech.QUEUE_FLUSH.
params
Parameters for the request. Can be null. Supported parameter names: NoType:android/speech/tts/TextToSpeech$Engine;Href=../../../../reference/android/speech/tts/TextToSpeech.Engine.html#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
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with TextToSpeech.AddEarcon(string, System.String) or TextToSpeech.AddEarcon(string, System.String, System.String). 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 TextToSpeech.SetOnUtteranceProgressListener(UtteranceProgressListener)) and using the NoType:android/speech/tts/TextToSpeech$Engine;Href=../../../../reference/android/speech/tts/TextToSpeech.Engine.html#KEY_PARAM_UTTERANCE_ID parameter.

[Android Documentation]

Requirements

Namespace: Android.Speech.Tts
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0
Since: Added in API level 4