Share via

KinectSensor Members

Kinect for Windows 1.5, 1.6, 1.7, 1.8

The following table(s) list the members exposed by the KinectSensor type.

Public Properties

Name Description
Public Property AudioSource Gets the audio source.
Public Property ColorStream Gets the color stream for the Kinect.
Public Property CoordinateMapper Gets a CoordinateMapper object, which is used to convert points from one coordinate space (color, depth, skeleton) to another.
Public Property DepthFilter Reserved for future use.
Public Property DepthStream Gets the depth stream.
Public Property DeviceConnectionId Gets the USB connector ID.
Public Property ElevationAngle Gets or sets the elevation angle.
Public Property ForceInfraredEmitterOff Gets or sets a Boolean value indicating whether the infrared stream is disabled. The default value is false.
Public Property IsRunning Gets a value indicating whether the sensor is streaming data.
Public Property Static KinectSensors Gets a collection of Kinect sensors.
Public Property MaxElevationAngle Gets the maximum elevation angle (in degrees).
Public Property MinElevationAngle Gets the minimum elevation angle (in degrees).
Public Property SkeletonStream Gets the skeleton stream.
Public Property Status Gets the status of the sensor.
Public Property UniqueKinectId Do not use this property.

Public Methods

Name Description
Public Method AccelerometerGetCurrentReading Gets a four-component vector that points in the direction of gravity.
Public Method Dispose Terminates all active data streams and frees all memory associated with the sensor.
Public Method Static IsKnownPoint Overloaded. Methods for testing a DepthImagePixel object to see if it contains a known value.
Public Method MapDepthFrameToColorFrame Obsolete starting with version 1.6; replaced by the CoordinateMapper.MapDepthFrameToColorFrame method. In versions prior to 1.6, this method maps a depth frame to a color frame.
Public Method MapDepthToColorImagePoint Obsolete starting with version 1.6; replaced by the CoordinateMapper.MapDepthPointToColorPoint method. In versions prior to 1.6, this method maps a depth coordinate with depth value to a color coordinate.
Public Method MapDepthToSkeletonPoint Obsolete starting with version 1.6; replaced by the CoordinateMapper.MapDepthPointToSkeletonPoint method. In versions prior to 1.6, this method maps a coordinate (depthX, depthY) and depth value to a skeleton point.
Public Method MapSkeletonPointToColor Obsolete starting with version 1.6; replaced by the CoordinateMapper.MapSkeletonPointToColorPoint method. In versions prior to 1.6, this method maps a skeleton point to a color point.
Public Method MapSkeletonPointToDepth Obsolete starting with version 1.6; replaced by the CoordinateMapper.MapDepthFrameToColorFrame method. In versions prior to 1.6, this method maps a skeleton point to a depth point.
Public Method Start Starts streaming data out of the sensor.
Public Method Stop Stops streaming data out of the sensor.

Public Events

Name Description
Public Event AllFramesReady Event that fires when new frames are available for each of the sensor's active streams.
Public Event ColorFrameReady Event that fires when a new color frame is available in the ColorStream.
Public Event DepthFrameReady Event that fires when a new depth frame is available in the DepthStream.
Public Event SkeletonFrameReady Event that fires when a new skeleton frame is available in the SkeletonStream.

See Also

Reference

KinectSensor Class
Microsoft.Kinect Namespace