ai.olami.android

Class RecorderSpeechRecognizer

java.lang.Object

ai.olami.android.SpeechRecognizerBase

ai.olami.android.RecorderSpeechRecognizer

public class RecorderSpeechRecognizer
extends SpeechRecognizerBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecorderSpeechRecognizer.Error Error type
static class	RecorderSpeechRecognizer.RecognizeState Recognize process state
static class	RecorderSpeechRecognizer.RecordState Recording 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	cancel() Cancel all processes and give up to get recognition result.
static RecorderSpeechRecognizer	create(IRecorderSpeechRecognizerListener listener, ai.olami.cloudService.APIConfiguration config) Create a RecorderSpeechRecognizer instance.
static RecorderSpeechRecognizer	create(IRecorderSpeechRecognizerListener listener, ai.olami.cloudService.SpeechRecognizer recognizer) Create a RecorderSpeechRecognizer instance by a specified speech recognizer.
void	enableAutoStopRecording(boolean enable) Enable or disable automatic stop voice recording.
void	enableSaveRecordToFile(boolean saveToFile, java.lang.String fileName) Enable/Disable to save the recorded audio to file.
RecorderSpeechRecognizer.RecognizeState	getRecognizeState() Get current recognize process state.
RecorderSpeechRecognizer.RecordState	getRecordState() Get current recording state.
boolean	isAutoStopRecordingEnabled() Check if automatic stop voice recording is enabled.
void	release() Stop or cancel all processes and then stopRecordingAndReleaseResources resources.
void	setApiRequestTimeout(int milliseconds) Set timeout in milliseconds of each HTTP API request.
void	setEndUserIdentifier(java.lang.String cusId) Set the identification to identify the End-user.
void	setListener(IRecorderSpeechRecognizerListener listener) Set callback listener.
void	setRecognizer(ai.olami.cloudService.SpeechRecognizer recognizer) Set speech recognizer.
void	start() Enable microphone then start the voice recording and the recognize processing.
void	start(ai.olami.cloudService.NLIConfig nliConfig) Enable microphone then start the voice recording and the recognize processing.
void	stop() Stop the voice recorder and wait for the final recognition result.

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 RecorderSpeechRecognizer create(IRecorderSpeechRecognizerListener listener,
                                              ai.olami.cloudService.APIConfiguration config)

Create a RecorderSpeechRecognizer instance.

Parameters:

listener - - The specified callback listener.

config - - API configurations.

Returns:

RecorderSpeechRecognizer instance.

create

public static RecorderSpeechRecognizer create(IRecorderSpeechRecognizerListener listener,
                                              ai.olami.cloudService.SpeechRecognizer recognizer)

Create a RecorderSpeechRecognizer instance by a specified speech recognizer.

Parameters:

listener - - The specified callback listener.

recognizer - - Configured speech recognizer.

Returns:

RecorderSpeechRecognizer instance.

setListener

public void setListener(IRecorderSpeechRecognizerListener 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.

enableAutoStopRecording

public void enableAutoStopRecording(boolean enable)

Enable or disable automatic stop voice recording.

Parameters:

enable - - Set FALSE to disable.

isAutoStopRecordingEnabled

public boolean isAutoStopRecordingEnabled()

Check if automatic stop voice recording is enabled.

Returns:

- TRUE for enabled.

getRecordState

public RecorderSpeechRecognizer.RecordState getRecordState()

Get current recording state.

Returns:

- Recording state.

getRecognizeState

public RecorderSpeechRecognizer.RecognizeState getRecognizeState()

Get current recognize process state.

Returns:

- Recognize process state.

start

public void start()
           throws java.lang.InterruptedException,
                  java.lang.IllegalStateException

Enable microphone then start the voice recording and the recognize processing.

Throws:

java.lang.InterruptedException - There is something wrong.

java.lang.IllegalStateException - You are using this method in a wrong operation state.

start

public void start(ai.olami.cloudService.NLIConfig nliConfig)
           throws java.lang.InterruptedException,
                  java.lang.IllegalStateException

Enable microphone then start the voice recording and the recognize processing.

Parameters:

nliConfig - - NLIConfig object.

Throws:

java.lang.InterruptedException - There is something wrong.

java.lang.IllegalStateException - You are using this method in a wrong operation state.

stop

public void stop()

Stop the voice recorder and wait for the final recognition result.

cancel

public void cancel()

Cancel all processes and give up to get recognition result.

release

public void release()

Stop or cancel all processes and then stopRecordingAndReleaseResources resources. This will not make any callback even if you use him to terminate any process.

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.