C++ API Reference RNBO: RNBO::ParameterEventInterface Class Reference
C++ API

C++ Guides

RNBO: RNBO::ParameterEventInterface Class Reference

#include <RNBO_ParameterEventInterface.h>

Inheritance diagram for RNBO::ParameterEventInterface:
parameter_event_interface RNBO::ParameterInterface

Public Types

enum  Type { SingleProducer, MultiProducer, NotThreadSafe, Trigger }
 

Public Member Functions

virtual void scheduleEvent (EventVariant event)=0
 
void sendMessage (MessageTag tag, number payload, MessageTag objectId=0, MillisecondTime eventTime=RNBOTimeNow)
 
void sendMessage (MessageTag tag, UniqueListPtr payload, MessageTag objectId=0, MillisecondTime eventTime=RNBOTimeNow)
 
void sendMessage (MessageTag tag, MessageTag objectId=0, MillisecondTime eventTime=RNBOTimeNow)
 
virtual void setScheduleCallback (ScheduleCallback callback)
 
- Public Member Functions inherited from RNBO::ParameterInterface
virtual ParameterIndex getNumParameters () const =0
 
virtual ConstCharPointer getParameterName (ParameterIndex index) const =0
 
virtual ConstCharPointer getParameterId (ParameterIndex index) const =0
 
virtual void getParameterInfo (ParameterIndex index, ParameterInfo *info) const =0
 
virtual ParameterValue getParameterValue (ParameterIndex index)=0
 
virtual void setParameterValue (ParameterIndex index, ParameterValue value, MillisecondTime time=RNBOTimeNow)=0
 
virtual ParameterValue getParameterNormalized (ParameterIndex index)
 
virtual void setParameterValueNormalized (ParameterIndex index, ParameterValue normalizedValue, MillisecondTime time=RNBOTimeNow)
 
virtual ParameterValue convertToNormalizedParameterValue (ParameterIndex index, ParameterValue value) const =0
 
virtual ParameterValue convertFromNormalizedParameterValue (ParameterIndex index, ParameterValue normalizedValue) const =0
 
virtual ParameterValue constrainParameterValue (ParameterIndex, ParameterValue value) const
 

Friends

class EventHandler
 

Detailed Description

The ParameterEventInterface is a lightweight interface class that can be handed around to send and receive parameter values and events. It could be used, for example, by a secondary UI or by a class that controls an external MIDI controller.

Member Enumeration Documentation

◆ Type

enum RNBO::ParameterEventInterface::Type
Enumerator
SingleProducer 

a single thread queues parameter values for the audio thread

MultiProducer 

multiple threads queue parameter values for the audio thread

NotThreadSafe 

no queue – good for special purposes when you know what you are doing (for example, in a single threaded application with the SIMPLEENGINE flag)

Trigger 

no queue – will trigger event processing on each event, for reduced latency (only use if you know what you are doing)

The documentation for this class was generated from the following file: