update app_recorder README

PR2 · Aug 24, 2021 · 2ac2365 · 2ac2365
1 parent 1e9af30
commit 2ac2365
Showing 1 changed file with 21 additions and 17 deletions.
diff --git a/app_recorder/README.md b/app_recorder/README.md
@@ -2,22 +2,25 @@
 
 Recorder plugin for `app_manager`
 
-## `app_recorder/video_recorder_plugin`: Video recorder plugin
+## `app_manager` plugins
+
+### `app_recorder/video_recorder_plugin`: Video recorder plugin
 
 This plugin records video data during when an app is running.
 
-### `plugin_args`: Plugin arguments
+#### `plugin_args`: Plugin arguments
 
 `None`
 
-### `launch_args`: Plugin launch arguments
+#### `launch_args`: Plugin launch arguments
 
 - `video_path`: video file directory path
 - `video_title`: video file name
 - `video_topic_name`: image topic name for video
 - `video_fps`: video fps
+- `video_codec` (default: `XVID`): video codec
 
-### Sample plugin description
+#### Sample plugin description
 
 ```yaml
 plugins:
@@ -30,22 +33,22 @@ plugins:
       video_fps: 30
 ```
 
-## `app_recorder/audio_recorder_plugin`: Audio recorder plugin
+### `app_recorder/audio_recorder_plugin`: Audio recorder plugin
 
 This plugin records audio data during when an app is running.
 
-### `plugin_args`: Plugin arguments
+#### `plugin_args`: Plugin arguments
 
 `None`
 
-### `launch_args`: Plugin launch arguments
+#### `launch_args`: Plugin launch arguments
 
 - `audio_path`: audio file directory path
 - `audio_title`: audio file name
 - `audio_topic_name`: image topic name for audio
-- `audio_format`: audio format
+- `audio_format`(default: `wave`): audio format
 
-### Sample plugin description
+#### Sample plugin description
 
 ```yaml
 plugins:
@@ -58,21 +61,22 @@ plugins:
       audio_format: mp3
 ```
 
-## `app_recorder/rosbag_recorder_plugin`: Rosbag recorder plugin
+### `app_recorder/rosbag_recorder_plugin`: Rosbag recorder plugin
 
 This plugin records rosbag data during when an app is running.
 
-### `plugin_args`: Plugin arguments
+#### `plugin_args`: Plugin arguments
 
 `None`
 
-### `launch_args`: Plugin launch arguments
+#### `launch_args`: Plugin launch arguments
 
 - `rosbag_path`: rosbag file directory path
 - `rosbag_title`: rosbag file name
 - `rosbag_topic_names`: topic names for rosbag
+- `compress` (default: `False`): compress rosbag or not
 
-### Sample plugin description
+#### Sample plugin description
 
 ```yaml
 plugins:
@@ -84,20 +88,20 @@ plugins:
       rosbag_topic_names: /tf /joint_states
 ```
 
-## `app_recorder/result_recorder_plugin`: Result recorder plugin
+### `app_recorder/result_recorder_plugin`: Result recorder plugin
 
 This plugin records app result in yaml when app finishs.
 
-### `plugin_args`: Plugin arguments
+#### `plugin_args`: Plugin arguments
 
 - `result_path`: result file directory path
 - `result_title`: result file name
 
-### `launch_args`: Plugin launch arguments
+#### `launch_args`: Plugin launch arguments
 
 `None`
 
-### Sample plugin description
+#### Sample plugin description
 
 ```yaml
 plugins: