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/speex.h

    r2875 r3083  
    3434 * @{ 
    3535 * 
    36  * This section describes functions to register and register speex codec 
     36 * This section describes functions to initialize and register speex 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 Speex codec uses multiple bit rates, and supports ultra-wideband  
     41 * (32 kHz sampling rate), wideband (16 kHz sampling rate) and narrowband  
     42 * (telephone quality, 8 kHz sampling rate) 
    3943 * 
    4044 * By default, the speex codec factory registers three Speex codecs: 
     
    4246 * "speex/32000" ultra-wideband codec. This behavior can be changed by 
    4347 * specifying #pjmedia_speex_options flags during initialization. 
     48 * 
     49 * 
     50 * \section codec_setting Codec Settings 
     51 * 
     52 * \subsection general_setting General Settings 
     53 * 
     54 * General codec settings for this codec such as VAD and PLC can be  
     55 * manipulated through the <tt>setting</tt> field in #pjmedia_codec_param.  
     56 * Please see the documentation of #pjmedia_codec_param for more info. 
     57 * 
     58 * \subsection specific_setting Codec Specific Settings 
     59 * 
     60 * The following settings are applicable for this codec. 
     61 * 
     62 * \subsubsection quality_vs_complexity Quality vs Complexity 
     63 * 
     64 * The Speex codec quality versus computational complexity and bandwidth 
     65 * requirement can be adjusted by modifying the quality and complexity 
     66 * setting, by calling #pjmedia_codec_speex_set_param(). The RFC 5574 
     67 * Section 5 shows the relationship between quality setting and the 
     68 * resulting bitrate. 
     69 * 
     70 * The default setting of quality is specified in  
     71 * #PJMEDIA_CODEC_SPEEX_DEFAULT_QUALITY. And the default setting of 
     72 * complexity is specified in #PJMEDIA_CODEC_SPEEX_DEFAULT_COMPLEXITY. 
    4473 */ 
    4574 
Note: See TracChangeset for help on using the changeset viewer.