ai.olami.android

Class KeepRecordingSpeechRecognizer

java.lang.Object

ai.olami.android.SpeechRecognizerBase

ai.olami.android.KeepRecordingSpeechRecognizer

public class KeepRecordingSpeechRecognizer
extends SpeechRecognizerBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeepRecordingSpeechRecognizer.Error Error type
static class	KeepRecordingSpeechRecognizer.RecognizeState Recognize process state

Field Summary

Fields inherited from class ai.olami.android.SpeechRecognizerBase

AUDIO_COMPRESS_LIBRARY_TYPE_CPP, AUDIO_COMPRESS_LIBRARY_TYPE_JAVA, FRAME_LENGTH_MILLISECONDS, INSTANT_NOISE_LENGTH_MILLISECONDS, RECOGNIZE_RESULT_TYPE_ALL, RECOGNIZE_RESULT_TYPE_NLI, RECOGNIZE_RESULT_TYPE_STT, RECORD_FRAMES, RESERVED_INPUT_LENGTH_MILLISECONDS, SDK_TYPE, VAD_TAIL_SILENCE_LEVEL

Method Summary

Modifier and Type	Method and Description
void	cancelRecognizing() Cancel all processes and give up to get recognition result.
static KeepRecordingSpeechRecognizer	create(IKeepRecordingSpeechRecognizerListener recognizeListener, ai.olami.cloudService.APIConfiguration config) Create a KeepRecordingSpeechRecognizer instance.
static KeepRecordingSpeechRecognizer	create(IKeepRecordingSpeechRecognizerListener recognizeListener, ai.olami.cloudService.SpeechRecognizer recognizer) Create a KeepRecordingSpeechRecognizer instance by a specified speech recognizer.
void	enableSaveRecordToFIle(boolean saveToFile) Enable/Disable to save the recorded audio to file.
void	enableSaveRecordToFile(boolean saveToFile, java.lang.String fileName) Enable/Disable to save the recorded audio to file.
android.media.AudioRecord	getAudioRecord() Get AudioRecord that used by the KeepRecordingSpeechRecognizer instance.
KeepRecordingSpeechRecognizer.RecognizeState	getRecognizeState() Get current recognize process state.
void	setApiRequestTimeout(int milliseconds) Set timeout in milliseconds of each HTTP API request.
void	setAudioRecord(android.media.AudioRecord audioRecord) Set AudioRecord for the KeepRecordingSpeechRecognizer instance.
void	setEndUserIdentifier(java.lang.String cusId) Set the identification to identify the End-user.
void	setListener(IKeepRecordingSpeechRecognizerListener listener) Set callback listener.
void	setRecognizer(ai.olami.cloudService.SpeechRecognizer recognizer) Set speech recognizer.
void	setRecognizerTimeout(int milliseconds) Set timeout in milliseconds of each recognize process (begin-to-end).
void	startRecognizing() Start the recognize processing.
void	startRecognizing(ai.olami.cloudService.NLIConfig nliConfig) Start the recognize processing.
void	startRecording() Enable microphone then start the voice recording.
void	stopRecognizing() Stop the recognize process and wait for the final recognition result.
void	stopRecordingAndReleaseResources() Stop audio recording and release all resources.

Methods inherited from class ai.olami.android.SpeechRecognizerBase

getAudioCompressLibraryType, getFrameSize, getFrequencyToGettingResult, getMinFrequencyToGettingResult, getMinUploadAudioLengthMilliseconds, getRecognizeResultType, getRecordDataSize, getSilenceLevel, getUploadAudioLengthMilliseconds, getVADEndMilliseconds, setAudioCompressLibraryType, setFrameSize, setFrequencyToGettingResult, setLengthOfVADEnd, setMinFrequencyToGettingResult, setMinUploadAudioLengthMilliseconds, setRecognizeResultType, setRecordDataSize, setResultQueryFrequency, setSilenceLevel, setSilenceLevelOfVADTail, setSpeechUploadLength, setUploadAudioLengthMilliseconds, setVADEndMilliseconds

Methods inherited from class java.lang.Object

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

