KStudioSeekableWritableEventStream.ReadEventAsync Method

Reads and returns the event at the specified index in the event stream.

Syntax

public:
IAsyncOperation<KStudioEvent^ >^ ReadEventAsync(
         uint32 eventIndex,
         uint32 maxTagSize,
         uint32 maxDataSize
)  

Parameters

eventIndex
Type: uint32 

 The index for which to read and return an event.

maxTagSize
Type: uint32 

 The maximum tag size to retrieve.

maxDataSize
Type: uint32 

 The maximum amount of event data to retrieve.

Return value

Type: IAsyncOperation<KStudioEvent^ > 

The event found at the specified index.

Remarks

Reading less than the full event data is useful if the caller only needs some header-type data that is in event especially for events that have very large data.

Requirements

Namespace: Microsoft.Kinect.Tools

Metadata: microsoft.kinect.tools.winmd

See also

Reference

KStudioSeekableWritableEventStream Class

KStudioSeekableWritableEventStream Members

Microsoft.Kinect.Tools Namespace