KinectRecorder Class (KinectEx.DVR)

This class is one of two primary programmatic interfaces into the KinectEx.DVR subsystem. Created to enable recording of frames to a Stream.
Inheritance Hierarchy
System.Object
   KinectEx.DVR.KinectRecorder

Namespace: KinectEx.DVR
Assembly: KinectEx (KinectEx.dll 0.4.0.0)
Syntax
  • C#
  • VB
  • C++
  • F#
public class KinectRecorder : IDisposable

Syntax for VB is not yet implemented.

Syntax for C++ is not yet implemented

type public KinectRecorder =
	class
		interface IDisposable
	end

The KinectRecorder type exposes the following members.

Constructors
  Platforms Name Description
KinectRecorder(Stream, KinectSensor) Creates a new instance of a KinectRecorder which can save frames to the referenced stream. The KinectRecorder can operate in two distinct modes. The "Automatic" mode requires only that you pass a valid KinectSensor object to this constructor. Recording of frames for each enabled frame type happens automatically between the time Start() and StopAsync() are called. In certain situations, the developer may wish to have more precise control over when and how frames are recorded. If no KinectSensor is passed in to this constructor, Start() and StopAsync() must still be called to begin and end the recording session. However, the KinectRecorder will be in "Manual" mode, and frames are recorded only when passed in to the RecordFrame() method.  
KinectRecorder(Stream, KinectSensor) Creates a new instance of a KinectRecorder which can save frames to the referenced stream. The KinectRecorder can operate in two distinct modes. The "Automatic" mode requires only that you pass a valid KinectSensor object to this constructor. Recording of frames for each enabled frame type happens automatically between the time Start() and StopAsync() are called. In certain situations, the developer may wish to have more precise control over when and how frames are recorded. If no KinectSensor is passed in to this constructor, Start() and StopAsync() must still be called to begin and end the recording session. However, the KinectRecorder will be in "Manual" mode, and frames are recorded only when passed in to the RecordFrame() method.  
Top
Properties
  Platforms Name Description
ColorRecorderCodec The codec used to encode Color frame images. By default, this is a RawColorCodec that records at full resolution (i.e., 1920 x 1080 x 4 bits/pixel). Cannot be changed after recording has started. 
EnableBodyRecorder Determines whether the KinectRecorder will record Body frames. Applies only when the KinectRecorder is in "Automatic" mode. Cannot be changed after recording has started. 
EnableColorRecorder Determines whether the KinectRecorder will record Color frames. Applies only when the KinectRecorder is in "Automatic" mode. Cannot be changed after recording has started. 
EnableDepthRecorder Determines whether the KinectRecorder will record Depth frames. Applies only when the KinectRecorder is in "Automatic" mode. Cannot be changed after recording has started. 
EnableInfraredRecorder Determines whether the KinectRecorder will record Infrared frames. Applies only when the KinectRecorder is in "Automatic" mode. Cannot be changed after recording has started. 
IsStarted Indicates whether the recorder is currently started. Will be true any time between the calls to Start() and StopAsync(). 
MapColorPositions Determines whether the KinectRecorder will map and store the 2D color space position for joint locations. Applies only when the body recording is enabled. Cannot be changed after recording has started. 
MapDepthPositions Determines whether the KinectRecorder will map and store the 2D depth space position for joint locations. Applies only when the body recording is enabled. Cannot be changed after recording has started. 
Top
Methods
  Platforms Name Description
CancelAsync Stops the KinectRecorder, discards all remaining frames in the record queue, and closes the associated stream. 
Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Implements IDisposable.Dispose().)
Dispose(bool) Releases unmanaged and - optionally - managed resources. 
Finalize Finalizes an instance of the KinectRecorder class. (Overrides object.Finalize().)
RecordFrame(DepthFrame, UInt16[]) Used in "Manual" mode to record a single DepthFrame if the depth frame data has already been retrieved from the frame. 
RecordFrame(DepthFrame) Used in "Manual" mode to record a single DepthFrame. 
RecordFrame(ColorFrame, Byte[]) Used in "Manual" mode to record a single ColorFrame if the color frame data has already been retrieved from the frame. Note that the frame data must have been converted to BGRA format. 
RecordFrame(ColorFrame) Used in "Manual" mode to record a single ColorFrame. 
RecordFrame(BodyFrame, Body[]) Used in "Manual" mode to record a single BodyFrame if the body frame data has already been retrieved from the frame. 
RecordFrame(BodyFrame, List<CustomBody>) Used in "Manual" mode to record a single BodyFrame if the body frame data has already been retrieved from the frame. 
RecordFrame(BodyFrame) Used in "Manual" mode to record a single BodyFrame. 
RecordFrame(ColorFrame, Byte[]) Used in "Manual" mode to record a single ColorFrame if the color frame data has already been retrieved from the frame. Note that the frame data must have been converted to BGRA format. 
RecordFrame(DepthFrame) Used in "Manual" mode to record a single DepthFrame. 
RecordFrame(BodyFrame, List<CustomBody>) Used in "Manual" mode to record a single BodyFrame if the body frame data has already been retrieved from the frame. 
RecordFrame(BodyFrame, Body[]) Used in "Manual" mode to record a single BodyFrame if the body frame data has already been retrieved from the frame. 
RecordFrame(ColorFrame) Used in "Manual" mode to record a single ColorFrame. 
RecordFrame(InfraredFrame) Used in "Manual" mode to record a single InfraredFrame. 
RecordFrame(InfraredFrame, UInt16[]) Used in "Manual" mode to record a single InfraredFrame if the infrared frame data has already been retrieved from the frame. 
RecordFrame(InfraredFrame) Used in "Manual" mode to record a single InfraredFrame. 
RecordFrame(DepthFrame, UInt16[]) Used in "Manual" mode to record a single DepthFrame if the depth frame data has already been retrieved from the frame. 
RecordFrame(BodyFrame) Used in "Manual" mode to record a single BodyFrame. 
RecordFrame(InfraredFrame, UInt16[]) Used in "Manual" mode to record a single InfraredFrame if the infrared frame data has already been retrieved from the frame. 
Start Start the KinectRecorder session. This will write the file header and enable the recorder to begin processing frames. 
StopAsync Stops the KinectRecorder, writes all frames remaining in the record queue, and closes the associated stream. 
Top
Version and Platform Information
Supported in:

    
 Windows Desktop - .NET 4.5
    
 Windows 8.1 Store - WinRT