Ignore:
Timestamp:
Jan 29, 2010 3:51:09 PM (10 years ago)
Author:
nanang
Message:

Ticket #1028:

  • Updated codecs docs, more detail info about codec settings.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjmedia/include/pjmedia-codec/ilbc.h

    r2875 r3083  
    3434 * @{ 
    3535 * 
    36  * This section describes functions to register and register iLBC codec 
     36 * This section describes functions to initialize and register iLBC codec 
    3737 * factory to the codec manager. After the codec factory has been registered, 
    3838 * application can use @ref PJMEDIA_CODEC API to manipulate the codec. 
     39 * 
     40 * The iLBC codec is developed by Global IP Solutions (GIPS), formerly  
     41 * Global IP Sound. The iLBC offers low bitrate and graceful audio quality  
     42 * degradation on frame losses. 
     43 * 
     44 * The iLBC codec supports 16-bit PCM audio signal with sampling rate of  
     45 * 8000Hz operating at two modes: 20ms and 30ms frame length modes, resulting 
     46 * in bitrates of 15.2kbps for 20ms mode and 13.33kbps for 30ms mode. 
     47 * 
     48 * 
     49 * \section codec_setting Codec Settings 
     50 * 
     51 * \subsection general_setting General Settings 
     52 * 
     53 * General codec settings for this codec such as VAD and PLC can be  
     54 * manipulated through the <tt>setting</tt> field in #pjmedia_codec_param.  
     55 * Please see the documentation of #pjmedia_codec_param for more info. 
     56 * 
     57 * \subsection specific_setting Codec Specific Settings 
     58 * 
     59 * The following settings are applicable for this codec. 
     60 * 
     61 * \subsubsection mode Mode 
     62 * 
     63 * The default mode should be set upon initialization, see 
     64 * #pjmedia_codec_ilbc_init(). After the codec is initialized, the default 
     65 * mode can be modified using #pjmedia_codec_mgr_set_default_param(). 
     66 * 
     67 * In #pjmedia_codec_param, iLBC mode can be set by specifying SDP 
     68 * format parameter "mode" in the SDP "a=fmtp" attribute for decoding 
     69 * direction. Valid values are "20" and "30" (for 20ms and 30ms mode  
     70 * respectively). 
     71 * 
     72 * Here is an example to set up #pjmedia_codec_param to use mode 20ms: 
     73 *  \code 
     74    pjmedia_codec_param param; 
     75    ... 
     76    // setting iLBC mode in SDP 
     77    param.setting.dec_fmtp.cnt = 1; 
     78    param.setting.dec_fmtp.param[0].name = pj_str("mode"); 
     79    param.setting.dec_fmtp.param[0].val  = pj_str("20"); 
     80    ... 
     81 \endcode 
    3982 */ 
    4083 
Note: See TracChangeset for help on using the changeset viewer.