From 13225b3d4872ad884b5a53ac8de2db6226848490 Mon Sep 17 00:00:00 2001 From: Nate Koenig Date: Wed, 20 Oct 2021 09:05:32 -0700 Subject: [PATCH] Added documentation Signed-off-by: Nate Koenig --- src/systems/camera_video_recorder/CameraVideoRecorder.cc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/systems/camera_video_recorder/CameraVideoRecorder.cc b/src/systems/camera_video_recorder/CameraVideoRecorder.cc index bbda163137..6918036299 100644 --- a/src/systems/camera_video_recorder/CameraVideoRecorder.cc +++ b/src/systems/camera_video_recorder/CameraVideoRecorder.cc @@ -124,7 +124,12 @@ class ignition::gazebo::systems::CameraVideoRecorderPrivate /// By default (false), video encoding is done using real time. public: bool recordVideoUseSimTime = false; - /// \brief Video recorder bitrate (bps) + /// \brief Video recorder bitrate (bps). This is rougly 2Mbps which + /// produces decent video quality while not generating overly large + /// video files. + /// + /// Another point of reference is at: + /// https://support.google.com/youtube/answer/1722171?hl=en#zippy=%2Cbitrate public: unsigned int recordVideoBitrate = 2070000; /// \brief Recording frames per second.