Azure Kinect Sensor SDK  refs/heads/master
Documentation for https://github.com/Microsoft/Azure-Kinect-Sensor-SDK
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 
66 K4ARECORD_EXPORT k4a_result_t k4a_record_create(const char *path,
67  k4a_device_t device,
68  const k4a_device_configuration_t device_config,
69  k4a_record_t *recording_handle);
70 
106 K4ARECORD_EXPORT k4a_result_t k4a_record_add_tag(k4a_record_t recording_handle, const char *name, const char *value);
107 
130 K4ARECORD_EXPORT k4a_result_t k4a_record_add_imu_track(k4a_record_t recording_handle);
131 
164 K4ARECORD_EXPORT k4a_result_t k4a_record_add_attachment(const k4a_record_t recording_handle,
165  const char *attachment_name,
166  const uint8_t *buffer,
167  size_t buffer_size);
168 
219 K4ARECORD_EXPORT k4a_result_t k4a_record_add_custom_video_track(const k4a_record_t recording_handle,
220  const char *track_name,
221  const char *codec_id,
222  const uint8_t *codec_context,
223  size_t codec_context_size,
224  const k4a_record_video_settings_t *track_settings);
225 
276 K4ARECORD_EXPORT k4a_result_t
278  const char *track_name,
279  const char *codec_id,
280  const uint8_t *codec_context,
281  size_t codec_context_size,
282  const k4a_record_subtitle_settings_t *track_settings);
283 
306 K4ARECORD_EXPORT k4a_result_t k4a_record_write_header(k4a_record_t recording_handle);
307 
337 K4ARECORD_EXPORT k4a_result_t k4a_record_write_capture(k4a_record_t recording_handle, k4a_capture_t capture_handle);
338 
368 K4ARECORD_EXPORT k4a_result_t k4a_record_write_imu_sample(k4a_record_t recording_handle, k4a_imu_sample_t imu_sample);
369 
407 K4ARECORD_EXPORT k4a_result_t k4a_record_write_custom_track_data(const k4a_record_t recording_handle,
408  const char *track_name,
409  uint64_t device_timestamp_usec,
410  uint8_t *custom_data,
411  size_t custom_data_size);
412 
441 K4ARECORD_EXPORT k4a_result_t k4a_record_flush(k4a_record_t recording_handle);
442 
463 K4ARECORD_EXPORT void k4a_record_close(k4a_record_t recording_handle);
464 
469 #ifdef __cplusplus
470 } // extern "C"
471 #endif
472 
473 #endif /* K4A_RECORD_H */
k4a_result_t k4a_record_add_attachment(const k4a_record_t recording_handle, const char *attachment_name, const uint8_t *buffer, size_t buffer_size)
Adds an attachment to the recording.
Structure containing additional metadata specific to custom subtitle tracks.
Definition: types.h:239
k4a_result_t
Result code returned by Azure Kinect APIs.
Definition: k4atypes.h:217
k4a_result_t k4a_record_write_custom_track_data(const k4a_record_t recording_handle, const char *track_name, uint64_t device_timestamp_usec, uint8_t *custom_data, size_t custom_data_size)
Writes data for a custom track to file.
Handle to an Azure Kinect capture.
Definition: k4atypes.h:122
k4a_result_t k4a_record_add_custom_video_track(const k4a_record_t recording_handle, const char *track_name, const char *codec_id, const uint8_t *codec_context, size_t codec_context_size, const k4a_record_video_settings_t *track_settings)
Adds custom video tracks to the recording.
IMU sample.
Definition: k4atypes.h:1199
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.
Structure containing additional metadata specific to custom video tracks.
Definition: types.h:224
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:917
k4a_result_t k4a_record_add_custom_subtitle_track(const k4a_record_t recording_handle, const char *track_name, const char *codec_id, const uint8_t *codec_context, size_t codec_context_size, const k4a_record_subtitle_settings_t *track_settings)
Adds custom subtitle tracks to the recording.
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.