Method Detail

create

public static KeepRecordingSpeechRecognizer create(IKeepRecordingSpeechRecognizerListener recognizeListener,
                                                   ai.olami.cloudService.APIConfiguration config)
                                            throws java.lang.Exception

Create a KeepRecordingSpeechRecognizer instance.

Parameters:

recognizeListener - - The specified callback listener.

config - - API configurations.

Returns:

KeepRecordingSpeechRecognizer instance.

Throws:

java.lang.Exception

create

public static KeepRecordingSpeechRecognizer create(IKeepRecordingSpeechRecognizerListener recognizeListener,
                                                   ai.olami.cloudService.SpeechRecognizer recognizer)
                                            throws java.lang.Exception

Create a KeepRecordingSpeechRecognizer instance by a specified speech recognizer.

Parameters:

recognizeListener - - The specified callback listener.

recognizer - - Configured speech recognizer.

Returns:

IotRecorderSpeechRecognizer instance.

Throws:

java.lang.Exception

setListener

public void setListener(IKeepRecordingSpeechRecognizerListener listener)

Set callback listener.

Parameters:

listener - The specified callback listener.

setRecognizer

public void setRecognizer(ai.olami.cloudService.SpeechRecognizer recognizer)

Set speech recognizer.

Parameters:

recognizer - - Configured speech recognizer.

setEndUserIdentifier

public void setEndUserIdentifier(java.lang.String cusId)

Set the identification to identify the End-user. This is helpful in some of NLU/NLI functions, such as context support.

Parameters:

cusId - - End-user identifier.

setApiRequestTimeout

public void setApiRequestTimeout(int milliseconds)

Set timeout in milliseconds of each HTTP API request. Note that each process may contain more than one request.

Parameters:

milliseconds - - Timeout in milliseconds.

setRecognizerTimeout

public void setRecognizerTimeout(int milliseconds)

Set timeout in milliseconds of each recognize process (begin-to-end). The recognize process will be cancelled if timeout and reset the state.

Parameters:

milliseconds - - Timeout in milliseconds. Default is 5000.

getRecognizeState

public KeepRecordingSpeechRecognizer.RecognizeState getRecognizeState()

Get current recognize process state.

Returns:

- Recognize process state.

stopRecordingAndReleaseResources

public void stopRecordingAndReleaseResources()

Stop audio recording and release all resources.

startRecording

public void startRecording()
                    throws java.lang.Exception

Enable microphone then start the voice recording.

Throws:

java.lang.Exception - There is something wrong.

startRecognizing

public void startRecognizing()
                      throws java.lang.InterruptedException

Start the recognize processing. The voice recording must be started before you use this method.

Throws:

java.lang.InterruptedException - There is something wrong.

startRecognizing

public void startRecognizing(ai.olami.cloudService.NLIConfig nliConfig)
                      throws java.lang.InterruptedException

Start the recognize processing. The voice recording must be started before you use this method.

Parameters:

nliConfig - - NLIConfig object.

Throws:

java.lang.InterruptedException - There is something wrong.

stopRecognizing

public void stopRecognizing()

Stop the recognize process and wait for the final recognition result.

cancelRecognizing

public void cancelRecognizing()

Cancel all processes and give up to get recognition result.

getAudioRecord

public android.media.AudioRecord getAudioRecord()

Get AudioRecord that used by the KeepRecordingSpeechRecognizer instance.

setAudioRecord

public void setAudioRecord(android.media.AudioRecord audioRecord)

Set AudioRecord for the KeepRecordingSpeechRecognizer instance.

enableSaveRecordToFIle

public void enableSaveRecordToFIle(boolean saveToFile)

Enable/Disable to save the recorded audio to file.

Parameters:

saveToFile - - Set TRUE to enable, set FALSE to disable.

enableSaveRecordToFile

public void enableSaveRecordToFile(boolean saveToFile,
                                   java.lang.String fileName)

Enable/Disable to save the recorded audio to file.

Parameters:

saveToFile - - Set TRUE to enable, set FALSE to disable.

fileName - - Name of the file you want to store the audio.