From 40dcba60ab44efc8ac4e9f7ccd2881353655cc1f Mon Sep 17 00:00:00 2001 From: Phil Schatzmann Date: Thu, 14 Sep 2023 02:53:20 +0200 Subject: [PATCH] OutputMixer doxygen comments --- src/AudioTools/AudioOutput.h | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/AudioTools/AudioOutput.h b/src/AudioTools/AudioOutput.h index 31539897ba..288d9dc7ed 100644 --- a/src/AudioTools/AudioOutput.h +++ b/src/AudioTools/AudioOutput.h @@ -313,8 +313,7 @@ template class OutputMixer : public Print { update_total_weights(); } - /// Defines a new weight for the indicated channel: If you set it to 0 it is - /// muted. + /// Defines a new weight for the indicated channel: If you set it to 0.0 it is muted. The initial value is 1.0 void setWeight(int channel, float weight) { if (channel < size()) { weights[channel] = weight; @@ -324,6 +323,7 @@ template class OutputMixer : public Print { update_total_weights(); } + /// Starts the processing. bool begin(int copy_buffer_size_bytes = DEFAULT_BUFFER_SIZE, MemoryType memoryType = PS_RAM) { is_active = true; @@ -347,8 +347,7 @@ template class OutputMixer : public Print { size_t write(uint8_t) override { return 0; } - /// Write the data from a simgle stream which will be mixed together (the - /// stream idx is increased) + /// Write the data from a simgle stream which will be mixed together (the stream idx is increased) size_t write(const uint8_t *buffer_c, size_t bytes) override { size_t result = write(stream_idx, buffer_c, bytes); // after writing the last stream we flush