Changeset 3083 for pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h

Timestamp:

Jan 29, 2010 3:51:09 PM (14 years ago)

Author:

nanang

Message:

Ticket #1028:

• Updated codecs docs, more detail info about codec settings.

File:

• pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h (modified) (1 diff)

pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h

@@ -34 +34 @@
  * @{
  *
- * This section describes functions to register and register GSM codec
+ * This section describes functions to initialize and register GSM codec
  * factory to the codec manager. After the codec factory has been registered,
  * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
+ *
+ * The GSM codec supports 16-bit PCM with sampling rate of 8000Hz resulting
+ * in 13.2kbps bitrate.
+ *
+ * \section codec_setting Codec Settings
+ *
+ * \subsection general_setting General Settings
+ *
+ * General codec settings for this codec such as VAD and PLC can be 
+ * manipulated through the <tt>setting</tt> field in #pjmedia_codec_param. 
+ * Please see the documentation of #pjmedia_codec_param for more info.
+ *
+ * \subsection specific_setting Codec Specific Settings
+ *
+ * Currently none.
  */