ai.olami.android.hotwordDetection

Class HotwordDetect

java.lang.Object

ai.olami.android.hotwordDetection.HotwordDetect

public class HotwordDetect
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESOURCE_CONTORL_MODE_AUTO_RELEASE
static int	RESOURCE_CONTROL_MODE_ALWAYS_ON

Method Summary

Modifier and Type	Method and Description
static HotwordDetect	create(android.media.AudioRecord audioRecord, android.content.Context context, IHotwordDetectListener listener) Create a HotwordDetect instance by a specified AudioRecord object reference.
static HotwordDetect	create(android.content.Context context, IHotwordDetectListener listener) Create a HotwordDetect instance.
android.media.AudioRecord	getAudioRecord() Get current or the given AudioRecord object reference
void	release() Release resources.
void	setAudioRecord(android.media.AudioRecord audioRecord) Set or change a specified AudioRecord object reference.
void	setResourceControlMode(int mode) Set the resource contorl mode for the AudioRecord resource handling.
void	startDetection() Start hotword detection.
void	stopDetection() Stop hotword detection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_CONTROL_MODE_ALWAYS_ON

public static final int RESOURCE_CONTROL_MODE_ALWAYS_ON

See Also:

Constant Field Values

RESOURCE_CONTORL_MODE_AUTO_RELEASE

public static final int RESOURCE_CONTORL_MODE_AUTO_RELEASE

See Also:

Constant Field Values

Method Detail

create

public static HotwordDetect create(android.content.Context context,
                                   IHotwordDetectListener listener)
                            throws java.lang.Exception

Create a HotwordDetect instance.

Parameters:

context - - Android Context.

listener - - The specified callback listener.

Returns:

RecorderSpeechRecognizer instance.

Throws:

java.lang.Exception

create

public static HotwordDetect create(android.media.AudioRecord audioRecord,
                                   android.content.Context context,
                                   IHotwordDetectListener listener)
                            throws java.io.IOException

Create a HotwordDetect instance by a specified AudioRecord object reference. This is usually used when you have to share the AudioRecord resource (e.g. microphone input) with/from other applications. The AudioRecord object reference you given should be initialized already.

Parameters:

audioRecord - - Reference of the specified AudioRecord.

context - - Android Context.

listener - - The specified callback listener.

Returns:

HotwordDetect instance.

Throws:

java.io.IOException

setAudioRecord

public void setAudioRecord(android.media.AudioRecord audioRecord)

Set or change a specified AudioRecord object reference. This is usually used when you have to share the AudioRecord resource (e.g. microphone input) with/from other applications. The AudioRecord object reference you given should be initialized already.

Parameters:

audioRecord - - Reference of the specified AudioRecord.

getAudioRecord

public android.media.AudioRecord getAudioRecord()

Get current or the given AudioRecord object reference

Returns:

the given AudioRecord object

startDetection

public void startDetection()
                    throws java.lang.Exception

Start hotword detection.

Throws:

java.lang.Exception - There is something wrong.

stopDetection

public void stopDetection()

Stop hotword detection. This will release resource if you are using RESOURCE_CONTORL_MODE_AUTO_RELEASE mode.

setResourceControlMode

public void setResourceControlMode(int mode)

Set the resource contorl mode for the AudioRecord resource handling. Used to determine whether to release AudioRecord resource each time a hotword is detected or the hotword detection task has completed.

Parameters:

mode - - RESOURCE_CONTROL_MODE_ALWAYS_ON for manual release. RESOURCE_CONTORL_MODE_AUTO_RELEASE for release automatically.

release

public void release()

Release resources.