Add variousn new bits to CertificateChain.

[libdcp.git] / src / sound_mxf.h

diff --git a/src/sound_mxf.h b/src/sound_mxf.h
index 098680acf9724cbea881368cf1f09f884a0bf651..50d109570e0c02b5f1af4995f89b6d6a61c06d7e 100644 (file)
--- a/src/sound_mxf.h
+++ b/src/sound_mxf.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/sound_mxf.h
+ *  @brief SoundMXF class
+ */
+
 #ifndef LIBDCP_SOUND_MXF_H
 #define LIBDCP_SOUND_MXF_H
 
@@ -30,6 +34,9 @@ namespace dcp
 class SoundFrame;
 class SoundMXFWriter;
 
+/** @class SoundMXF
+ *  @brief Representation of a MXF file containing sound
+ */
 class SoundMXF : public MXF
 {
 public:
@@ -38,32 +45,32 @@ public:
 
        boost::shared_ptr<SoundMXFWriter> start_write (boost::filesystem::path file, Standard standard);
        
-       bool equals (boost::shared_ptr<const Content> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+       bool equals (
+               boost::shared_ptr<const Content> other,
+               EqualityOptions opt,
+               boost::function<void (NoteType, std::string)> note
+               ) const;
 
        boost::shared_ptr<const SoundFrame> get_frame (int n) const;
 
-       void set_channels (int c) {
-               _channels = c;
-       }
-       
+       /** @return number of channels */
        int channels () const {
                return _channels;
        }
 
-       void set_sampling_rate (int s) {
-               _sampling_rate = s;
-       }
-
+       /** @return sampling rate in Hz */
        int sampling_rate () const {
                return _sampling_rate;
        }
 
 private:
        std::string key_type () const;
+       std::string asdcp_kind () const {
+               return "Sound";
+       }
 
-       /** Number of channels in the asset */
-       int _channels;
-       int _sampling_rate;
+       int _channels;      ///< number of channels
+       int _sampling_rate; ///< sampling rate in Hz
 };
 
 }