Share via


BodyIndexFrame Class

Represents a frame that indicates which depth or infrared pixels belong to tracked people and which do not.

Syntax

public ref class BodyIndexFrame sealed : IClosable
public sealed class BodyIndexFrame : IDisposable
var bodyIndexFrame = WindowsPreview.Kinect.BodyIndexFrame;

Members

BodyIndexFrame has the following members.

Properties

Name Description
BodyIndexFrameSource Gets the source of the body index frame.
FrameDescription Gets the description of the body index frame.
RelativeTime Gets the timestamp of the body index frame.

Methods

Name Description
Close Releases system resources associated with the body index frame.
CopyFrameDataToArray Copies the body index frame data into the array provided.
CopyFrameDataToBuffer Copies the body index frame data into the memory location provided.
LockImageBuffer Gives an app access to the underlying buffer used by the system to store this frame's data.

Remarks

The pixel values in this frame are 8-bit unsigned integers, where 0-5 map directly to the BodyData index in the BodyFrame. Values greater than the value obtained from 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

Namespace: WindowsPreview.Kinect

Metadata: windowspreview.kinect.winmd

See also

Reference

WindowsPreview.Kinect Namespace