RequestRecognizerUpdate Method (Object, TimeSpan)

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Requests that the recognizer pauses to update its state and provides an offset and a user token for the associated event.

Namespace:  Microsoft.Speech.Recognition
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

Visual Basic (Declaration)
Public Sub RequestRecognizerUpdate ( _
	userToken As Object, _
	audioPositionAheadToRaiseUpdate As TimeSpan _
)
Visual Basic (Usage)
Dim instance As SpeechRecognitionEngine
Dim userToken As Object
Dim audioPositionAheadToRaiseUpdate As TimeSpan

instance.RequestRecognizerUpdate(userToken, _
	audioPositionAheadToRaiseUpdate)
C#
public void RequestRecognizerUpdate(
	Object userToken,
	TimeSpan audioPositionAheadToRaiseUpdate
)

Parameters

userToken
Type: System..::..Object

User-defined information that contains information for the operation.

audioPositionAheadToRaiseUpdate
Type: System..::..TimeSpan

The offset from the current AudioPosition to delay the request.

Remarks

The recognizer does not initiate the recognizer update request until the recognizer's RecognizerAudioPosition equals the current AudioPosition plus audioPositionAheadToRaiseUpdate.

When the recognizer generates the RecognizerUpdateReached event, the UserToken property of the RecognizerUpdateReachedEventArgs contains the value of the userToken parameter.

See Also