IXStudioEvent::GetIndexBlob Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Gets the index blob associated with the event.

Syntax

public:
XStudioBufferAndSizeConst& GetIndexBlob()  

Return value

Type: XStudioBufferAndSizeConst 

Reference to an XStudioBufferAndSizeConst structure that contains a pointer to the index blob.

Remarks

The returned XStudioBufferAndSizeConst structure contains a pointer to the index blob buffer and specifies the size of the index blob data.

The index blob is a small piece of data that is stored in the file’s index, and is separate from the normal data buffers that are associated with the event.

For depth, ir, and body frame streams, the index blob is the frame number for the event. For other, future streams, the content of the index blob may vary.

Requirements

Header: Declared in xstudio.h.

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

See also

IXStudioEvent Interface