FileProperties: add doc for getBitRate

Clement Champetier · valnoel · commit 26a998f16a43 · 2015-03-17T16:41:22.000+01:00
diff --git a/src/AvTranscoder/mediaProperty/FileProperties.hpp b/src/AvTranscoder/mediaProperty/FileProperties.hpp
@@ -29,7 +29,7 @@ class AvExport FileProperties
 	size_t getProgramsCount() const;
 	double getStartTime() const;
 	double getDuration() const;  ///< in seconds
-	size_t getBitRate() const;
+	size_t getBitRate() const;  ///< total stream bitrate in bit/s, 0 if not available (result of a computation by ffmpeg)
 	size_t getPacketSize() const;
 
 	PropertiesMap& getMetadatas() { return _metadatas; }
