CarlaEngineEventPort Class Reference

#include <CarlaEngine.hpp>

Inheritance diagram for CarlaEngineEventPort:

Public Member Functions
	CarlaEngineEventPort (const CarlaEngineClient &client, bool isInputPort, uint32_t indexOffset) noexcept
	~CarlaEngineEventPort () noexcept override
EnginePortType	getType () const noexcept final
void	initBuffer () noexcept override
virtual uint32_t	getEventCount () const noexcept
virtual EngineEvent &	getEvent (uint32_t index) const noexcept
virtual EngineEvent &	getEventUnchecked (uint32_t index) const noexcept
bool	writeControlEvent (uint32_t time, uint8_t channel, const EngineControlEvent &ctrl) noexcept
virtual bool	writeControlEvent (uint32_t time, uint8_t channel, EngineControlEventType type, uint16_t param, int8_t midiValue, float normalizedValue) noexcept
bool	writeMidiEvent (uint32_t time, uint8_t size, const uint8_t *data) noexcept
bool	writeMidiEvent (uint32_t time, uint8_t channel, const EngineMidiEvent &midi) noexcept
virtual bool	writeMidiEvent (uint32_t time, uint8_t channel, uint8_t size, const uint8_t *data) noexcept
Public Member Functions inherited from CarlaEnginePort
virtual	~CarlaEnginePort () noexcept
bool	isInput () const noexcept
uint32_t	getIndexOffset () const noexcept
const CarlaEngineClient &	getEngineClient () const noexcept
virtual void	setMetaData (const char *key, const char *value, const char *type)

Additional Inherited Members
Protected Member Functions inherited from CarlaEnginePort
	CarlaEnginePort (const CarlaEngineClient &client, bool isInputPort, uint32_t indexOffset) noexcept

Detailed Description

Carla Engine Event port.

Constructor & Destructor Documentation

CarlaEngineEventPort()

CarlaEngineEventPort::CarlaEngineEventPort ( const CarlaEngineClient &  client, bool  isInputPort, uint32_t  indexOffset  )

noexcept

The constructor. All constructor parameters are constant and will never change in the lifetime of the port.

~CarlaEngineEventPort()

CarlaEngineEventPort::~CarlaEngineEventPort ( )

overridenoexcept

The destructor.

Member Function Documentation

getType()

EnginePortType CarlaEngineEventPort::getType ( ) const

inlinefinalvirtualnoexcept

Get the type of the port, in this case kEnginePortTypeEvent.

Implements CarlaEnginePort.

initBuffer()

void CarlaEngineEventPort::initBuffer ( )

overridevirtualnoexcept

Initialize the port's internal buffer for engine.

Implements CarlaEnginePort.

getEventCount()

virtual uint32_t CarlaEngineEventPort::getEventCount ( ) const

virtualnoexcept

Get the number of events present in the buffer.

Note

You must only call this for input ports.

getEvent()

virtual EngineEvent& CarlaEngineEventPort::getEvent ( uint32_t  index ) const

virtualnoexcept

Get the event at index.

Note

You must only call this for input ports.

getEventUnchecked()

virtual EngineEvent& CarlaEngineEventPort::getEventUnchecked ( uint32_t  index ) const

virtualnoexcept

Get the event at index, faster unchecked version.

writeControlEvent() [1/2]

bool CarlaEngineEventPort::writeControlEvent ( uint32_t  time, uint8_t  channel, const EngineControlEvent &  ctrl  )

noexcept

Write a control event into the buffer.

Note

You must only call this for output ports.

writeControlEvent() [2/2]

virtual bool CarlaEngineEventPort::writeControlEvent ( uint32_t  time, uint8_t  channel, EngineControlEventType  type, uint16_t  param, int8_t  midiValue, float  normalizedValue  )

virtualnoexcept

Write a control event into the buffer. Arguments are the same as in the EngineControlEvent struct.

Note

You must only call this for output ports.

writeMidiEvent() [1/3]

bool CarlaEngineEventPort::writeMidiEvent ( uint32_t  time, uint8_t  size, const uint8_t *  data  )

noexcept

Write a MIDI event into the buffer.

Note

You must only call this for output ports.

writeMidiEvent() [2/3]

bool CarlaEngineEventPort::writeMidiEvent ( uint32_t  time, uint8_t  channel, const EngineMidiEvent &  midi  )

noexcept

Write a MIDI event into the buffer.

Note

You must only call this for output ports.

writeMidiEvent() [3/3]

virtual bool CarlaEngineEventPort::writeMidiEvent ( uint32_t  time, uint8_t  channel, uint8_t  size, const uint8_t *  data  )

virtualnoexcept

Write a MIDI event into the buffer. Arguments are the same as in the EngineMidiEvent struct.

Note

You must only call this for output ports.

---

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

• CarlaEngine.hpp