From eca83d705ff9f199a792490f6ee47ca22d739f2a Mon Sep 17 00:00:00 2001 From: Erol444 Date: Wed, 7 Feb 2024 18:25:53 +0200 Subject: [PATCH] Updated videoEnc comments so docs will be updated. --- include/depthai/pipeline/node/VideoEncoder.hpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/depthai/pipeline/node/VideoEncoder.hpp b/include/depthai/pipeline/node/VideoEncoder.hpp index 59c186e52..904584d4c 100644 --- a/include/depthai/pipeline/node/VideoEncoder.hpp +++ b/include/depthai/pipeline/node/VideoEncoder.hpp @@ -78,7 +78,7 @@ class VideoEncoder : public NodeCRTP int getNumFramesPool() const; // encoder properties - /// Set rate control mode + /// Set rate control mode Applicable only to H264 and H265 profiles void setRateControlMode(Properties::RateControlMode mode); /// Set encoding profile void setProfile(Properties::Profile profile); @@ -89,9 +89,9 @@ class VideoEncoder : public NodeCRTP [[deprecated("Input width/height no longer needed, automatically determined from first frame")]] void setProfile(int width, int height, Properties::Profile profile); - /// Set output bitrate in bps, for CBR rate control mode. 0 for auto (based on frame size and FPS) + /// Set output bitrate in bps, for CBR rate control mode. 0 for auto (based on frame size and FPS). Applicable only to H264 and H265 profiles void setBitrate(int bitrate); - /// Set output bitrate in kbps, for CBR rate control mode. 0 for auto (based on frame size and FPS) + /// Set output bitrate in kbps, for CBR rate control mode. 0 for auto (based on frame size and FPS). Applicable only to H264 and H265 profiles void setBitrateKbps(int bitrateKbps); /** @@ -108,11 +108,11 @@ class VideoEncoder : public NodeCRTP */ void setKeyframeFrequency(int freq); - /// Set number of B frames to be inserted + /// Set number of B frames to be inserted. Applicable only to H264 and H265 profiles void setNumBFrames(int numBFrames); /** - * Set quality + * Set quality for [M]JPEG profile * @param quality Value between 0-100%. Approximates quality */ void setQuality(int quality);