IPeakSender is a utility class which can be used to defer peak data from sample buffers for sending to the GUI It sends the average peak value over a certain time window. More...
#include <ISender.h>
Inheritance diagram for IPeakSender< MAXNC, QUEUE_SIZE >:
Public Member Functions | |
| IPeakSender (double minThresholdDb=-90., float windowSizeMs=5.0f) | |
| void | Reset (double sampleRate) |
| void | SetWindowSizeMs (double timeMs, double sampleRate) |
| void | ProcessBlock (sample **inputs, int nFrames, int ctrlTag=kNoTag, int nChans=MAXNC, int chanOffset=0) |
| Queue peaks from sample buffers into the sender This can be called on the realtime audio thread. More... | |
 Public Member Functions inherited from ISender< MAXNC, QUEUE_SIZE, T > | |
| void | PushData (const ISenderData< MAXNC, T > &d) |
| Pushes a data element onto the queue. More... | |
| virtual void | PrepareDataForUI (ISenderData< MAXNC, T > &d) |
| This is called on the main thread and can be used to transform the data, e.g. More... | |
| void | TransmitData (IEditorDelegate &dlg) |
| Pops elements off the queue and sends messages to controls. More... | |
| void | TransmitDataToControlsWithTags (IEditorDelegate &dlg, const std::initializer_list< int > &ctrlTags) |
| This variation can be used if you need to supply multiple controls with the same ISenderData, overriding the tags in the data packet. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from ISender< MAXNC, QUEUE_SIZE, T > | |
| static constexpr int | kUpdateMessage = 0 |
Detailed Description
template<int MAXNC = 1, int QUEUE_SIZE = 64>
class IPeakSender< MAXNC, QUEUE_SIZE >
class IPeakSender< MAXNC, QUEUE_SIZE >
IPeakSender is a utility class which can be used to defer peak data from sample buffers for sending to the GUI It sends the average peak value over a certain time window.
Constructor & Destructor Documentation
◆ IPeakSender()
template<int MAXNC = 1, int QUEUE_SIZE = 64>
|
inline |
Member Function Documentation
◆ ProcessBlock()
template<int MAXNC = 1, int QUEUE_SIZE = 64>
|
inline |
Queue peaks from sample buffers into the sender This can be called on the realtime audio thread.
- Parameters
-
inputs the sample buffers to analyze nFrames the number of sample frames in the input buffers ctrlTag a control tag to indicate which control to send the buffers to. Note: if you don't supply the control tag here, you must use TransmitDataToControlsWithTags() and specify one or more tags there nChans the number of channels of data that should be sent chanOffset the starting channel
Definition at line 147 of file ISender.h.
References ISender< MAXNC, QUEUE_SIZE, T >::PushData().
◆ Reset()
template<int MAXNC = 1, int QUEUE_SIZE = 64>
|
inline |
◆ SetWindowSizeMs()
template<int MAXNC = 1, int QUEUE_SIZE = 64>
|
inline |
The documentation for this class was generated from the following file:
