diff options
author | Joerg Mueller <nexyon@gmail.com> | 2011-08-16 17:00:55 +0400 |
---|---|---|
committer | Joerg Mueller <nexyon@gmail.com> | 2011-08-16 17:00:55 +0400 |
commit | 02d2472baacd8ac091a29392a2bc9ac8693fb5e7 (patch) | |
tree | dfd8a80ce8c1771a318a46120c81514836ed4b2d /intern/audaspace/sndfile | |
parent | a67562e73cbc2f4a9641fbc4d1147b4b2cc935c4 (diff) |
3D Audio GSoC:
Code documentation.
Also:
* Fix: rlint for MSVC.
* Minor other small fixes/changes.
Diffstat (limited to 'intern/audaspace/sndfile')
-rw-r--r-- | intern/audaspace/sndfile/AUD_SndFileWriter.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/intern/audaspace/sndfile/AUD_SndFileWriter.h b/intern/audaspace/sndfile/AUD_SndFileWriter.h index 63f9e9e1371..110b7f800cd 100644 --- a/intern/audaspace/sndfile/AUD_SndFileWriter.h +++ b/intern/audaspace/sndfile/AUD_SndFileWriter.h @@ -33,13 +33,10 @@ #define AUD_SNDFILEWRITER #include "AUD_IWriter.h" -//#include "AUD_Buffer.h" #include <string> #include <sndfile.h> -typedef sf_count_t (*sf_read_f)(SNDFILE *sndfile, void *ptr, sf_count_t frames); - /** * This class writes a sound file via libsndfile. */ @@ -69,6 +66,10 @@ public: /** * Creates a new writer. * \param filename The path to the file to be read. + * \param specs The file's audio specification. + * \param format The file's container format. + * \param codec The codec used for encoding the audio data. + * \param bitrate The bitrate for encoding. * \exception AUD_Exception Thrown if the file specified cannot be written * with libsndfile. */ |