engine::ExternalControllerManager Class Reference

Keeps a list of external controllers and keeps them connected to the right MIDI in/out devices. More...

#include <tracktion_ExternalControllerManager.h>

Inherits juce::ChangeBroadcaster, juce::ChangeListener, and juce::Timer.

Public Types
enum	Protocol { midi , osc }

Public Member Functions
	~ExternalControllerManager () override
void	initialise ()
void	shutdown ()
void	setCurrentEdit (Edit *, SelectionManager *)
void	detachFromEdit (Edit *)
void	detachFromSelectionManager (SelectionManager *)
bool	isAttachedToEdit (const Edit *) const noexcept
bool	isAttachedToEdit (const Edit &) const noexcept
SelectionManager *	getSelectionManager () const noexcept
const juce::OwnedArray< ExternalController > &	getControllers () const noexcept
juce::StringArray	getAllControllerNames ()
ExternalController *	getActiveCustomController ()
void	midiInOutDevicesChanged ()
bool	createCustomController (const juce::String &name, Protocol)
ExternalController *	addController (ControlSurface *)
void	deleteController (ExternalController *)
void	moveFader (int channelNum, float newSliderPos)
void	moveMasterFader (float newPos)
void	movePanPot (int channelNum, float newPan)
void	moveMasterPanPot (float newPan)
void	playStateChanged (bool isPlaying)
void	recordStateChanged (bool isRecording)
void	automationModeChanged (bool isReading, bool isWriting)
void	channelLevelChanged (int channel, std::span< const float > levels)
void	masterLevelsChanged (std::span< const float > levels)
void	timecodeChanged (int barsOrHours, int beatsOrMinutes, int ticksOrSeconds, int millisecs, bool isBarsBeats, bool isFrames)
void	editPositionChanged (Edit *, TimePosition newCursorPosition)
void	updateVolumePlugin (VolumeAndPanPlugin &)
void	updateVCAPlugin (VCAPlugin &vca)
void	snapChanged (bool isOn)
void	loopChanged (bool isOn)
void	clickChanged (bool isOn)
void	auxSendLevelsChanged ()
void	updateMuteSoloLights (bool onlyUpdateFlashingLights)
void	soloCountChanged (bool)
void	changeListenerCallback (ChangeBroadcaster *) override
bool	shouldTrackBeColoured (int channelNum)
juce::Colour	getTrackColour (int channelNum)
std::vector< ColourArea >	getColouredArea (const Edit &)
bool	shouldPluginBeColoured (Plugin *)
juce::Colour	getPluginColour (Plugin *)
void	updateAllDevices ()
void	updateParameters ()
void	updateMarkers ()
void	updateTrackRecordLights ()
void	updatePunchLights ()
void	updateScrollLights ()
void	updateUndoLights ()
void	updatePadColours ()
int	getNumChannelTracks () const
Track *	getChannelTrack (int channel) const
int	mapTrackNumToChannelNum (int channelNum) const
int	getXTCount (const juce::String &controller)
void	setXTCount (const juce::String &controller, int)
void	refreshXTOrder ()
void	userTouchedFader (int channelNum, bool touch)
void	userTouchedPanPot (int channelNum, bool touch)
void	userTouchedMasterLevelFader (bool touch)
void	userTouchedMasterPanPot (bool touch)
void	userTouchedAux (int channelNum, int auxNum, AuxPosition ap, bool touch)
void	userTouchedQuickParam (bool touch)
void	userMovedFader (int channelNum, float newSliderPos, bool delta)
void	userMovedMasterFader (Edit *, float newLevel, bool delta)
void	userMovedMasterPanPot (Edit *, float newLevel, bool delta)
void	userMovedPanPot (int channelNum, float newPan, bool delta)
void	userPressedSolo (int channelNum)
void	userPressedSoloIsolate (int channelNum)
void	userPressedMute (int channelNum, bool muteVolumeControl)
void	userSelectedTrack (int channelNum)
void	userSelectedOneTrack (int channelNum)
void	userSelectedClipInTrack (int channelNum)
void	userSelectedPluginInTrack (int channelNum)
void	userMovedAux (int channelNum, int auxNum, AuxPosition ap, float newPosition, bool delta)
void	userPressedAux (int channelNum, int auxNum)
void	userMovedQuickParam (float newLevel)
void	userLaunchedClip (int channelNum, int clip, bool press)
void	userStoppedClip (int channelNum, bool press)
void	userLaunchedScene (int scene, bool press)
void	updateDeviceState ()
void	repaintTrack (int channelNum)
void	repaintPlugin (Plugin &)
void	repaintSlots (int channelNum)

