summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia-codec/l16.h
diff options
context:
space:
mode:
Diffstat (limited to 'pjmedia/include/pjmedia-codec/l16.h')
-rw-r--r--pjmedia/include/pjmedia-codec/l16.h16
1 files changed, 14 insertions, 2 deletions
diff --git a/pjmedia/include/pjmedia-codec/l16.h b/pjmedia/include/pjmedia-codec/l16.h
index 44503c03..295f6be1 100644
--- a/pjmedia/include/pjmedia-codec/l16.h
+++ b/pjmedia/include/pjmedia-codec/l16.h
@@ -26,16 +26,28 @@
/**
* @defgroup PJMED_L16 L16 Codec Family
* @ingroup PJMEDIA_CODEC_CODECS
- * @brief PCM/16bit/linear codecs
+ * @brief Implementation of PCM/16bit/linear codecs
* @{
*
- * This section describes functions to register and register L16 codec
+ * This section describes functions to initialize and register L16 codec
* factory to the codec manager. After the codec factory has been registered,
* application can use @ref PJMEDIA_CODEC API to manipulate the codec.
*
* Note that the L16 codec factory registers several (about fourteen!)
* L16 codec types to codec manager (different combinations of clock
* rate and number of channels).
+ *
+ * \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.
*/
PJ_BEGIN_DECL