summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-07-18 00:31:09 +0100
committerCarl Hetherington <cth@carlh.net>2012-07-18 00:31:09 +0100
commitdfd9622f157f1e778352e418eec53483af7ba724 (patch)
tree226ba349e5a95a638cea78dc8766a9130c17f8d4
parentca45f479876579c91b9d438c47c5166b1a178704 (diff)
Doc tweaks.
-rw-r--r--src/picture_asset.h2
-rw-r--r--src/sound_asset.h5
2 files changed, 3 insertions, 4 deletions
diff --git a/src/picture_asset.h b/src/picture_asset.h
index 58dd1dfd..26b9b55a 100644
--- a/src/picture_asset.h
+++ b/src/picture_asset.h
@@ -52,7 +52,7 @@ public:
/** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
* This may take some time; progress is indicated by emission of the Progress signal.
- * @param files Pathnames of JPEG2000 files, in frame order.
+ * @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
* @param mxf_path Pathname of MXF file to create.
* @param progress Signal to inform of progress.
* @param fps Frames per second.
diff --git a/src/sound_asset.h b/src/sound_asset.h
index 591b0a47..6e85a407 100644
--- a/src/sound_asset.h
+++ b/src/sound_asset.h
@@ -41,7 +41,6 @@ public:
* @param progress Signal to inform of progress.
* @param fps Frames per second.
* @param length Length in frames.
- * @param channels Number of audio channels.
*/
SoundAsset (
std::vector<std::string> const & files,
@@ -53,7 +52,7 @@ public:
/** 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 get_path Functor which returns a WAV file path for a given channel.
* @param mxf_path Pathname of MXF file to create.
* @param progress Signal to inform of progress.
* @param fps Frames per second.
@@ -61,7 +60,7 @@ public:
* @param channels Number of audio channels.
*/
SoundAsset (
- sigc::slot<std::string, Channel>,
+ sigc::slot<std::string, Channel> get_path,
std::string mxf_path,
sigc::signal1<void, float>* progress,
int fps,