Ignore:
Timestamp:
Jun 20, 2008 9:39:02 PM (16 years ago)
Author:
bennylp
Message:

Updated doxygen documentations

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjmedia/include/pjmedia/delaybuf.h

    r1972 r2037  
    3030 
    3131/** 
    32  * @defgroup PJMED_DELAYBUF Delay Buffer 
     32 * @defgroup PJMED_DELAYBUF Adaptive Delay Buffer 
    3333 * @ingroup PJMEDIA_FRAME_OP 
     34 * @brief Adaptive delay buffer with high-quality time-scale 
     35 * modification 
    3436 * @{ 
     37 * 
    3538 * This section describes PJMEDIA's implementation of delay buffer. 
    3639 * Delay buffer works quite similarly like a fixed jitter buffer, that 
     
    4447 * get() and put() are matched). 
    4548 * 
    46  * The delay buffer is mostly used by the sound port, to accommodate 
    47  * for the burst frames returned by the sound device. 
     49 * The buffer is adaptive, that is it continuously learns the optimal delay 
     50 * to be applied to the audio flow at run-time. Once the optimal delay has  
     51 * been learned, the delay buffer will apply this delay to the audio flow, 
     52 * expanding or shrinking the audio samples as necessary when the actual 
     53 * audio samples in the buffer are too low or too high. It does this without 
     54 * distorting the audio quality of the audio, by using \a PJMED_WSOLA. 
    4855 * 
    49  * To determine the level of delay to be applied, the delay buffer 
    50  * has a learning period on which it calculates the level of burst of 
    51  * both the put() and get(), and use the maximum value of both as the 
    52  * delay level. 
     56 * The delay buffer is used in \ref PJMED_SND_PORT, \ref PJMEDIA_SPLITCOMB, 
     57 * and \ref PJMEDIA_CONF. 
    5358 */ 
    5459 
Note: See TracChangeset for help on using the changeset viewer.