Changeset 2275


Ignore:
Timestamp:
Sep 11, 2008 5:38:48 PM (11 years ago)
Author:
nanang
Message:

Ticket #614: Updated docs related to support for play/record G.711 U-law/A-law.

File:
1 edited

Legend:

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

    r2270 r2275  
    5252 
    5353/** 
    54  * Create a media port to play streams from a WAV file. 
     54 * Create a media port to play streams from a WAV file. WAV player port 
     55 * supports for reading WAV file with uncompressed 16 bit PCM format or  
     56 * compressed G.711 A-law/U-law format. 
    5557 * 
    5658 * @param pool          Pool to create memory buffers for this port. 
     
    169171 * must be closed properly (with #pjmedia_port_destroy()) so that the WAV 
    170172 * header can be filled with correct values (such as the file length). 
     173 * WAV writer port supports for writing audio in uncompressed 16 bit PCM format 
     174 * or compressed G.711 U-law/A-law format, this needs to be specified in  
     175 * \a flags param. 
    171176 * 
    172177 * @param pool              Pool to create memory buffers for this port. 
     
    176181 * @param samples_per_frame Number of samples per frame. 
    177182 * @param bits_per_sample   Number of bits per sample (eg 16). 
    178  * @param flags             Port creation flags. 
     183 * @param flags             Port creation flags, see 
     184 *                          #pjmedia_file_writer_option. 
    179185 * @param buff_size         Buffer size to be allocated. If the value is  
    180186 *                          zero or negative, the port will use default buffer 
    181187 *                          size (which is about 4KB). 
    182   * @param p_port           Pointer to receive the file port instance. 
     188 * @param p_port            Pointer to receive the file port instance. 
    183189 * 
    184190 * @return                  PJ_SUCCESS on success. 
Note: See TracChangeset for help on using the changeset viewer.