diff options
| author | Carl Hetherington <carl@carlh.net> | 2011-11-16 02:03:30 +0000 |
|---|---|---|
| committer | Carl Hetherington <carl@carlh.net> | 2011-11-16 02:03:30 +0000 |
| commit | 6e1aa92eb82071868fd2e24838344d6c2aa8ba5b (patch) | |
| tree | b33d4d169eb9bf55bc0c3d11c2a88c9b936787af /libs/ardour/ardour/diskstream.h | |
| parent | e4ce7667545253d478160554b8ad0a661588f622 (diff) | |
Doxygen tweaks.
git-svn-id: svn://localhost/ardour2/branches/3.0@10644 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'libs/ardour/ardour/diskstream.h')
| -rw-r--r-- | libs/ardour/ardour/diskstream.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h index c93cda83cb..96bffae723 100644 --- a/libs/ardour/ardour/diskstream.h +++ b/libs/ardour/ardour/diskstream.h @@ -50,6 +50,9 @@ class Session; class Track; class Location; +/** Parent class for classes which can stream data to and from disk. + * These are used by Tracks to get playback and put recorded data. + */ class Diskstream : public SessionObject, public PublicDiskstream { public: @@ -69,6 +72,10 @@ class Diskstream : public SessionObject, public PublicDiskstream boost::shared_ptr<ARDOUR::IO> io() const { return _io; } void set_track (ARDOUR::Track *); + /** @return A number between 0 and 1, where 0 indicates that the playback buffer + * is dry (ie the disk subsystem could not keep up) and 1 indicates that the + * buffer is full. + */ virtual float playback_buffer_load() const = 0; virtual float capture_buffer_load() const = 0; |