CarlaEnginePort Class Reference

#include <CarlaEngine.hpp>

Inheritance diagram for CarlaEnginePort:

Public Member Functions
virtual	~CarlaEnginePort () noexcept
virtual EnginePortType	getType () const noexcept=0
virtual void	initBuffer () noexcept=0
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)

Protected Member Functions
	CarlaEnginePort (const CarlaEngineClient &client, bool isInputPort, uint32_t indexOffset) noexcept

Detailed Description

Carla Engine port (Abstract). This is the base class for all Carla Engine ports.

Constructor & Destructor Documentation

CarlaEnginePort()

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

protectednoexcept

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

~CarlaEnginePort()

virtual CarlaEnginePort::~CarlaEnginePort ( )

virtualnoexcept

The destructor.

Member Function Documentation

getType()

virtual EnginePortType CarlaEnginePort::getType ( ) const

pure virtualnoexcept

Get the type of the port, as provided by the respective subclasses.

Implemented in CarlaEngineEventPort, CarlaEngineCVPort, and CarlaEngineAudioPort.

initBuffer()

virtual void CarlaEnginePort::initBuffer ( )

pure virtualnoexcept

Initialize the port's internal buffer.

Implemented in CarlaEngineEventPort, CarlaEngineCVPort, and CarlaEngineAudioPort.

isInput()

bool CarlaEnginePort::isInput ( ) const

inlinenoexcept

Check if this port is an input.

getIndexOffset()

uint32_t CarlaEnginePort::getIndexOffset ( ) const

inlinenoexcept

Get the index offset as passed in the constructor.

getEngineClient()

const CarlaEngineClient& CarlaEnginePort::getEngineClient ( ) const

inlinenoexcept

Get this ports' engine client.

setMetaData()

virtual void CarlaEnginePort::setMetaData ( const char *  key, const char *  value, const char *  type  )

virtual

Set a meta-data property on this port.

---

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

• CarlaEngine.hpp