Public Attributes
std::function< bool(const Track &)>	isVisibleOnControlSurface
	Callback that can be set to determine if a track is visible on a controller or not.
std::function< int(Edit &, int)>	mapEditTrackNumToControlSurfaceChannelNum
	Optional callback that can be set to map an Edit track number to a control surface channel number.
std::function< void(FolderTrack &, bool)>	setFolderTrackOpen
	Callback that can be set allow surfaces to open/close folders.
std::function< bool(FolderTrack &)>	isFolderTrackOpen
	Callback that can be set allow surfaces to show the open/close status of folders.
std::function< void(Edit &, bool)>	setScrollingEnabled
	Callback that can be set allow surfaces to set the scroll status of an Edit.
std::function< bool(Edit &)>	isScrollingEnabled
	Callback that can be set allow surfaces to show the scroll status of an Edit.
std::function< void(Edit &, Track &, int, bool)>	launchClip
	Launch clip by track and index.
std::function< void(Edit &, Track *, bool)>	stopClip
	Stop all clips on track.
std::function< void(Edit &, int, bool)>	launchScene
	Launch scene by index.
Engine &	engine

Detailed Description

Keeps a list of external controllers and keeps them connected to the right MIDI in/out devices.

Member Enumeration Documentation

Protocol

enum engine::ExternalControllerManager::Protocol

Enumerator
midi
osc

Constructor & Destructor Documentation

~ExternalControllerManager()

engine::ExternalControllerManager::~ExternalControllerManager ( )

override

Member Function Documentation

initialise()

void engine::ExternalControllerManager::initialise

(

)

shutdown()

void engine::ExternalControllerManager::shutdown

(

)

setCurrentEdit()

void engine::ExternalControllerManager::setCurrentEdit	(	Edit *	,
		SelectionManager *
	)

detachFromEdit()

void engine::ExternalControllerManager::detachFromEdit

(

Edit *

)

detachFromSelectionManager()

void engine::ExternalControllerManager::detachFromSelectionManager

(

SelectionManager *

)

isAttachedToEdit() [1/2]

bool engine::ExternalControllerManager::isAttachedToEdit ( const Edit *  ) const

noexcept

isAttachedToEdit() [2/2]

bool engine::ExternalControllerManager::isAttachedToEdit ( const Edit &  ) const

noexcept

getSelectionManager()

SelectionManager * engine::ExternalControllerManager::getSelectionManager ( ) const

noexcept

getControllers()

const juce::OwnedArray< ExternalController > & engine::ExternalControllerManager::getControllers ( ) const

noexcept

getAllControllerNames()

juce::StringArray engine::ExternalControllerManager::getAllControllerNames

(

)

getActiveCustomController()

ExternalController * engine::ExternalControllerManager::getActiveCustomController

(

)

midiInOutDevicesChanged()

void engine::ExternalControllerManager::midiInOutDevicesChanged

(

)

createCustomController()

bool engine::ExternalControllerManager::createCustomController	(	const juce::String &	name,
		Protocol
	)

addController()

ExternalController * engine::ExternalControllerManager::addController

(

ControlSurface *

)

deleteController()

void engine::ExternalControllerManager::deleteController

(

ExternalController *

)

moveFader()

void engine::ExternalControllerManager::moveFader	(	int	channelNum,
		float	newSliderPos
	)

moveMasterFader()

void engine::ExternalControllerManager::moveMasterFader

(

float

newPos

)

movePanPot()

void engine::ExternalControllerManager::movePanPot	(	int	channelNum,
		float	newPan
	)

moveMasterPanPot()

void engine::ExternalControllerManager::moveMasterPanPot

(

float

newPan

)

playStateChanged()

void engine::ExternalControllerManager::playStateChanged

(

bool

isPlaying

)

recordStateChanged()

void engine::ExternalControllerManager::recordStateChanged

(

bool

isRecording

)

automationModeChanged()

void engine::ExternalControllerManager::automationModeChanged	(	bool	isReading,
		bool	isWriting
	)

channelLevelChanged()

void engine::ExternalControllerManager::channelLevelChanged	(	int	channel,
		std::span< const float >	levels
	)

masterLevelsChanged()

void engine::ExternalControllerManager::masterLevelsChanged

