Configuration options for McapWriter. More...
#include <writer.hpp>
Public Member Functions | |
| McapWriterOptions (const std::string_view profile) | |
Public Attributes | |
| uint64_t | chunkSize = DefaultChunkSize |
Target uncompressed Chunk payload size in bytes. Once a Chunk's uncompressed data meets or exceeds this size, the Chunk will be compressed (if compression is enabled) and written to disk. Note that smaller Chunks may be written, such as the last Chunk in the Data section. This option is ignored if noChunking=true. More... | |
| Compression | compression = Compression::Zstd |
Compression algorithm to use when writing Chunks. This option is ignored if noChunking=true. More... | |
| CompressionLevel | compressionLevel = CompressionLevel::Default |
| Compression level to use when writing Chunks. Slower generally produces smaller files, at the expense of more CPU time. These levels map to different internal settings for each compression algorithm. More... | |
| bool | enableDataCRC = false |
| Enable CRC calculations for all records in the data section. More... | |
| bool | forceCompression = false |
By default, Chunks that do not benefit from compression will be written uncompressed. This option can be used to force compression on all Chunks. This option is ignored if noChunking=true. More... | |
| std::string | library = "libmcap " MCAP_LIBRARY_VERSION |
| A freeform string written by recording libraries. For this library, the default is "libmcap {Major}.{Minor}.{Patch}". More... | |
| bool | noAttachmentCRC = false |
| Disable CRC calculations for Attachments. More... | |
| bool | noAttachmentIndex = false |
| bool | noChunkCRC = false |
| Disable CRC calculations for Chunks. More... | |
| bool | noChunkIndex = false |
| bool | noChunking = false |
| Do not write Chunks to the file, instead writing Schema, Channel, and Message records directly into the Data section. More... | |
| bool | noMessageIndex = false |
Do not write Message Index records to the file. If noSummary=true and noChunkIndex=false, Chunk Index records will still be written to the Summary section, providing a coarse message index. More... | |
| bool | noMetadataIndex = false |
| bool | noRepeatedChannels = false |
| bool | noRepeatedSchemas = false |
| bool | noStatistics = false |
| bool | noSummary = false |
| Do not write Summary or Summary Offset sections to the file, placing the Footer record immediately after DataEnd. This can provide some speed boost to file writing and produce smaller files, at the expense of requiring a conversion process later if fast summarization or indexed access is desired. More... | |
| bool | noSummaryCRC = false |
| Disable CRC calculations for the summary section. More... | |
| bool | noSummaryOffsets = false |
| std::string | profile |
| The recording profile. See https://mcap.dev/spec/registry#well-known-profiles for more information on well-known profiles. More... | |
Configuration options for McapWriter.
Definition at line 19 of file writer.hpp.
|
inline |
Definition at line 103 of file writer.hpp.
| uint64_t mcap::McapWriterOptions::chunkSize = DefaultChunkSize |
Target uncompressed Chunk payload size in bytes. Once a Chunk's uncompressed data meets or exceeds this size, the Chunk will be compressed (if compression is enabled) and written to disk. Note that smaller Chunks may be written, such as the last Chunk in the Data section. This option is ignored if noChunking=true.
Definition at line 62 of file writer.hpp.
| Compression mcap::McapWriterOptions::compression = Compression::Zstd |
Compression algorithm to use when writing Chunks. This option is ignored if noChunking=true.
Definition at line 67 of file writer.hpp.
| CompressionLevel mcap::McapWriterOptions::compressionLevel = CompressionLevel::Default |
Compression level to use when writing Chunks. Slower generally produces smaller files, at the expense of more CPU time. These levels map to different internal settings for each compression algorithm.
Definition at line 73 of file writer.hpp.
| bool mcap::McapWriterOptions::enableDataCRC = false |
Enable CRC calculations for all records in the data section.
Definition at line 31 of file writer.hpp.
| bool mcap::McapWriterOptions::forceCompression = false |
By default, Chunks that do not benefit from compression will be written uncompressed. This option can be used to force compression on all Chunks. This option is ignored if noChunking=true.
Definition at line 79 of file writer.hpp.
| std::string mcap::McapWriterOptions::library = "libmcap " MCAP_LIBRARY_VERSION |
A freeform string written by recording libraries. For this library, the default is "libmcap {Major}.{Minor}.{Patch}".
Definition at line 90 of file writer.hpp.
| bool mcap::McapWriterOptions::noAttachmentCRC = false |
Disable CRC calculations for Attachments.
Definition at line 27 of file writer.hpp.
| bool mcap::McapWriterOptions::noAttachmentIndex = false |
Definition at line 97 of file writer.hpp.
| bool mcap::McapWriterOptions::noChunkCRC = false |
Disable CRC calculations for Chunks.
Definition at line 23 of file writer.hpp.
| bool mcap::McapWriterOptions::noChunkIndex = false |
Definition at line 99 of file writer.hpp.
| bool mcap::McapWriterOptions::noChunking = false |
Do not write Chunks to the file, instead writing Schema, Channel, and Message records directly into the Data section.
Definition at line 40 of file writer.hpp.
| bool mcap::McapWriterOptions::noMessageIndex = false |
Do not write Message Index records to the file. If noSummary=true and noChunkIndex=false, Chunk Index records will still be written to the Summary section, providing a coarse message index.
Definition at line 46 of file writer.hpp.
| bool mcap::McapWriterOptions::noMetadataIndex = false |
Definition at line 98 of file writer.hpp.
| bool mcap::McapWriterOptions::noRepeatedChannels = false |
Definition at line 96 of file writer.hpp.
| bool mcap::McapWriterOptions::noRepeatedSchemas = false |
Definition at line 95 of file writer.hpp.
| bool mcap::McapWriterOptions::noStatistics = false |
Definition at line 100 of file writer.hpp.
| bool mcap::McapWriterOptions::noSummary = false |
Do not write Summary or Summary Offset sections to the file, placing the Footer record immediately after DataEnd. This can provide some speed boost to file writing and produce smaller files, at the expense of requiring a conversion process later if fast summarization or indexed access is desired.
Definition at line 54 of file writer.hpp.
| bool mcap::McapWriterOptions::noSummaryCRC = false |
Disable CRC calculations for the summary section.
Definition at line 35 of file writer.hpp.
| bool mcap::McapWriterOptions::noSummaryOffsets = false |
Definition at line 101 of file writer.hpp.
| std::string mcap::McapWriterOptions::profile |
The recording profile. See https://mcap.dev/spec/registry#well-known-profiles for more information on well-known profiles.
Definition at line 85 of file writer.hpp.