hp.telephony.media
Interface ASRConstants

All Known Subinterfaces:

ASRRecorderEvent, Recorder

All Known Implementing Classes:

AsyncMediaGroup

public interface ASRConstants

Defines some Symbols used by Recorder.

Since:

OCMP 2.2 with ASR/TTS extensions

Field Summary

static Symbol	a_ASSessionAllocation Specify how long a session should be allocated to a particular call.
static Symbol	a_ASSessionCreation Specify the session creation/destruction policy.
static Symbol	a_AudioService Specify Audio Service name where a session has to be allocated (reserved).
static Symbol	e_BadGrammar Possible error field in ASRRecorderEvent - the grammar supplied could not be compiled.
static Symbol	e_ResourceUnavailable Possible error field in ASRRecorderEvent - the AudioService resource is unavailable (no servers are advertising or responding).
static Symbol	e_ServerError Possible error field in ASRRecorderEvent - the server produced a protocol error during processing.
static Symbol	e_ServerFailed Possible error field in ASRRecorderEvent - the server failed during the operation.
static Symbol	ev_DefineGrammar The result of define grammar procedure.
static Symbol	ev_DefineGrammer Deprecated. incorrect spelling of grammar. ev_DefineGrammar.
static Symbol	ev_finalRuleResult Deprecated. incorrect capitalisation. ev_FinalRuleResult.
static Symbol	ev_FinalRuleResult The ASR engine has finished parsing a rule in a grammar.
static Symbol	ev_FinalWordResult The ASR engine has finished word recognition a word in dictation mode or dynamic vocabulary mode.
static Symbol	ev_NonFinalRuleResult The ASR engine has reduced a rule within the grammar.
static Symbol	ev_NonFinalWordResult ASR engine has found a word in dictation mode or dynamic vocabulary mode.
static Symbol	p_Grammar Grammar to pre-define Value is a String object
static Symbol	p_GrammarId Specifies Id associated to a grammar.
static Symbol	p_GrammarType Specifies the type of grammar
static Symbol	p_GrammarURI Define grammar if grammar date needs to be specified by external URI reference when performing a setParameters().
static Symbol	p_Language Define language to be used for the recognition Value: a string identifying a language eg: en-us = US English fr = French
static Symbol	p_LoadGrammar Load a grammar on a recognizer engine.
static Symbol	p_NBestListLength When the recognizer matches an incoming stream with the grammar, it may come up with more than one alternative matches because of confidence levels in certain words or conversation paths.
static Symbol	p_NoInputTimeout Timeout for ASR processing for maximum time with no input voice detection Value is a String Timeout is in milliseconds, default value is "5000" (5 s).
static Symbol	p_Optimize Set the ASR client (the platform) to ask a ASR session only when speak is detected and not at the beginning of the request.
static Symbol	p_PauseOnIntermediateResult Set the recognizer to automatically pause after sending non final results Value is a boolean Default value is false
static Symbol	p_RecogTimeout Timeout for ASR processing for maximum time with input but no recognition.
static Symbol	p_SaveWaveform Set the ASR server to save the RTP stream coming in.
static Symbol	p_SensitivityLevel Set the noise sensitivity level for this ASR recog session.
static Symbol	p_ServerURL Define audioserver URL to be used when performing a getParameters()/setParameters() call.
static Symbol	p_SpeakerName Specifies the name of a speaker for whom training data may be available.
static Symbol	p_SpeechCompleteTimeout Timeout for ASR processing after a good rule match but not the only possible one.
static Symbol	p_SpeechIncompleteTimeout Timeout for ASR processing after a partial rule match but no complete one.
static Symbol	p_StubResultIsNoMatch Stub use
static Symbol	p_StubResultXML Stub use
static Symbol	p_StubResultXMLFile Stub use
static Symbol	p_TimersStartImmediately Boolean flag indicating if the recognition timers should start immediately or wait for a specific action, namely setParameters with this param set to true.
static Symbol	q_VoiceDetected Indicate voice detected RTC qualifier
static Symbol	rtca_ReleaseCurrentASSession Release current operation session (if any) at operation end.
static Symbol	rtcc_VoiceDetected Voice detected trigger from signal detector
static Symbol	v_ASStartTime a_ASSessionCreation possible value.
static Symbol	v_Call a_ASSessionAllocation possible value.
static Symbol	v_FromFirstOperation a_ASSessionAllocation possible value.
static Symbol	v_OnDemand a_ASSessionCreation possible value.
static Symbol	v_Operation a_ASSessionAllocation possible value.

