VoiceRecognition_Complete

Metreos.MediaControl.VoiceRecognition_Complete

Summary

The VoiceRecognition action is completely and successfully finished upon receiving the VoiceRecognition_Complete event.

Event Parameters
Parameter Name.NET TypeDescription
VR_XMLResultSystem.StringThe full recognition result in XML format of the action. All scores and meanings are returned in this XML content. To help parse through the full result data, a number of helper actions exist:
GetNumVoiceRecResults

Returns the number of matching results.

GetVoiceRecResult

Returns the score and meaning of a result at a specified index.

GetVoiceRecResultsByMeaning

Returns any results matching the specified string matching criteria for meaning.

GetVoiceRecResultsByScore

Returns any results matching the specified criteria for scores.

XmlQuery

Allows one to specify user-defined XPath expressions to allow custom parsing of the results.

Each of the VoiceRecResult methods take the XML content as a VoiceRecResultList, so in general one should create a local variable of type VoiceRecResultList initialized with this action parameter. The XmlQuery action takes the XML content as a String, so if you intend to use the XmlQuery action, you should make a String variable that initializes with this action parameter. It is also valid to have two variables of different types that both initialize with the same action parameter.
Termination ConditionSystem.StringDescribes the condition which caused the operation to complete.
ScoreSystem.Int32The confidence score of the Meaning. The value can be between 0 - 1000. With VR_XMLResult, scores can be between 0 - 100.
MeaningSystem.StringThe top-match phrase recognized by Nuance OSR.
ConnectionIdSystem.StringThe same value as the ConnectionId passed in as an action parameter.