diff options
| author | Carl Hetherington <cth@carlh.net> | 2012-11-18 22:46:15 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2012-11-18 22:46:15 +0000 |
| commit | b1defe9019642dc4b80697291d40ed88f09de8be (patch) | |
| tree | 80f29e64acb805c21ea96e7e4ec070a88ca2397d /src/lib/audio_decoder.h | |
| parent | 81dab3aaea745ddef97166448cb0730520798356 (diff) | |
Fix mis-alignment of copied AlignedImages; add some asserts; some docs.
Diffstat (limited to 'src/lib/audio_decoder.h')
| -rw-r--r-- | src/lib/audio_decoder.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib/audio_decoder.h b/src/lib/audio_decoder.h index e9fbd6f62..1570fe3b0 100644 --- a/src/lib/audio_decoder.h +++ b/src/lib/audio_decoder.h @@ -17,6 +17,10 @@ */ +/** @file src/lib/audio_decoder.h + * @brief Parent class for audio decoders. + */ + #ifndef DVDOMATIC_AUDIO_DECODER_H #define DVDOMATIC_AUDIO_DECODER_H @@ -24,6 +28,9 @@ #include "stream.h" #include "decoder.h" +/** @class AudioDecoder. + * @brief Parent class for audio decoders. + */ class AudioDecoder : public AudioSource, public virtual Decoder { public: @@ -31,16 +38,20 @@ public: virtual void set_audio_stream (boost::shared_ptr<AudioStream>); + /** @return Audio stream that we are using */ boost::shared_ptr<AudioStream> audio_stream () const { return _audio_stream; } + /** @return All available audio streams */ std::vector<boost::shared_ptr<AudioStream> > audio_streams () const { return _audio_streams; } protected: + /** Audio stream that we are using */ boost::shared_ptr<AudioStream> _audio_stream; + /** All available audio streams */ std::vector<boost::shared_ptr<AudioStream> > _audio_streams; }; |