Field Detail

rtca_ReleaseCurrentASSession

public static final Symbol rtca_ReleaseCurrentASSession

Release current operation session (if any) at operation end.

To be used through RTCs or through AsyncMediaGroup.triggerRTC(hp.telephony.media.Symbol).

See Also:

v_Call

v_Operation

public static final Symbol v_Operation

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the ASR operation - record("rtsp://ASREnglishAS" ....) - and released at operation end - onRecorderEvent(ASRRecorderEvent event).

v_FromFirstOperation

public static final Symbol v_FromFirstOperation

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the first ASR operation - record("rtsp://ASREnglishAS" ....) - and released at call end or through rtca_ReleaseSession (deprecated) RTC action.

v_Call

public static final Symbol v_Call

a_ASSessionAllocation possible value.

The session is obtained at the beginning of the call - loopCP - and released at call end or through rtca_ReleaseCurrentASSession RTC action.

v_OnDemand

public static final Symbol v_OnDemand

a_ASSessionCreation possible value.

The session is created at ASR operation start - record("rtsp://ASREnglishAS" ....) - and destroyed either at operation end - onRecorderEvent(ASRRecorderEvent event) - or at call end depending on a_ASSessionAllocation's value.

v_ASStartTime

public static final Symbol v_ASStartTime

a_ASSessionCreation possible value.

The session is created at OCMP Audio Service Component startup and destroyed on server problem, on request timeout, on session timeout or at Audio Service Component shutdown (platform shutdown time).

a_ASSessionCreation

public static final Symbol a_ASSessionCreation

Specify the session creation/destruction policy.

Possible values: v_OnDemand or v_ASStartTime Default value: v_ASStartTime

a_ASSessionAllocation

public static final Symbol a_ASSessionAllocation

Specify how long a session should be allocated to a particular call.

Possible values: v_Call, v_FromFirstOperation or v_Operation Default value: v_FromFirstOperation

NOTE: v_Call value should be associated with attribute a_AudioService.

a_AudioService

public static final Symbol a_AudioService

Specify Audio Service name where a session has to be allocated (reserved).

Possible values: String

q_VoiceDetected

public static final Symbol q_VoiceDetected

Indicate voice detected RTC qualifier

rtcc_VoiceDetected

public static final Symbol rtcc_VoiceDetected

Voice detected trigger from signal detector

ev_NonFinalWordResult

public static final Symbol ev_NonFinalWordResult

ASR engine has found a word in dictation mode or dynamic vocabulary mode. It is still processing further speech input. When the parameter p_PauseOnIntermediateResult is set to true, the ASR engine is automatically paused and must be resumed by the application using the triggerRTC method.

ev_FinalWordResult

public static final Symbol ev_FinalWordResult

The ASR engine has finished word recognition a word in dictation mode or dynamic vocabulary mode. The ASR recorder has been stopped and the ASR resource is disconnected from the call.

ev_NonFinalRuleResult

public static final Symbol ev_NonFinalRuleResult

The ASR engine has reduced a rule within the grammar. It is still processing further speech input. When the parameter p_PauseOnIntermediateResult is set to true, the ASR engine is automatically paused and must be resumed by the application using the triggerRTC method.

ev_DefineGrammer

public static final Symbol ev_DefineGrammer

Deprecated. incorrect spelling of grammar. ev_DefineGrammar.

The result of define grammar.

ev_DefineGrammar

public static final Symbol ev_DefineGrammar

The result of define grammar procedure. The error field indicates if the definition was successful or not.

ev_finalRuleResult

public static final Symbol ev_finalRuleResult

Deprecated. incorrect capitalisation. ev_FinalRuleResult.

The ASR engine has finished parsing a rule in a grammar. The ASR recorder has been stopped and the ASR resource is disconnected from the call.

ev_FinalRuleResult

public static final Symbol ev_FinalRuleResult

The ASR engine has finished parsing a rule in a grammar. The ASR recorder has been stopped and the ASR resource is disconnected from the call.

p_Grammar

public static final Symbol p_Grammar

Grammar to pre-define Value is a String object

p_LoadGrammar

public static final Symbol p_LoadGrammar

