android.speech.recognition
Interface NBestRecognitionResult

All Superinterfaces:

RecognitionResult

All Known Implementing Classes:

NBestRecognitionResultImpl

public interface NBestRecognitionResult
extends RecognitionResult

N-Best recognition results. Entries are sorted in decreasing order according to their probability, from the most probable result to the least probable result.

Nested Class Summary

static interface

NBestRecognitionResult.Entry Recognition result entry

Method Summary

VoicetagItem	createVoicetagItem(String VoicetagId, VoicetagItemListener listener) Creates a new VoicetagItem if the last recognition was an enrollment operation.
NBestRecognitionResult.Entry	getEntry(int index) Returns the n-best entry that contains key-value pairs associated with the recognition result.
int	getSize() Returns the number of entries in the n-best list.

Method Detail

getSize

int getSize()

Returns the number of entries in the n-best list.

Returns:

the number of entries in the n-best list

getEntry

NBestRecognitionResult.Entry getEntry(int index)
                                      throws ArrayIndexOutOfBoundsException

Returns the n-best entry that contains key-value pairs associated with the recognition result.

Parameters:

index - the index of the n-best entry

Returns:

null if all active GrammarConfiguration.grammarToMeaning() return null

Throws:

ArrayIndexOutOfBoundsException - if index is greater than size of entries

createVoicetagItem

VoicetagItem createVoicetagItem(String VoicetagId,
                                VoicetagItemListener listener)
                                throws IllegalArgumentException,
                                       IllegalStateException

Creates a new VoicetagItem if the last recognition was an enrollment operation.

Parameters:

VoicetagId - string voicetag unique id value.

listener - listens for Voicetag events

Returns:

the resulting VoicetagItem

Throws:

IllegalArgumentException - if VoicetagId is null or an empty string.

IllegalStateException - if the last recognition was not an enrollment operation