VoyantRecorderConfig Struct Reference

Configuration settings for creating a VoyantRecorder instance. More...

#include <voyant_data_recorder.hpp>

Public Member Functions
	VoyantRecorderConfig (const std::string &path)
	Constructs a configuration for the recorder.

Public Attributes
std::string	outputPath
	Base path for output files. This is a required field.
bool	timestampFilename = true
	If true, appends a timestamp to the output filename. Defaults to true.
uint32_t	framesPerFile = 0
	Max frames per file before splitting. Defaults to 0 (no limit).
uint64_t	durationPerFile = 0
	Max duration per file in seconds before splitting. Defaults to 0 (no limit).
uint64_t	sizePerFileMb = 0
	Max size per file in MB before splitting. Defaults to 0 (no limit).
uint32_t	maxTotalFrames = 0
	Max total frames across all files. Defaults to 0 (no limit).
uint64_t	maxTotalDuration = 0
	Max total duration in seconds across all files. Defaults to 0 (no limit).
uint64_t	maxTotalSizeMb = 0
	Max total size in MB across all files. Defaults to 0 (no limit).
uint64_t	bufferSizeMb = 4
	Frame buffer size in MB for writing. Defaults to 4MB. For advanced users.

Detailed Description

Configuration settings for creating a VoyantRecorder instance.

Note

Using 0 for any limit parameter means "no limit" for that constraint.

Constructor & Destructor Documentation

VoyantRecorderConfig()

VoyantRecorderConfig::VoyantRecorderConfig ( const std::string &  path )

inlineexplicit

Constructs a configuration for the recorder.

Parameters

path	The base path for the output recording file(s).

Member Data Documentation

bufferSizeMb

uint64_t VoyantRecorderConfig::bufferSizeMb = 4

Frame buffer size in MB for writing. Defaults to 4MB. For advanced users.

durationPerFile

uint64_t VoyantRecorderConfig::durationPerFile = 0

Max duration per file in seconds before splitting. Defaults to 0 (no limit).

framesPerFile

uint32_t VoyantRecorderConfig::framesPerFile = 0

Max frames per file before splitting. Defaults to 0 (no limit).

maxTotalDuration

uint64_t VoyantRecorderConfig::maxTotalDuration = 0

Max total duration in seconds across all files. Defaults to 0 (no limit).

maxTotalFrames

uint32_t VoyantRecorderConfig::maxTotalFrames = 0

Max total frames across all files. Defaults to 0 (no limit).

maxTotalSizeMb

uint64_t VoyantRecorderConfig::maxTotalSizeMb = 0

Max total size in MB across all files. Defaults to 0 (no limit).

outputPath

std::string VoyantRecorderConfig::outputPath

Base path for output files. This is a required field.

sizePerFileMb

uint64_t VoyantRecorderConfig::sizePerFileMb = 0

Max size per file in MB before splitting. Defaults to 0 (no limit).

timestampFilename

bool VoyantRecorderConfig::timestampFilename = true

If true, appends a timestamp to the output filename. Defaults to true.

---

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

• /usr/include/voyant_api/voyant_data_recorder.hpp