ob2record.h 文件参考

#include "ob2types.h"

浏览源代码.

函数
ob2_record_t	ob2_record_create (const char *file_path, ob2_status_t *status)
	创建录制器 更多...
void	ob2_record_flush (ob2_record_t recording_handle, int32_t timeout_msec, ob2_status_t *status)
	冲洗录制器缓存数据 更多...
void	ob2_record_close (ob2_record_t recording_handle, ob2_status_t *status)
	关闭录制器 更多...
void	ob2_record_write_device_info (ob2_record_t recording_handle, const ob2_device_info_t *device_info, ob2_status_t *status)
	写入设备信息 更多...
void	ob2_record_write_cameras_calibration (ob2_record_t recording_handle, const ob2_cameras_calibration_t *calibration, ob2_status_t *status)
	写入相机标定参数 更多...
void	ob2_record_write_capture (ob2_record_t recording_handle, const ob2_capture_t capture_handle, ob2_status_t *status)
	写入 capture 更多...
void	ob2_record_write_imu_sample (ob2_record_t recording_handle, const ob2_imu_sample_t imu_sample_handle, ob2_status_t *status)
	(未开放接口，请不要使用） 更多...

函数说明

ob2_record_create()

ob2_record_t ob2_record_create	(	const char *	file_path,
		ob2_status_t *	status
	)

创建录制器

录制器创建完后就会开始接收录制数据，录制器关闭后即可完成录制

注意

成功创建录制器后，不再需要录制数据时，需要调用 ob2_record_close 关闭录制器，否则会导致内存泄漏。

录制过程中会一直打开录制文件，此时通过其他程序将无法访问该文件，直到关闭录制器

参数

[in]	file_path	录制输出文件路径
[out]	status	返回函数调用状态

返回

ob2_record_t 录制器句柄

被这些函数引用 ob2::record::record().

ob2_record_flush()

void ob2_record_flush	(	ob2_record_t	recording_handle,
		int32_t	timeout_msec,
		ob2_status_t *	status
	)

冲洗录制器缓存数据

即将当前录制器内部缓存的数据全部写入文件

调用本接口将阻塞，直到录制器内部缓存的数据全部写入文件，或等待时长超过了 @timeout_msec

注意

如果因为缓存数据过多，数据写入文件过慢，导致超过 @timeout_msec 时间还未冲洗完，则会通过 @status 返回 OB2_STATUS_RUNTIME_ERROR

参数

[in]	recording_handle	录制器句柄
[in]	timeout_msec	等待超时时间，可以设置为 OB2_WAIT_INFINITE 表示不限时等待。
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::flush().

ob2_record_close()

void ob2_record_close	(	ob2_record_t	recording_handle,
		ob2_status_t *	status
	)

关闭录制器

注意

关闭录制器会立即清空内部缓存的数据，所以为了确保录制数据不丢失，关闭前需要调用 ob2_record_flush 接口冲洗数据

参数

[in]	recording_handle	录制器句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::~record().

ob2_record_write_device_info()

void ob2_record_write_device_info	(	ob2_record_t	recording_handle,
		const ob2_device_info_t *	device_info,
		ob2_status_t *	status
	)

写入设备信息

参数

[in]	recording_handle	录制器句柄
[in]	device_info	设备信息
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::write_device_info().

ob2_record_write_cameras_calibration()

void ob2_record_write_cameras_calibration	(	ob2_record_t	recording_handle,
		const ob2_cameras_calibration_t *	calibration,
		ob2_status_t *	status
	)

写入相机标定参数

参数

[in]	recording_handle	录制器句柄
[in]	calibration	相机标定参数
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::write_cameras_calibration().

ob2_record_write_capture()

void ob2_record_write_capture	(	ob2_record_t	recording_handle,
		const ob2_capture_t	capture_handle,
		ob2_status_t *	status
	)

写入 capture

注意

写入 capture 的时间间隔会直接决定回放时输出 capture 的时间间隔

参数

[in]	recording_handle	录制器句柄
[in]	capture_handle	capture 句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::write_capture().

ob2_record_write_imu_sample()

void ob2_record_write_imu_sample	(	ob2_record_t	recording_handle,
		const ob2_imu_sample_t	imu_sample_handle,
		ob2_status_t *	status
	)

(未开放接口，请不要使用）

参数

[in]	recording_handle	录制器句柄
[in]	imu_sample_handle	IMU 采样数据
[out]	status	返回函数调用状态

被这些函数引用 ob2::record::write_imu_sample().