#include <OpenNI.h>
Public Member Functions | |
| Status | attach (VideoStream &stream, bool allowLossyCompression=false) |
| Status | create (const char *fileName) |
| void | destroy () |
| bool | isValid () const |
| Recorder () | |
| Status | start () |
| void | stop () |
| ~Recorder () | |
Private Member Functions | |
| OniRecorderHandle | getHandle () const |
| Recorder & | operator= (const Recorder &) |
| Recorder (const Recorder &) | |
Private Attributes | |
| OniRecorderHandle | m_recorder |
The Recorder class is used to record streams to an ONI file.
After a recorder is instantiated, it must be initialized with a specific filename where the recording will be stored. The recorder is then attached to one or more streams. Once this is complete, the recorder can be told to start recording. The recorder will store every frame from every stream to the specified file. Later, this file can be used to initialize a file Device, and used to play back the same data that was recorded.
Opening a file device is done by passing its path as the uri to the Device::open() method.
| openni::Recorder::Recorder | ( | ) | [inline] |
| openni::Recorder::~Recorder | ( | ) | [inline] |
| openni::Recorder::Recorder | ( | const Recorder & | ) | [private] |
| Status openni::Recorder::attach | ( | VideoStream & | stream, |
| bool | allowLossyCompression = false |
||
| ) | [inline] |
Attaches a stream to the recorder. Note, this won't start recording, you should explicitly start it using start() method. As soon as the recording process has been started, no more streams can be attached to the recorder.
| [in] | stream | The stream to be recorded. |
| [in] | allowLossyCompression | [Optional] If this value is true, the recorder might use a lossy compression, which means that when the recording will be played-back, there might be small differences from the original frame. Default value is false. |
| Status openni::Recorder::create | ( | const char * | fileName | ) | [inline] |
Initializes a recorder. You can initialize the recorder only once. Attempts to intialize more than once will result in an error code being returned.
Initialization assigns the recorder to an output file that will be used for recording. Before use, the attach() function must also be used to assign input data to the Recorder.
| [in] | fileName | The name of a file which will contain the recording. |
| void openni::Recorder::destroy | ( | ) | [inline] |
| OniRecorderHandle openni::Recorder::getHandle | ( | ) | const [inline, private] |
| bool openni::Recorder::isValid | ( | ) | const [inline] |
| Status openni::Recorder::start | ( | ) | [inline] |
| void openni::Recorder::stop | ( | ) | [inline] |