Load a grammar on a recognizer engine. The grammar is encoded in a MimePart object. It is loaded on the recognizer. Depending on the size of the grammar and on its encoding, it may take up to several seconds to compile and load the grammar. The recognizer will not be available to process speech during this time. In such a case, it may be preferable to preload the grammar on the recognizer. Value is a String or byte array (byte[] that will be passed to the recognizer via a RTSP packet

p_GrammarId

public static final Symbol p_GrammarId

Specifies Id associated to a grammar.

Could be used either when pre-defining a grammar or when specifying an uri-list upon recognition attempt Value is a String when pre-defining a grammar and a String[] (String array) when specifying an uri-list upon recognition attempt.

p_GrammarType

public static final Symbol p_GrammarType

Specifies the type of grammar

p_SpeakerName

public static final Symbol p_SpeakerName

Specifies the name of a speaker for whom training data may be available. Value is a String object

p_PauseOnIntermediateResult

public static final Symbol p_PauseOnIntermediateResult

Set the recognizer to automatically pause after sending non final results Value is a boolean Default value is false

p_ServerURL

public static final Symbol p_ServerURL

Define audioserver URL to be used when performing a getParameters()/setParameters() call. This value must be set before a getParameters() call by a specific setParameters() call. Value : a String object containing the server's audioService name

p_GrammarURI

public static final Symbol p_GrammarURI

Define grammar if grammar date needs to be specified by external URI reference when performing a setParameters(). Value : a String object containing the URI of the grammar.

e_ResourceUnavailable

public static final Symbol e_ResourceUnavailable

Possible error field in ASRRecorderEvent - the AudioService resource is unavailable (no servers are advertising or responding).

e_BadGrammar

public static final Symbol e_BadGrammar

Possible error field in ASRRecorderEvent - the grammar supplied could not be compiled.

e_ServerFailed

public static final Symbol e_ServerFailed

Possible error field in ASRRecorderEvent - the server failed during the operation.

e_ServerError

public static final Symbol e_ServerError

Possible error field in ASRRecorderEvent - the server produced a protocol error during processing.

p_NoInputTimeout

public static final Symbol p_NoInputTimeout

Timeout for ASR processing for maximum time with no input voice detection Value is a String Timeout is in milliseconds, default value is "5000" (5 s).

p_RecogTimeout

public static final Symbol p_RecogTimeout

Timeout for ASR processing for maximum time with input but no recognition. Value is a String Timeout is in milliseconds, default value is "60000" (60 s).

p_SpeechCompleteTimeout

public static final Symbol p_SpeechCompleteTimeout

Timeout for ASR processing after a good rule match but not the only possible one. Value is a String Timeout is in milliseconds, default value is "250" (0.25 s).

p_SpeechIncompleteTimeout

public static final Symbol p_SpeechIncompleteTimeout

Timeout for ASR processing after a partial rule match but no complete one. Value is a String Timeout is in milliseconds, default value is "750" (0.75 s).

p_TimersStartImmediately

public static final Symbol p_TimersStartImmediately

Boolean flag indicating if the recognition timers should start immediately or wait for a specific action, namely setParameters with this param set to true. Value is a Boolean Default value is true ie timers start immediately.

p_SensitivityLevel

public static final Symbol p_SensitivityLevel

Set the noise sensitivity level for this ASR recog session. Value is a Float Value is between 0.0 & 1.0 (1.0 is the most sensitive)

p_NBestListLength

public static final Symbol p_NBestListLength

When the recognizer matches an incoming stream with the grammar, it may come up with more than one alternative matches because of confidence levels in certain words or conversation paths. If this header field is not specified, by default, the recognition resource will only return the best match above the confidence threshold. The client, by setting this parameter, could ask the recognition resource to send it more than 1 alternative. All alternatives must still be above the confidence-threshold. A value greater than one does not guarantee that the recognizer will send the requested number of alternatives. This header field MAY occur in RECOGNIZE, SET-PARAMS or GET-PARAMS. n-best-list-length = "N-Best-List-Length" ":" 1*DIGIT CRLF Value is a String The minimum & default value for this field is 1.

p_Optimize

public static final Symbol p_Optimize

Set the ASR client (the platform) to ask a ASR session only when speak is detected and not at the beginning of the request. Value is a Boolean Default value is false (ie the ASR license optimizer is not activated)

p_SaveWaveform

public static final Symbol p_SaveWaveform

Set the ASR server to save the RTP stream coming in. Value is a Boolean Default value is false (ie the ASR server doesn't save the waveform)

p_Language

public static final Symbol p_Language

Define language to be used for the recognition Value: a string identifying a language eg: en-us = US English fr = French

p_StubResultXML

public static final Symbol p_StubResultXML

Stub use

p_StubResultXMLFile

public static final Symbol p_StubResultXMLFile

Stub use

p_StubResultIsNoMatch

public static final Symbol p_StubResultIsNoMatch

Stub use