summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia-codec/g722.h
diff options
context:
space:
mode:
authorNanang Izzuddin <nanang@teluu.com>2010-01-29 15:51:09 +0000
committerNanang Izzuddin <nanang@teluu.com>2010-01-29 15:51:09 +0000
commit988d451bfb7c095a883cd17dba252f3ca0776b0b (patch)
treec8413b2c4ee936240565adf6204905220fd0e9b7 /pjmedia/include/pjmedia-codec/g722.h
parentf3d584101fb40816718221330df4a729080340f9 (diff)
Ticket #1028:
- Updated codecs docs, more detail info about codec settings. git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@3083 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjmedia/include/pjmedia-codec/g722.h')
-rw-r--r--pjmedia/include/pjmedia-codec/g722.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/pjmedia/include/pjmedia-codec/g722.h b/pjmedia/include/pjmedia-codec/g722.h
index 328356e0..71a5bb5b 100644
--- a/pjmedia/include/pjmedia-codec/g722.h
+++ b/pjmedia/include/pjmedia-codec/g722.h
@@ -33,12 +33,27 @@
* @brief Implementation of G.722 Codec
* @{
*
- * This section describes functions to register and register G.722 codec
+ * This section describes functions to initialize and register G.722 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 G.722 implementation uses 16-bit PCM with sampling rate 16000Hz and
+ * 20ms frame length resulting in 64kbps bitrate.
+ *
* The G.722 codec implementation is provided as part of pjmedia-codec
* library, and does not depend on external G.722 codec implementation.
+ *
+ * \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