CarlaEngineClient Class Reference

#include <CarlaEngine.hpp>

Public Member Functions
virtual	~CarlaEngineClient () noexcept
virtual void	activate () noexcept
virtual void	deactivate (bool willClose) noexcept
virtual bool	isActive () const noexcept
virtual bool	isOk () const noexcept
virtual uint32_t	getLatency () const noexcept
virtual void	setLatency (uint32_t samples) noexcept
virtual CarlaEnginePort *	addPort (EnginePortType portType, const char *name, bool isInput, uint32_t indexOffset)
virtual bool	removePort (EnginePortType portType, const char *name, bool isInput)
virtual CarlaEngineCVSourcePorts *	createCVSourcePorts ()
const CarlaEngine &	getEngine () const noexcept
EngineProcessMode	getProcessMode () const noexcept
uint	getPortCount (EnginePortType portType, bool isInput) const noexcept
const char *	getAudioPortName (bool isInput, uint index) const noexcept
const char *	getCVPortName (bool isInput, uint index) const noexcept
const char *	getEventPortName (bool isInput, uint index) const noexcept

Detailed Description

Carla Engine Client. Each plugin requires one client from the engine (created via CarlaEngine::addClient()).

Note

This is a virtual class, some engine types provide custom functionality.

Constructor & Destructor Documentation

~CarlaEngineClient()

virtual CarlaEngineClient::~CarlaEngineClient ( )

virtualnoexcept

The destructor.

Member Function Documentation

activate()

virtual void CarlaEngineClient::activate ( )

virtualnoexcept

Activate this client. Client must be deactivated before calling this function.

deactivate()

virtual void CarlaEngineClient::deactivate ( bool  willClose )

virtualnoexcept

Deactivate this client. Client must be activated before calling this function.

isActive()

virtual bool CarlaEngineClient::isActive ( ) const

virtualnoexcept

Check if the client is activated.

isOk()

virtual bool CarlaEngineClient::isOk ( ) const

virtualnoexcept

Check if the client is ok. Plugins will refuse to instantiate if this returns false.

Note

This is always true in rack and patchbay processing modes.

getLatency()

virtual uint32_t CarlaEngineClient::getLatency ( ) const

virtualnoexcept

Get the current latency, in samples.

setLatency()

virtual void CarlaEngineClient::setLatency ( uint32_t  samples )

virtualnoexcept

Change the client's latency.

addPort()

virtual CarlaEnginePort* CarlaEngineClient::addPort ( EnginePortType  portType, const char *  name, bool  isInput, uint32_t  indexOffset  )

virtual

Add a new port of type portType.

Note

This function does nothing in rack processing mode since ports are static there.

removePort()

virtual bool CarlaEngineClient::removePort ( EnginePortType  portType, const char *  name, bool  isInput  )

virtual

Remove a previously added port via addPort().

createCVSourcePorts()

virtual CarlaEngineCVSourcePorts* CarlaEngineClient::createCVSourcePorts ( )

virtual

Create an instance of CV source ports. Must be called only once per client.

getEngine()

const CarlaEngine& CarlaEngineClient::getEngine ( ) const

noexcept

Get this client's engine.

getProcessMode()

EngineProcessMode CarlaEngineClient::getProcessMode ( ) const

noexcept

Get the engine's process mode.

getPortCount()

uint CarlaEngineClient::getPortCount ( EnginePortType  portType, bool  isInput  ) const

noexcept

Get port count for a type and mode.

getAudioPortName()

const char* CarlaEngineClient::getAudioPortName ( bool  isInput, uint  index  ) const

noexcept

Get an audio port name.

getCVPortName()

const char* CarlaEngineClient::getCVPortName ( bool  isInput, uint  index  ) const

noexcept

Get a CV port name.

getEventPortName()

const char* CarlaEngineClient::getEventPortName ( bool  isInput, uint  index  ) const

noexcept

Get an event port name.

---

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

• CarlaEngine.hpp