Skip to content

Commit 3032800

Browse files
authored
add note about MCAP compression (#1588)
Signed-off-by: Adam Aposhian <[email protected]>
1 parent 66af399 commit 3032800

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ Currently, the only `compression-format` available is `zstd`. Both the mode and
9191

9292
It is recommended to use this feature with the splitting options.
9393

94+
**Note**: Some storage plugins may have their own compression methods, which are separate from the rosbag2 compression specified by the CLI options `--compression-mode` and `--compression-format`. Notably, the MCAP file format offered by the `rosbag2_storage_mcap` storage plugin supports compression in a way that produces files that are still indexable (whereas using the rosbag2 compression will not). To utilize storage plugin specific compression or other options, see [Recording with a storage configuration](#Recording-with-a-storage-configuration).
95+
9496
#### Recording with a storage configuration
9597

9698
Storage configuration can be specified in a YAML file passed through the `--storage-config-file` option.

0 commit comments

Comments
 (0)