IBodyIndexFrame Interface

Represents a frame that is computed based on the depth image. This image tells you which depth or infrared pixels belong to tracked people and which belong to the background.

Syntax

interface IBodyIndexFrame : public IUnknown

Members

IBodyIndexFrame has the following members.

Methods

Name Description
AccessUnderlyingBuffer Gets a pointer to the body index frame data.
CopyFrameDataToArray Copies the frame data into the array provided.
get_BodyIndexFrameSource Gets the source of the body index frame.
get_FrameDescription Gets the description of the body index frame.
get_RelativeTime Gets the timestamp of the body index frame.

Remarks

The pixel values in this frame are 8-bit unsigned integers, where 0-5 map directly to the BodyData index in the IBodyFrame. Values greater than the value obtained from get_BodyCount indicate the pixel is part of the background, not associated with a tracked body. This frame is useful for green screening applications, or any scenario where you want to display the silhouette of the user. It also provides a good starting bounds for custom depth algorithms.

Requirements

Header: kinect.h

Library: kinect20.lib