ISynthesisCallback Interface

Definition

Namespace:

Android.Speech.Tts

Assembly:

Mono.Android.dll

A callback to return speech data synthesized by a text to speech engine.

[Android.Runtime.Register("android/speech/tts/SynthesisCallback", "", "Android.Speech.Tts.ISynthesisCallbackInvoker")]
public interface ISynthesisCallback : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/speech/tts/SynthesisCallback", "", "Android.Speech.Tts.ISynthesisCallbackInvoker")>]
type ISynthesisCallback = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable IDisposable

Remarks

A callback to return speech data synthesized by a text to speech engine.

The engine can provide streaming audio by calling #start, then #audioAvailable until all audio has been provided, then finally #done.

#error can be called at any stage in the synthesis process to indicate that an error has occurred, but if the call is made after a call to #done, it might be discarded.

#done must be called at the end of synthesis, regardless of errors.

All methods can be only called on the synthesis thread.

Java documentation for android.speech.tts.SynthesisCallback.

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.

Properties

Handle	Gets the JNI value of the underlying Android object. (Inherited from IJavaObject)
HasFinished	Check if Done() was called or not.
HasStarted	Check if M:Android.Speech.Tts.ISynthesisCallback.Start(System.Int32,Android.Media.Encoding,Android.Media.Encoding) was called or not.
JniIdentityHashCode	Returns the value of java.lang.System.identityHashCode() for the wrapped instance. (Inherited from IJavaPeerable)
JniManagedPeerState	State of the managed peer. (Inherited from IJavaPeerable)
JniPeerMembers	Member access and invocation support. (Inherited from IJavaPeerable)
MaxBufferSize
PeerReference	Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable)

Methods

AudioAvailable(Byte[], Int32, Int32)	The service should call this method when synthesized audio is ready for consumption.
Disposed()	Called when the instance has been disposed. (Inherited from IJavaPeerable)
DisposeUnlessReferenced()	If there are no outstanding references to this instance, then calls Dispose(); otherwise, does nothing. (Inherited from IJavaPeerable)
Done()	The service should call this method when all the synthesized audio for a request has been passed to #audioAvailable.
Error()	The service should call this method if the speech synthesis fails.
Error(TextToSpeechError)	The service should call this method if the speech synthesis fails.
Finalized()	Called when the instance has been finalized. (Inherited from IJavaPeerable)
RangeStart(Int32, Int32, Int32)	The service may call this method to provide timing information about the spoken text.
SetJniIdentityHashCode(Int32)	Set the value returned by JniIdentityHashCode. (Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)	Set the value returned by PeerReference. (Inherited from IJavaPeerable)
Start(Int32, Encoding, Int32)	The service should call this when it starts to synthesize audio for this request.
UnregisterFromRuntime()	Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)