IBufferSender is a utility class which can be used to defer buffer data for sending to the GUI. More...
#include <ISender.h>
Inheritance diagram for IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >:
Public Types | |
| using | TDataPacket = std::array< float, MAXBUF > |
| using | TSender = ISender< MAXNC, QUEUE_SIZE, TDataPacket > |
Public Member Functions | |
| IBufferSender (double minThresholdDb=-90., int bufferSize=MAXBUF) | |
| void | ProcessBlock (sample **inputs, int nFrames, int ctrlTag=kNoTag, int nChans=MAXNC, int chanOffset=0) |
| Queue sample buffers into the sender, checking the data is over the required threshold. More... | |
| void | SetBufferSize (int bufferSize) |
| int | GetBufferSize () const |
 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... | |
Public Attributes | |
| const double | kNoThresholdDb = -100 |
Additional Inherited Members | |
| Static Public Attributes inherited from ISender< MAXNC, QUEUE_SIZE, T > | |
| static constexpr int | kUpdateMessage = 0 |
| Protected Attributes inherited from ISender< MAXNC, QUEUE_SIZE, T > | |
| IPlugQueue< ISenderData< MAXNC, T > > | mQueue {QUEUE_SIZE} |
Detailed Description
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
class IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >
class IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >
IBufferSender is a utility class which can be used to defer buffer data for sending to the GUI.
Member Typedef Documentation
◆ TDataPacket
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
| using IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >::TDataPacket = std::array<float, MAXBUF> |
◆ TSender
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
| using IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >::TSender = ISender<MAXNC, QUEUE_SIZE, TDataPacket> |
Constructor & Destructor Documentation
◆ IBufferSender()
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
|
inline |
Member Function Documentation
◆ GetBufferSize()
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
|
inline |
◆ ProcessBlock()
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
|
inline |
Queue sample buffers into the sender, checking the data is over the required threshold.
This can be called on the realtime audio thread.
- Parameters
-
inputs the sample buffers 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 451 of file ISender.h.
References ISender< MAXNC, QUEUE_SIZE, T >::PushData().
◆ SetBufferSize()
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
|
inline |
Member Data Documentation
◆ kNoThresholdDb
template<int MAXNC = 1, int QUEUE_SIZE = 64, int MAXBUF = 128>
| const double IBufferSender< MAXNC, QUEUE_SIZE, MAXBUF >::kNoThresholdDb = -100 |
The documentation for this class was generated from the following file:
