diff options
| author | Nanang Izzuddin <nanang@teluu.com> | 2010-01-29 15:51:09 +0000 |
|---|---|---|
| committer | Nanang Izzuddin <nanang@teluu.com> | 2010-01-29 15:51:09 +0000 |
| commit | 988d451bfb7c095a883cd17dba252f3ca0776b0b (patch) | |
| tree | c8413b2c4ee936240565adf6204905220fd0e9b7 /pjmedia/include/pjmedia | |
| parent | f3d584101fb40816718221330df4a729080340f9 (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')
| -rw-r--r-- | pjmedia/include/pjmedia/g711.h | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/pjmedia/include/pjmedia/g711.h b/pjmedia/include/pjmedia/g711.h index 2e7fcf1f..cdbe5a3e 100644 --- a/pjmedia/include/pjmedia/g711.h +++ b/pjmedia/include/pjmedia/g711.h @@ -28,13 +28,32 @@ #include <pjmedia-codec/types.h> /** - * @defgroup PJMED_G711 G711 G.711 Codec + * @defgroup PJMED_G711 G.711 Codec * @ingroup PJMEDIA_CODEC_CODECS * @brief Standard G.711/PCMA and PCMU codec. * @{ - * This section describes functions to register and register G.711 codec + * + * This section describes functions to initialize and register G.711 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.711 is an ultra low complexity codecs and in trade-off it results + * in high bitrate, i.e: 64kbps for 16-bit PCM with sampling rate 8000Hz. + * + * The factory contains two main compression algorithms, PCMU/u-Law and + * PCMA/A-Law. + * + * \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 |