SpeechRecoContext Bookmark Event

Microsoft Speech SDK

Intelligent Interface Technologies Home Page Microsoft Speech SDK

Speech Automation 5.1

Interface: ISpeechRecoContext Events

Bookmark Event


The Bookmark event occurs when the speech recognition (SR) engine encounters a bookmark within the current recognition stream.

See ISpeechRecoContext.Bookmark for further information.


SpeechRecoContext.Bookmark(
     StreamNumber As Long,
     StreamPosition As Variant,
     BookmarkId As Variant,
     Options As SpeechBookmarkOptions
)

Parameters

StreamNumber
Specifies the stream number.
StreamPosition
Specifies the stream position to initiate the Bookmark event. Due to the latency period of the engines, there may be a delay between the cause of the event and the initiation of the event.
BookmarkId
Specifies the BookmarkId. BookmarkId is additional information provided by the application and is unique to the application. As a Variant data type, it may be numeric, String, or any other format and is used to pass information within the method or event. If BookmarkId is a String, the value must be able to convert to a numeric value. This information is returned back using the Bookmark event.
Options
Specifies the options, specifically whether the recognition pauses during the bookmark processing.

Example

See ISpeechRecoContext.Bookmark for further information.