From 30328006f872de4e1c82fef4ecca8ca815b2d4dc Mon Sep 17 00:00:00 2001 From: Adam Aposhian Date: Fri, 22 Mar 2024 13:05:40 -0600 Subject: [PATCH] add note about MCAP compression (#1588) Signed-off-by: Adam Aposhian --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c8e1058c74..1edfe12403 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,8 @@ Currently, the only `compression-format` available is `zstd`. Both the mode and It is recommended to use this feature with the splitting options. +**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). + #### Recording with a storage configuration Storage configuration can be specified in a YAML file passed through the `--storage-config-file` option.