r3205 - trunk/libminisip/include/libminisip/codecs

[erik at minisip.org]

Author: erik
Date: 2007-02-14 14:58:17 +0100 (Wed, 14 Feb 2007)
New Revision: 3205

Modified:
   trunk/libminisip/include/libminisip/codecs/Codec.h
Log:

 * Trigger auto-build.



Modified: trunk/libminisip/include/libminisip/codecs/Codec.h
===================================================================
--- trunk/libminisip/include/libminisip/codecs/Codec.h	2007-02-14 13:15:28 UTC (rev 3204)
+++ trunk/libminisip/include/libminisip/codecs/Codec.h	2007-02-14 13:58:17 UTC (rev 3205)
@@ -45,8 +45,17 @@
 		
 		virtual std::string getCodecName()=0;
 		
+		/**
+		 * This should be a single line that can be presented to
+		 * in the GUI describing what the codec is (name, bandwidth
+		 * usage, HZ or what ever is found necessary)
+		 */
 		virtual std::string getCodecDescription()=0;
 		
+		/**
+		 * Returns the number assigned to this CODEC.
+		 * Example: 0 for PCMu and 8 for PCMa
+		 */
 		virtual uint8_t getSdpMediaType()=0;
 
 		virtual std::string getSdpMediaAttributes()=0;