IXStudioPlayback 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 playing a previously recorded Xbox Event File (XEF).

Syntax

interface IXStudioPlayback : public IUnknown  

IXStudioPlayback has the following members.

Public Methods

	Name	Description
	GetBinaryMetaData	Gets a file-level binary metadata tag for the specified key.
	GetBinaryMetaDataKeys	Gets file-level binary metadata tags for all metadata keys.
	GetCurrentLoopCount	Gets the current iteration of the active loop count, starting from 0.
	GetCurrentTick	Gets the current position of the playback, as a tick count.
	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 a file-level string metadata tag (key:value pair).
	GetMetaData	Gets a file-level string metadata tag (key:value pair).
	GetMetaDataKeys	Gets the file-level string keys for all the metadata tags.
	GetPausePoint	Gets the current pause point for the playback.
	GetState	Gets the current state of the playback (started, stopped, paused, or invalid).
	GetStreamBinaryMetaData	Gets a file-level binary metadata tag for the specified key.
	GetStreamBinaryMetaDataKeys	Gets stream-level binary keys for all metadata tags.
	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 playback.
	GetTimingEnabled	Indicates whether events are played back timed, or as quickly as possible.
	Pause	Pauses playback at the current position.
	Resume	Resumes playback.
	Seek	Seeks to a new position in the playback.
	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.
	SetPausePoint	Sets the playback pause point.
	SetTimingEnabled	Enables or disables timed event playback.
	SingleStep	Plays back a single event.
	Start	Starts playback.
	Stop	Stops playback.

Remarks

To obtain an IXStudioPlayback interface, call CreatePlayback.

To start and stop the playback, call Start and Stop.

When done using the interface, call Release.

Requirements

Header: Declared in xstudio.h.

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