IXStudioFileIterator Interface

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Xbox Studio interface for iterating over events recorded in an Xbox Event File (XEF).

Syntax

interface IXStudioFileIterator : public IUnknown  

IXStudioFileIterator has the following members.

Public Methods

	Name	Description
	GetBinaryMetaData	Gets binary metadata using a key:value pair.
	GetBinaryMetaDataKeys	Gets the binary metadata keys.
	GetCurrentLoopCount	Gets the current iteration of the active loop count, starting from 0.
	GetInOutPoints	Gets the ticks for the in and out points, which allow you to define a subrange of the file to iterate/playback.
	GetLoopCount	Gets the loop count, which indicates how many times the file is played back.
	GetMetaData	Gets metadata using a key:value pair.
	GetMetaData	Gets metadata using a key:value pair.
	GetMetaDataKeys	Gets the metadata keys.
	GetNextEvent	Gets the next event from the file.
	GetStreamBinaryMetaData	Gets a file-level binary metadata tag for the specified key.
	GetStreamBinaryMetaDataKeys	Gets streamed binary metadata keys.
	GetStreamMetaData	Gets a stream-level string metadata tag for the specified key.
	GetStreamMetaDataKeys	Gets stream-level binary keys for all metadata tags.
	GetTickRange	Gets the start and end tick counts of the events in the file.
	Seek	Seeks to a new position in the file.
	SetInOutPoints	Sets the ticks for the in and out points, which allow you to define a subrange of the file to iterate/playback.
	SetLoopCount	Sets the loop count, which indicates how many times the file is played back.

Remarks

IXStudioFileIterator is the interface used to iterate sensor data previously recorded in an Xbox Event File (XEF).

To obtain an IXStudioFileIterator interface, call CreateFileIterator.

To iterate over events in the file, repeatedly call GetNextEvent until it returns E_XSTUDIO_NO_MORE_ITEMS.

When done using the interface, call Release.

Requirements

Header: Declared in xstudio.h.

Library: Use xstudioclient.lib (console) or xstudioservice.lib (desktop).