diff options
| author | Carl Hetherington <cth@carlh.net> | 2012-07-17 21:09:39 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2012-07-17 21:09:39 +0100 |
| commit | 82d22d7ff5328fae4f2e3048e63a2b11f3ce36b4 (patch) | |
| tree | 82bdbe0285f159bcfd8204d53efe938bd5999095 /src/sound_asset.h | |
| parent | 4709b2fe88040f3678560997726f3a209eacc660 (diff) | |
Doc fixes.
Diffstat (limited to 'src/sound_asset.h')
| -rw-r--r-- | src/sound_asset.h | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/src/sound_asset.h b/src/sound_asset.h index aa1362f6..c63bab90 100644 --- a/src/sound_asset.h +++ b/src/sound_asset.h @@ -17,18 +17,33 @@ */ +/** @file src/sound_asset.h + * @brief An asset made up of WAV files + */ + #include "asset.h" namespace libdcp { -/** An asset made up of WAV files */ +/** @brief An asset made up of WAV files */ class SoundAsset : public Asset { public: - SoundAsset (std::list<std::string> const &, std::string, sigc::signal1<void, float>*, int, int); - - void write_to_cpl (std::ostream &) const; + /** Construct a SoundAsset, generating the MXF from the WAV files. + * This may take some time; progress is indicated by emission of the Progress signal. + * @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround. + * @param mxf_path Pathname of MXF file to create. + * @param progress Signal to inform of progress. + * @param fps Frames per second. + * @param length Length in frames. + */ + SoundAsset (std::list<std::string> const & files, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length); + + /** Write details of this asset to a CPL stream. + * @param s Stream. + */ + void write_to_cpl (std::ostream& s) const; }; } |
