diff options
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/writer.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/lib/writer.h b/src/lib/writer.h index ca0bdeb92..9e95c0531 100644 --- a/src/lib/writer.h +++ b/src/lib/writer.h @@ -17,6 +17,10 @@ */ +/** @file src/lib/writer.h + * @brief Writer class. + */ + #include <list> #include <boost/shared_ptr.hpp> #include <boost/thread.hpp> @@ -67,6 +71,17 @@ public: bool operator< (QueueItem const & a, QueueItem const & b); bool operator== (QueueItem const & a, QueueItem const & b); +/** @class Writer + * @brief Class to manage writing JPEG2000 and audio data to MXFs on disk. + * + * This class creates sound and picture MXFs, then takes EncodedData + * or AudioBuffers objects (containing image or sound data respectively) + * and writes them to the MXFs. + * + * ::write() for EncodedData can be called out of order, and the Writer + * will sort it out. write() for AudioBuffers must be called in order. + */ + class Writer : public ExceptionStore, public boost::noncopyable { public: |