k4a::record Class Reference

Wrapper for k4a_record_t. More...

#include <record.hpp>

Public Member Functions
	record (k4a_record_t handle=nullptr) noexcept
	Creates a k4a::record from a k4a_record_t Takes ownership of the handle, i.e. More...
	record (record &&other) noexcept
	Moves another k4a::record into a new k4a::record.
	record (const record &)=delete
record &	operator= (const record &)=delete
record &	operator= (record &&other) noexcept
	Moves another k4a::record into this k4a::record; other is set to invalid.
	operator bool () const noexcept
	Returns true if the k4a::record is valid, false otherwise.
bool	is_valid () const noexcept
	Returns true if the k4a::record is valid, false otherwise.
void	close () noexcept
	Closes a K4A recording. More...
void	flush ()
	Flushes all pending recording data to disk. More...
void	add_tag (const char *name, const char *value)
	Adds a tag to the recording Throws error on failure. More...
void	add_imu_track ()
	Adds the track header for recording IMU Throws error on failure. More...
void	add_attachment (const char *attachment_name, const uint8_t *buffer, size_t buffer_size)
	Adds an attachment to the recording Throws error on failure. More...
void	add_custom_video_track (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 Throws error on failure. More...
void	add_custom_subtitle_track (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 Throws error on failure. More...
void	write_header ()
	Writes the recording header and metadata to file Throws error on failure. More...
void	write_capture (const capture &capture)
	Writes a camera capture to file Throws error on failure. More...
void	write_imu_sample (const k4a_imu_sample_t &imu_sample)
	Writes an imu sample to file Throws error on failure. More...
void	write_custom_track_data (const char *track_name, const std::chrono::microseconds device_timestamp_usec, uint8_t *custom_data, size_t custom_data_size)
	Writes data for a custom track to file Throws error on failure. More...

Static Public Member Functions
static record	create (const char *path, const device &device, const k4a_device_configuration_t &device_configuration)
	Opens a new recording file for writing Throws error on failure. More...

Detailed Description

Wrapper for k4a_record_t.

Wraps a handle for a record object

See also

k4a_record_t

---

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

• record.hpp