Microsoft.Xbox.Tools.XStudio Namespace

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Contains the reference APIs for the Microsoft.Xbox.Tools.Studio namespace.

To use the Xbox Studio API, titles that run on the console must link with xstudioclient.lib, and applications that run on the development computer must link with xstudioservice.lib.

This set of APIs is planned for deprecation in November 2014.

See also APIs for Recording and Playing Back Sensor Data.

Interfaces

Name	Description
IXStudioAsyncResult	Xbox Studio interface for retrieving asynchronous results.
IXStudioEvent	Xbox Studio interface for retrieving information about the events in an Xbox Event File (XEF).
IXStudioFileIterator	Xbox Studio interface for iterating over events recorded in an Xbox Event File (XEF).
IXStudioPlayback	Xbox Studio interface for playing a previously recorded Xbox Event File (XEF).
IXStudioRecording	Xbox Studio interface for recording sensor data to an Xbox Event File (XEF).
IXStudioSession	Xbox Studio interface for an Xbox Studio session.
IXStudioTitleClient	Represents an IXStudioTitleClient.

Functions

Name	Description
XStudioCreateSession	On Xbox, this method creates an out-of-process connection to the service; on PC, this method creates the PC service.
XStudioGetCurrentTick	Gets the current real-time XStudio Tick. The tick frequency is fixed at XSTUDIO_TICKS_PER_SECOND.
XStudioTicksToSeconds	Converts XStudio Ticks to seconds as a double. Makes formatting ticks easy.

Structures

Name	Description
XStudioBufferAndSizeConst	Specifies the size and address of an Xbox Studio data buffer.

Enumerations

Name	Description
XSTUDIO_CONTROL_STATE	Specifies the recorder/player state.
XSTUDIO_LOCATION	Specifies the location of an XStudio object.

Constants

Name	Description
E_XSTUDIO_ALREADY_EXISTS	File or item already exists.
E_XSTUDIO_BUSY	File or item is already in use (indicates that the stream is already mapped).
E_XSTUDIO_CONNECTION_ACTIVE	Xbox Studio is already connected.
E_XSTUDIO_CONNECTION_REFUSED	Connection is refused. Xbox Studio may already be connected to the Xbox Studio Service.
E_XSTUDIO_INVALID_DATA	Data, event, or file is invalid or corrupt.
E_XSTUDIO_INVALID_FUNCTION	Function handler not found.
E_XSTUDIO_INVALID_OPERATION	Invalid operation was attempted.
E_XSTUDIO_MORE_DATA	More data is available (indicates that the receiving buffer was too small).
E_XSTUDIO_NO_MORE_ITEMS	No more data is available (indicates an attempt to read past the end of a stream).
E_XSTUDIO_NOT_CONNECTED	Xbox Studio is not connected.
E_XSTUDIO_NOT_FOUND	File or item not found.
XSTUDIO_DEFAULT_NUI_PLAYBACK_STREAMS	A list of the default Stream Type values for playback.
XSTUDIO_DEFAULT_NUI_RECORDING_STREAMS	A list of the default Stream Type values for recording.
XSTUDIO_FILE_FLAG_SEQUENTIAL	Number subsequent files sequentially.
XSTUDIO_MAX_CLIENT_NAME	The maximum number of characters in a client name is 64.
XSTUDIO_MAX_CLIENT_STREAMS	The maximum number of client streams is 64.
XSTUDIO_MAX_CLIENTS	The maximum number of clients is 64.
XSTUDIO_MAX_METADATA_KEY_LENGTH	Maximum number of characters in a metadata ‘key’ string, including the terminating null character.
XSTUDIO_MAX_METADATA_KEY_SIZE	Maximum size, in bytes, of a metadata ‘key’ string, including the terminating null character.
XSTUDIO_MAX_STREAM_TYPE_NAME	The maximum number of stream type names is 64.
XSTUDIO_METADATA_FLAG_PII	A flag that marks metadata that might be Personally-Identifiable Information (PII).
XSTUDIO_NULL_GUID	An identifer used to indicate an unspecified Stream Type value.
XSTUDIO_STREAM_FLAG_CAN_CONSUME	The stream can be mapped as a sink.
XSTUDIO_STREAM_FLAG_CAN_PRODUCE	The stream can be mapped as a source.
XSTUDIO_STREAM_TYPE_NUI_AUDIO_SYSTEM_SHARED	Stream type representing a system shared audio stream.
XSTUDIO_STREAM_TYPE_NUI_BODY_FRAME	Stream Type representing the Body stream (NUI_STREAM_TYPE_BODY).
XSTUDIO_STREAM_TYPE_NUI_COMPRESSED_COLOR	The stream type is a compressed color stream.
XSTUDIO_STREAM_TYPE_NUI_DEPTH	Stream Type representing the Depth stream (NUI_STREAM_TYPE_DEPTH).
XSTUDIO_STREAM_TYPE_NUI_IR	Stream Type representing the Active IR stream (NUI_STREAM_TYPE_IR).
XSTUDIO_STREAM_TYPE_NUI_RAW_IR	Stream type representing a raw infrared stream.
XSTUDIO_TICK_INVALID	An invalid or undefined tick.
XSTUDIO_TICKS_PER_SECOND	Ticks per second.