Azure Kinect Sensor SDK  refs/pull/469/merge
Documentation for https://github.com/Microsoft/Azure-Kinect-Sensor-SDK
All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
record.h
1 
7 #ifndef K4A_RECORD_H
8 #define K4A_RECORD_H
9 
10 #include <k4arecord/types.h>
11 #include <k4arecord/k4arecord_export.h>
12 
13 #ifdef __cplusplus
14 
15 extern "C" {
16 #endif
17 
65 K4ARECORD_EXPORT k4a_result_t k4a_record_create(const char *path,
66  k4a_device_t device,
67  const k4a_device_configuration_t device_config,
68  k4a_record_t *recording_handle);
69 
99 K4ARECORD_EXPORT k4a_result_t k4a_record_add_tag(k4a_record_t recording_handle, const char *name, const char *value);
100 
122 K4ARECORD_EXPORT k4a_result_t k4a_record_add_imu_track(k4a_record_t recording_handle);
123 
145 K4ARECORD_EXPORT k4a_result_t k4a_record_write_header(k4a_record_t recording_handle);
146 
175 K4ARECORD_EXPORT k4a_result_t k4a_record_write_capture(k4a_record_t recording_handle, k4a_capture_t capture_handle);
176 
203 K4ARECORD_EXPORT k4a_result_t k4a_record_write_imu_sample(k4a_record_t recording_handle, k4a_imu_sample_t imu_sample);
204 
233 K4ARECORD_EXPORT k4a_result_t k4a_record_flush(k4a_record_t recording_handle);
234 
255 K4ARECORD_EXPORT void k4a_record_close(k4a_record_t recording_handle);
256 
261 #ifdef __cplusplus
262 } // extern "C"
263 #endif
264 
265 #endif /* K4A_RECORD_H */
k4a_result_t
Result code returned by Azure Kinect APIs.
Definition: k4atypes.h:217
Handle to an Azure Kinect capture.
Definition: k4atypes.h:122
IMU sample.
Definition: k4atypes.h:1122
k4a_result_t k4a_record_create(const char *path, k4a_device_t device, const k4a_device_configuration_t device_config, k4a_record_t *recording_handle)
Opens a new recording file for writing.
k4a_result_t k4a_record_write_header(k4a_record_t recording_handle)
Writes the recording header and metadata to file.
k4a_result_t k4a_record_write_imu_sample(k4a_record_t recording_handle, k4a_imu_sample_t imu_sample)
Writes an imu sample to file.
void k4a_record_close(k4a_record_t recording_handle)
Closes a recording handle.
k4a_result_t k4a_record_add_tag(k4a_record_t recording_handle, const char *name, const char *value)
Adds a tag to the recording.
k4a_result_t k4a_record_write_capture(k4a_record_t recording_handle, k4a_capture_t capture_handle)
Writes a camera capture to file.
Handle to an Azure Kinect device.
Definition: k4atypes.h:66
Configuration parameters for an Azure Kinect device.
Definition: k4atypes.h:840
k4a_result_t k4a_record_add_imu_track(k4a_record_t recording_handle)
Adds the track header for recording IMU.
Handle to a k4a recording opened for writing.
Definition: types.h:34
k4a_result_t k4a_record_flush(k4a_record_t recording_handle)
Flushes all pending recording data to disk.