org.ka2ddo.yaac.sound

Interface SpeechParamIfc

public interface SpeechParamIfc

This interface defines a means for implementors of SpeechMapGeneratorIfc to get parameter substitutions from voice commands, corresponding to macros in the command definitions.

Since:

PROVIDER_API_VERSION == 14

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_STRING Key for value associated with AbstractMenuAction to specify where and what variables in voice command should be appended.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParam(java.lang.String paramName) Get the portion of the voice command that corresponds to the specific macro name.
java.lang.String	speechNormalizeText(java.lang.String text) Convert a text string into normalized form for a speech-to-text grammar.

Field Detail

PARAM_STRING

static final java.lang.String PARAM_STRING

Key for value associated with AbstractMenuAction to specify where and what variables in voice command should be appended.

Since:

PROVIDER_API_VERSION == 51

See Also:

Constant Field Values

Method Detail

getParam

java.lang.String getParam(java.lang.String paramName)

Get the portion of the voice command that corresponds to the specific macro name.

Parameters:

paramName - String name of the macro whose provided value should be returned

Returns:

String text extracted from the voice command (can be zero length if parameter allowed no words), or null if the specified macro was not used in the matched command

speechNormalizeText

java.lang.String speechNormalizeText(java.lang.String text)

Convert a text string into normalized form for a speech-to-text grammar.

Parameters:

text - String to normalize

Returns:

normalized text (punctuation stripped, all lower case)