From 0936c7c5802a64aea1dde8cc77b4be0ebc0c09c3 Mon Sep 17 00:00:00 2001 From: itsmattkc Date: Mon, 18 Jan 2021 10:43:59 +1100 Subject: [PATCH] added some documentation to audiovisualwaveform --- app/audio/audiovisualwaveform.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/app/audio/audiovisualwaveform.h b/app/audio/audiovisualwaveform.h index 759f71385..13e68b664 100644 --- a/app/audio/audiovisualwaveform.h +++ b/app/audio/audiovisualwaveform.h @@ -69,6 +69,26 @@ public: void AddSum(const float* samples, int nb_samples, int nb_channels); void OverwriteSamples(SampleBufferPtr samples, int sample_rate, const rational& start = rational()); + + /** + * @brief Replaces sums at a certain range in this visual waveform + * + * @param sums + * + * The sums to write over our current ones with. + * + * @param dest + * + * Where in this visual waveform these sums should START being written to. + * + * @param offset + * + * Where in the `sums` parameter this should start reading from. Defaults to 0. + * + * @param length + * + * Maximum length of `sums` to overwrite with. + */ void OverwriteSums(const AudioVisualWaveform& sums, const rational& dest, const rational& offset = rational(), const rational &length = rational()); AudioVisualWaveform Mid(const rational& time) const;