KStudioClient.CreateEventReaderFromFileObjectAsync Method

Creates an enumerator for iterating over events in selected event streams in a file in order of timestamp.

Syntax

public:
IAsyncOperation<KStudioEventReader^ >^ CreateEventReaderFromFileObjectAsync(
         KStudioEventFile^ file,
         KStudioEventStreamSelectorCollection^ streamSelectorCollection,
         KStudioEventReaderFlags flags
)  

Parameters

file
Type: KStudioEventFile 

The file containing the events to enumerate.

streamSelectorCollection
Type: KStudioEventStreamSelectorCollection 

The set of event streams over which to enumerate.

flags
Type: KStudioEventReaderFlags 

Flags to control the event reader.

Return value

Type: IAsyncOperation<KStudioEventReader^ > 

An event reader to enumerate the events in the file in order.

Remarks

order to read the events on a remote file, the client needs to be connected to the service.

After creating an Event Reader from a file, it is the caller’s responsibilty to dispose the File object when the caller and the Event Reader are done with it.

Requirements

Namespace: Microsoft.Kinect.Tools

Metadata: microsoft.kinect.tools.winmd

See also

Reference

KStudioClient Class

KStudioClient Members

Microsoft.Kinect.Tools Namespace