diff options
Diffstat (limited to 'src/sound_mxf_writer.h')
| -rw-r--r-- | src/sound_mxf_writer.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/sound_mxf_writer.h b/src/sound_mxf_writer.h index 4f60074c..d79c60db 100644 --- a/src/sound_mxf_writer.h +++ b/src/sound_mxf_writer.h @@ -17,6 +17,10 @@ */ +/** @file src/sound_mxf_writer.h + * @brief SoundMXFWriter class. + */ + #include "mxf_writer.h" #include "types.h" #include <boost/shared_ptr.hpp> @@ -27,6 +31,15 @@ namespace dcp { class SoundFrame; class SoundMXF; +/** @class SoundMXFWriter + * @brief A helper class for writing to SoundMXFs. + * + * Objects of this class can only be created with SoundMXF::start_write(). + * + * Sound samples can be written to the SoundMXF by calling write() with + * a buffer of float values. finalize() must be called after the last samples + * have been written. + */ class SoundMXFWriter : public MXFWriter { public: |