public class SoundTriggerModule extends Object
Modifier and Type | Method and Description |
---|---|
void |
detach()
Detach from this module.
|
protected void |
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
int |
loadSoundModel(SoundTrigger.SoundModel model,
int[] soundModelHandle)
Load a
SoundTrigger.SoundModel to the hardware. |
int |
startRecognition(int soundModelHandle,
SoundTrigger.RecognitionConfig config)
Start listening to all key phrases in a
SoundTrigger.SoundModel . |
int |
stopRecognition(int soundModelHandle)
Stop listening to all key phrases in a
SoundTrigger.SoundModel |
int |
unloadSoundModel(int soundModelHandle)
Unload a
SoundTrigger.SoundModel and abort any pendiong recognition |
protected void finalize()
Object
finalize
method to dispose of
system resources or to perform other cleanup.
The general contract of finalize
is that it is invoked
if and when the JavaTM virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The finalize
method may take any action, including
making this object available again to other threads; the usual purpose
of finalize
, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.
The finalize
method of class Object
performs no
special action; it simply returns normally. Subclasses of
Object
may override this definition.
The Java programming language does not guarantee which thread will
invoke the finalize
method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.
After the finalize
method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.
The finalize
method is never invoked more than once by a Java
virtual machine for any given object.
Any exception thrown by the finalize
method causes
the finalization of this object to be halted, but is otherwise
ignored.
public void detach()
SoundTrigger.StatusListener
callback will not be called
anymore and associated resources will be released.public int loadSoundModel(SoundTrigger.SoundModel model, int[] soundModelHandle)
SoundTrigger.SoundModel
to the hardware. A sound model must be loaded in
order to start listening to a key phrase in this model.model
- The sound model to load.soundModelHandle
- an array of int where the sound model handle will be returned.SoundTrigger.STATUS_OK
in case of success
- SoundTrigger.STATUS_ERROR
in case of unspecified error
- SoundTrigger.STATUS_PERMISSION_DENIED
if the caller does not have
system permission
- SoundTrigger.STATUS_NO_INIT
if the native service cannot be reached
- SoundTrigger.STATUS_BAD_VALUE
if parameters are invalid
- SoundTrigger.STATUS_DEAD_OBJECT
if the binder transaction to the native
service fails
- SoundTrigger.STATUS_INVALID_OPERATION
if the call is out of sequencepublic int unloadSoundModel(int soundModelHandle)
SoundTrigger.SoundModel
and abort any pendiong recognitionsoundModelHandle
- The sound model handleSoundTrigger.STATUS_OK
in case of success
- SoundTrigger.STATUS_ERROR
in case of unspecified error
- SoundTrigger.STATUS_PERMISSION_DENIED
if the caller does not have
system permission
- SoundTrigger.STATUS_NO_INIT
if the native service cannot be reached
- SoundTrigger.STATUS_BAD_VALUE
if the sound model handle is invalid
- SoundTrigger.STATUS_DEAD_OBJECT
if the binder transaction to the native
service failspublic int startRecognition(int soundModelHandle, SoundTrigger.RecognitionConfig config)
SoundTrigger.SoundModel
.
Recognition must be restarted after each callback (success or failure) received on
the SoundTrigger.StatusListener
.soundModelHandle
- The sound model handle to start listening toconfig
- contains configuration information for this recognition request:
recognition mode, keyphrases, users, minimum confidence levels...SoundTrigger.STATUS_OK
in case of success
- SoundTrigger.STATUS_ERROR
in case of unspecified error
- SoundTrigger.STATUS_PERMISSION_DENIED
if the caller does not have
system permission
- SoundTrigger.STATUS_NO_INIT
if the native service cannot be reached
- SoundTrigger.STATUS_BAD_VALUE
if the sound model handle is invalid
- SoundTrigger.STATUS_DEAD_OBJECT
if the binder transaction to the native
service fails
- SoundTrigger.STATUS_INVALID_OPERATION
if the call is out of sequencepublic int stopRecognition(int soundModelHandle)
SoundTrigger.SoundModel
soundModelHandle
- The sound model handle to stop listening toSoundTrigger.STATUS_OK
in case of success
- SoundTrigger.STATUS_ERROR
in case of unspecified error
- SoundTrigger.STATUS_PERMISSION_DENIED
if the caller does not have
system permission
- SoundTrigger.STATUS_NO_INIT
if the native service cannot be reached
- SoundTrigger.STATUS_BAD_VALUE
if the sound model handle is invalid
- SoundTrigger.STATUS_DEAD_OBJECT
if the binder transaction to the native
service fails
- SoundTrigger.STATUS_INVALID_OPERATION
if the call is out of sequence