Updated videoEnc comments so docs will be updated.

luxonis · Feb 7, 2024 · eca83d7 · eca83d7
1 parent 636118a
commit eca83d7
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/include/depthai/pipeline/node/VideoEncoder.hpp b/include/depthai/pipeline/node/VideoEncoder.hpp
@@ -78,7 +78,7 @@ class VideoEncoder : public NodeCRTP<Node, VideoEncoder, VideoEncoderProperties>
     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<Node, VideoEncoder, VideoEncoderProperties>
     [[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<Node, VideoEncoder, VideoEncoderProperties>
      */
     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);