(

std::span< const float >

levels

)

timecodeChanged()

void engine::ExternalControllerManager::timecodeChanged	(	int	barsOrHours,
		int	beatsOrMinutes,
		int	ticksOrSeconds,
		int	millisecs,
		bool	isBarsBeats,
		bool	isFrames
	)

editPositionChanged()

void engine::ExternalControllerManager::editPositionChanged	(	Edit *	,
		TimePosition	newCursorPosition
	)

updateVolumePlugin()

void engine::ExternalControllerManager::updateVolumePlugin

(

VolumeAndPanPlugin &

)

updateVCAPlugin()

void engine::ExternalControllerManager::updateVCAPlugin

(

VCAPlugin &

vca

)

snapChanged()

void engine::ExternalControllerManager::snapChanged

(

bool

isOn

)

loopChanged()

void engine::ExternalControllerManager::loopChanged

(

bool

isOn

)

clickChanged()

void engine::ExternalControllerManager::clickChanged

(

bool

isOn

)

auxSendLevelsChanged()

void engine::ExternalControllerManager::auxSendLevelsChanged

(

)

updateMuteSoloLights()

void engine::ExternalControllerManager::updateMuteSoloLights

(

bool

onlyUpdateFlashingLights

)

soloCountChanged()

void engine::ExternalControllerManager::soloCountChanged

(

bool

)

changeListenerCallback()

void engine::ExternalControllerManager::changeListenerCallback ( ChangeBroadcaster *  )

override

shouldTrackBeColoured()

bool engine::ExternalControllerManager::shouldTrackBeColoured

(

int

channelNum

)

getTrackColour()

juce::Colour engine::ExternalControllerManager::getTrackColour

(

int

channelNum

)

getColouredArea()

std::vector< ColourArea > engine::ExternalControllerManager::getColouredArea

(

const Edit &

)

shouldPluginBeColoured()

bool engine::ExternalControllerManager::shouldPluginBeColoured

(

Plugin *

)

getPluginColour()

juce::Colour engine::ExternalControllerManager::getPluginColour

(

Plugin *

)

updateAllDevices()

void engine::ExternalControllerManager::updateAllDevices

(

)

updateParameters()

void engine::ExternalControllerManager::updateParameters

(

)

updateMarkers()

void engine::ExternalControllerManager::updateMarkers

(

)

updateTrackRecordLights()

void engine::ExternalControllerManager::updateTrackRecordLights

(

)

updatePunchLights()

void engine::ExternalControllerManager::updatePunchLights

(

)

updateScrollLights()

void engine::ExternalControllerManager::updateScrollLights

(

)

updateUndoLights()

void engine::ExternalControllerManager::updateUndoLights

(

)

updatePadColours()

void engine::ExternalControllerManager::updatePadColours

(

)

getNumChannelTracks()

int engine::ExternalControllerManager::getNumChannelTracks

(

)

const

getChannelTrack()

Track * engine::ExternalControllerManager::getChannelTrack

(

int

channel

)

const

mapTrackNumToChannelNum()

int engine::ExternalControllerManager::mapTrackNumToChannelNum

(

int

channelNum

)

const

getXTCount()

int engine::ExternalControllerManager::getXTCount

(

const juce::String &

controller

)

setXTCount()

void engine::ExternalControllerManager::setXTCount	(	const juce::String &	controller,
		int
	)

refreshXTOrder()

void engine::ExternalControllerManager::refreshXTOrder

(

)

userTouchedFader()

void engine::ExternalControllerManager::userTouchedFader	(	int	channelNum,
		bool	touch
	)

userTouchedPanPot()

void engine::ExternalControllerManager::userTouchedPanPot	(	int	channelNum,
		bool	touch
	)

userTouchedMasterLevelFader()

void engine::ExternalControllerManager::userTouchedMasterLevelFader

(

bool

touch

)

userTouchedMasterPanPot()

void engine::ExternalControllerManager::userTouchedMasterPanPot

(

bool

touch

)

userTouchedAux()

void engine::ExternalControllerManager::userTouchedAux	(	int	channelNum,
		int	auxNum,
		AuxPosition	ap,
		bool	touch
	)

userTouchedQuickParam()

void engine::ExternalControllerManager::userTouchedQuickParam

(

bool

touch

)

userMovedFader()

void engine::ExternalControllerManager::userMovedFader	(	int	channelNum,
		float	newSliderPos,
		bool	delta
	)

userMovedMasterFader()

