Changeset 2523

Show
Ignore:
Timestamp:
05/19/99 18:55:59 (15 years ago)
Author:
ucacoxh
Message:

- Added some documentation to the top of this file since I am using it

for something else and a little info is helpful ;-)

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • rat/trunk/sndfile.h

    r2314 r2523  
    1818extern "C" { 
    1919#endif 
     20 
     21/* The interface below allows access to Sun .au files and MS .wav files. 
     22 * 
     23 * The decision about which format is used depends on the extension of 
     24 * the file name. 
     25 * 
     26 * The functions snd_{read,write}_open take a pointer to a pointer  
     27 * of type struct s_snd_file.  This makes allocation/access more 
     28 * restrictive, but safer. 
     29 * 
     30 * NOTE: for snd_read_audio and snd_write_audio, buf_len is the 
     31 * product of the number of sampling intervals to be written and 
     32 * the number of channels. 
     33 */ 
    2034 
    2135struct s_snd_file;