org.ka2ddo.yaac.sound

Interface SpeechMapGeneratorIfc

public interface SpeechMapGeneratorIfc

This interface defines an object that can generate on-the-fly a mapping of voice command strings to actions to handle those commands. Note that both top-level windows and Providers in plugins should implement this, so that if a plugin provides the first window, its grammars can be generated quickly without waiting for all the plugins to be processed.

Since:

PROVIDER_API_VERSION == 14

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALTERNATE_NAME Alternate name for command token in AbstractMenuAction, used in case user specifies wrong command in speech.
static java.lang.String	SPEECH_COMMAND_MAP RootPane client property name for an implementation of this interface, defining localized spoken command strings to AbstractMenuActions to carry out those commands.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentGrammarName() Get the name for the custom grammar that should be used now.
java.lang.String[]	getGrammarNames() Get the names for the custom grammars that this generator can provide.
java.util.Map<java.lang.String,AbstractMenuAction>	getSpeechCustomGrammar(java.lang.String grammarName) Get the current map of voice commands to actions

Field Detail

SPEECH_COMMAND_MAP

static final java.lang.String SPEECH_COMMAND_MAP

RootPane client property name for an implementation of this interface, defining localized spoken command strings to AbstractMenuActions to carry out those commands.

See Also:

Constant Field Values

ALTERNATE_NAME

static final java.lang.String ALTERNATE_NAME

Alternate name for command token in AbstractMenuAction, used in case user specifies wrong command in speech.

Since:

PROVIDER_API_VERSION == 52

See Also:

Constant Field Values

Method Detail

getGrammarNames

java.lang.String[] getGrammarNames()

Get the names for the custom grammars that this generator can provide.

Returns:

String array of grammar names

getCurrentGrammarName

java.lang.String getCurrentGrammarName()

Get the name for the custom grammar that should be used now.

Returns:

String of grammar name, or null if this is not the active grammar source

getSpeechCustomGrammar

java.util.Map<java.lang.String,AbstractMenuAction> getSpeechCustomGrammar(java.lang.String grammarName)

Get the current map of voice commands to actions

Parameters:

grammarName - String name of grammar to fetch

Returns:

Map of Strings to AbstractMenuActions