void engine::ExternalControllerManager::userMovedMasterFader	(	Edit *	,
		float	newLevel,
		bool	delta
	)

userMovedMasterPanPot()

void engine::ExternalControllerManager::userMovedMasterPanPot	(	Edit *	,
		float	newLevel,
		bool	delta
	)

userMovedPanPot()

void engine::ExternalControllerManager::userMovedPanPot	(	int	channelNum,
		float	newPan,
		bool	delta
	)

userPressedSolo()

void engine::ExternalControllerManager::userPressedSolo

(

int

channelNum

)

userPressedSoloIsolate()

void engine::ExternalControllerManager::userPressedSoloIsolate

(

int

channelNum

)

userPressedMute()

void engine::ExternalControllerManager::userPressedMute	(	int	channelNum,
		bool	muteVolumeControl
	)

userSelectedTrack()

void engine::ExternalControllerManager::userSelectedTrack

(

int

channelNum

)

userSelectedOneTrack()

void engine::ExternalControllerManager::userSelectedOneTrack

(

int

channelNum

)

userSelectedClipInTrack()

void engine::ExternalControllerManager::userSelectedClipInTrack

(

int

channelNum

)

userSelectedPluginInTrack()

void engine::ExternalControllerManager::userSelectedPluginInTrack

(

int

channelNum

)

userMovedAux()

void engine::ExternalControllerManager::userMovedAux	(	int	channelNum,
		int	auxNum,
		AuxPosition	ap,
		float	newPosition,
		bool	delta
	)

userPressedAux()

void engine::ExternalControllerManager::userPressedAux	(	int	channelNum,
		int	auxNum
	)

userMovedQuickParam()

void engine::ExternalControllerManager::userMovedQuickParam

(

float

newLevel

)

userLaunchedClip()

void engine::ExternalControllerManager::userLaunchedClip	(	int	channelNum,
		int	clip,
		bool	press
	)

userStoppedClip()

void engine::ExternalControllerManager::userStoppedClip	(	int	channelNum,
		bool	press
	)

userLaunchedScene()

void engine::ExternalControllerManager::userLaunchedScene	(	int	scene,
		bool	press
	)

updateDeviceState()

void engine::ExternalControllerManager::updateDeviceState

(

)

repaintTrack()

void engine::ExternalControllerManager::repaintTrack

(

int

channelNum

)

repaintPlugin()

void engine::ExternalControllerManager::repaintPlugin

(

Plugin &

)

repaintSlots()

void engine::ExternalControllerManager::repaintSlots

(

int

channelNum

)

Member Data Documentation

isVisibleOnControlSurface

std::function<bool (const Track&)> engine::ExternalControllerManager::isVisibleOnControlSurface

Callback that can be set to determine if a track is visible on a controller or not.

mapEditTrackNumToControlSurfaceChannelNum

std::function<int (Edit&, int)> engine::ExternalControllerManager::mapEditTrackNumToControlSurfaceChannelNum

Optional callback that can be set to map an Edit track number to a control surface channel number.

If this isn't set, the manager will iterate the tracks to find the mapping. This can be slow however so this function can be used to create your own cache and speed up the process.

setFolderTrackOpen

std::function<void (FolderTrack&, bool)> engine::ExternalControllerManager::setFolderTrackOpen

Callback that can be set allow surfaces to open/close folders.

isFolderTrackOpen

std::function<bool (FolderTrack&)> engine::ExternalControllerManager::isFolderTrackOpen

Callback that can be set allow surfaces to show the open/close status of folders.

setScrollingEnabled

std::function<void (Edit&, bool)> engine::ExternalControllerManager::setScrollingEnabled

Callback that can be set allow surfaces to set the scroll status of an Edit.

isScrollingEnabled

std::function<bool (Edit&)> engine::ExternalControllerManager::isScrollingEnabled

Callback that can be set allow surfaces to show the scroll status of an Edit.

launchClip

std::function<void (Edit&, Track&, int, bool)> engine::ExternalControllerManager::launchClip

Launch clip by track and index.

stopClip

std::function<void (Edit&, Track*, bool)> engine::ExternalControllerManager::stopClip

Stop all clips on track.

If track is nullptr, stop all tracks

launchScene

std::function<void (Edit&, int, bool)> engine::ExternalControllerManager::launchScene

Launch scene by index.

engine

Engine& engine::ExternalControllerManager::engine

---

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

• tracktion_ExternalControllerManager.h