Carla Engine API

Classes
struct	EngineControlEvent
struct	EngineMidiEvent
struct	EngineEvent
struct	EngineOptions
struct	EngineTimeInfoBBT
struct	EngineTimeInfo
class	CarlaEnginePort
class	CarlaEngineAudioPort
class	CarlaEngineCVPort
class	CarlaEngineEventPort
class	CarlaEngineCVSourcePorts
class	CarlaEngineClient
class	CarlaEngine

Enumerations
enum	EngineType {   kEngineTypeNull = 0 , kEngineTypeJack = 1 , kEngineTypeJuce = 2 , kEngineTypeRtAudio = 3 ,   kEngineTypeSDL = 4 , kEngineTypePlugin = 5 , kEngineTypeBridge = 6 , kEngineTypeDummy = 7 }
enum	EnginePortType { kEnginePortTypeNull = 0 , kEnginePortTypeAudio = 1 , kEnginePortTypeCV = 2 , kEnginePortTypeEvent = 3 }
enum	EngineEventType { kEngineEventTypeNull = 0 , kEngineEventTypeControl = 1 , kEngineEventTypeMidi = 2 }
enum	EngineControlEventType {   kEngineControlEventTypeNull = 0 , kEngineControlEventTypeParameter = 1 , kEngineControlEventTypeMidiBank = 2 , kEngineControlEventTypeMidiProgram = 3 ,   kEngineControlEventTypeAllSoundOff = 4 , kEngineControlEventTypeAllNotesOff = 5 }

Variables
static const uint8_t	kEngineEventNonMidiChannel = 0x30

Detailed Description

The Carla Engine API.

Enumeration Type Documentation

EngineType

enum EngineType

The type of an engine.

Enumerator
kEngineTypeNull	Null engine type.
kEngineTypeJack	JACK engine type. Provides all processing modes.
kEngineTypeJuce	JUCE engine type, used to provide Native Audio and MIDI support.
kEngineTypeRtAudio	RtAudio engine type, used to provide Native Audio and MIDI support.
kEngineTypeSDL	SDL engine type, used to provide Native Audio support.
kEngineTypePlugin	Plugin engine type, used to export the engine as a plugin.
kEngineTypeBridge	Bridge engine type, used in BridgePlugin class.
kEngineTypeDummy	Dummy engine type, does not send audio or MIDI anywhere.

EnginePortType

enum EnginePortType

The type of an engine port.

Enumerator
kEnginePortTypeNull	Null port type.
kEnginePortTypeAudio	Audio port type. See also CarlaEngineAudioPort
kEnginePortTypeCV	CV port type. See also CarlaEngineCVPort
kEnginePortTypeEvent	Event port type (Control or MIDI). See also CarlaEngineEventPort

EngineEventType

enum EngineEventType

The type of an engine event.

Enumerator
kEngineEventTypeNull	Null port type.
kEngineEventTypeControl	Control event type. See also EngineControlEvent
kEngineEventTypeMidi	MIDI event type. See also EngineMidiEvent

EngineControlEventType

enum EngineControlEventType

The type of an engine control event.

Enumerator
kEngineControlEventTypeNull	Null event type.
kEngineControlEventTypeParameter	Parameter event type. Note Value uses a normalized range of 0.0f<->1.0f.
kEngineControlEventTypeMidiBank	MIDI Bank event type.
kEngineControlEventTypeMidiProgram	MIDI Program change event type.
kEngineControlEventTypeAllSoundOff	All sound off event type.
kEngineControlEventTypeAllNotesOff	All notes off event type.

Variable Documentation

kEngineEventNonMidiChannel

const uint8_t kEngineEventNonMidiChannel = 0x30

static

Special value for EngineEvent channel field, indicating a non-midi parameter event.