summaryrefslogtreecommitdiff
path: root/src/lib/content.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-07-10 11:36:19 +0100
committerCarl Hetherington <cth@carlh.net>2014-07-10 11:36:19 +0100
commit6dc102cef17ac0b3f3089985813c58bc16058e66 (patch)
tree7f3f26cacaaa02f240aa68b2f24196c86047eebb /src/lib/content.h
parentb0b000a9d11edc4febaca951c345df229cd5f3f4 (diff)
Docs.
Diffstat (limited to 'src/lib/content.h')
-rw-r--r--src/lib/content.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/lib/content.h b/src/lib/content.h
index ab14dc6f5..f7e97feac 100644
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -63,16 +63,23 @@ public:
Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
virtual ~Content () {}
+
+ /** Examine the content to establish digest, frame rates and any other
+ * useful metadata.
+ * @param job Job to use to report progress, or 0.
+ */
+ virtual void examine (boost::shared_ptr<Job> job);
- virtual void examine (boost::shared_ptr<Job>);
/** @return Quick one-line summary of the content, as will be presented in the
* film editor.
*/
virtual std::string summary () const = 0;
+
/** @return Technical details of this content; these are written to logs to
* help with debugging.
*/
virtual std::string technical_summary () const;
+
virtual std::string information () const = 0;
virtual void as_xml (xmlpp::Node *) const;
virtual DCPTime full_length () const = 0;