k4a_record_t Class Reference

Handle to a k4a recording opened for writing. More...

#include <k4arecord/types.h>

Related Functions
(Note that these are not member functions.)
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. More...
k4a_result_t	k4a_record_add_tag (k4a_record_t recording_handle, const char *name, const char *value)
	Adds a tag to the recording. More...
k4a_result_t	k4a_record_add_imu_track (k4a_record_t recording_handle)
	Adds the track header for recording IMU. More...
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. More...
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. More...
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. More...
k4a_result_t	k4a_record_write_header (k4a_record_t recording_handle)
	Writes the recording header and metadata to file. More...
k4a_result_t	k4a_record_write_capture (k4a_record_t recording_handle, k4a_capture_t capture_handle)
	Writes a camera capture to file. More...
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. More...
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. More...
k4a_result_t	k4a_record_flush (k4a_record_t recording_handle)
	Flushes all pending recording data to disk. More...
void	k4a_record_close (k4a_record_t recording_handle)
	Closes a recording handle. More...

Detailed Description

Handle to a k4a recording opened for writing.

Remarks

Handles are created with k4a_record_create(), and closed with k4a_record_close(). Invalid handles are set to 0.

---

The documentation for this class was generated from the following files:

• types.h
• record.h