diff options
| author | Carl Hetherington <cth@carlh.net> | 2014-05-01 15:07:04 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2014-05-01 15:07:04 +0100 |
| commit | 2d46203be73930a968806fa1af88369de51734ff (patch) | |
| tree | 8c896f39ca2ef48c44dd3f069c043c89ce668bfd /src/lib/analyse_audio_job.h | |
| parent | c98c87afe29d9ef74bdced8a9c96d7752f3fe80f (diff) | |
Comments.
Diffstat (limited to 'src/lib/analyse_audio_job.h')
| -rw-r--r-- | src/lib/analyse_audio_job.h | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib/analyse_audio_job.h b/src/lib/analyse_audio_job.h index d3c35b67c..4d657951b 100644 --- a/src/lib/analyse_audio_job.h +++ b/src/lib/analyse_audio_job.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington <cth@carlh.net> + Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,6 +17,10 @@ */ +/** @file src/lib/analyse_audio_job.h + * @brief AnalyseAudioJob class. + */ + #include "job.h" #include "audio_analysis.h" #include "types.h" @@ -25,6 +29,13 @@ class AudioBuffers; class AudioContent; +/** @class AnalyseAudioJob + * @brief A job to analyse the audio of a piece of AudioContent and make a note of its + * broad peak and RMS levels. + * + * After computing the peak and RMS levels over the length of the content, the job + * will write a file to Content::audio_analysis_path. + */ class AnalyseAudioJob : public Job { public: |