Ignore:
Timestamp:
Jun 18, 2006 2:02:36 AM (18 years ago)
Author:
bennylp
Message:

Updated doxygen documentation to all headers in PJMEDIA

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/pjmedia/include/pjmedia/wav_port.h

    r480 r518  
    3232 
    3333/** 
     34 * @defgroup PJMEDIA_FILE_PLAY File Player 
     35 * @ingroup PJMEDIA_PORT 
     36 * @brief WAV File Player 
     37 * @{ 
     38 */ 
     39 
     40/** 
     41 * WAV file player options. 
     42 */ 
     43enum pjmedia_file_player_option 
     44{ 
     45    /** 
     46     * Tell the file player to return NULL frame when the whole 
     47     * file has been played. 
     48     */ 
     49    PJMEDIA_FILE_NO_LOOP = 1, 
     50}; 
     51 
     52 
     53/** 
    3454 * Create a media port to play streams from a WAV file. 
    3555 * 
    … …  
    4060 *                      duration (20ms) will be used. 
    4161 * @param flags         Port creation flags. 
    42  * @param buf_size      Buffer size to be allocated. If the value is zero or 
     62 * @param buff_size     Buffer size to be allocated. If the value is zero or 
    4363 *                      negative, the port will use default buffer size (which 
    4464 *                      is about 4KB). 
    … …  
    7090 
    7191/** 
     92 * @} 
     93 */ 
     94 
     95 
     96/** 
     97 * @defgroup PJMEDIA_FILE_REC File Writer (Recorder) 
     98 * @ingroup PJMEDIA_PORT 
     99 * @brief WAV File Writer (Recorder) 
     100 * @{ 
     101 */ 
     102 
     103 
     104 
     105/** 
    72106 * Create a media port to record streams to a WAV file. Note that the port 
    73107 * must be closed properly (with #pjmedia_port_destroy()) so that the WAV 
    74108 * header can be filled with correct values (such as the file length). 
    75109 * 
    76  * @param pool          Pool to create memory buffers for this port. 
    77  * @param filename      File name. 
    78  * @param clock_rate    The sampling rate. 
    79  * @param channel_count Number of channels. 
     110 * @param pool              Pool to create memory buffers for this port. 
     111 * @param filename          File name. 
     112 * @param clock_rate        The sampling rate. 
     113 * @param channel_count     Number of channels. 
    80114 * @param samples_per_frame Number of samples per frame. 
    81  * @param bits_per_sampe Number of bits per sample (eg 16). 
    82  * @param flags         Port creation flags (must be 0 at present). 
    83  * @param buf_size      Buffer size to be allocated. If the value is zero or 
     115 * @param bits_per_sample  Number of bits per sample (eg 16). 
     116 * @param flags             Port creation flags (must be 0 at present). 
     117 * @param buff_size     Buffer size to be allocated. If the value is zero or 
    84118 *                      negative, the port will use default buffer size (which 
    85119 *                      is about 4KB). 
    … …  
    102136 
    103137 
     138/** 
     139 * @} 
     140 */ 
     141 
    104142 
    105143PJ_END_DECL 
Note: See TracChangeset for help on using the changeset viewer.