tracktion::engine::VirtualMidiInputDevice Class Reference

#include <tracktion_VirtualMidiInputDevice.h>

Inheritance diagram for tracktion::engine::VirtualMidiInputDevice:

Public Member Functions
	VirtualMidiInputDevice (Engine &, juce::String name, DeviceType, juce::String deviceID, bool isAllMIDIIns)
	~VirtualMidiInputDevice () override
InputDeviceInstance *	createInstance (EditPlaybackContext &) override
	Creates an instance to use for a given playback context.
void	handleIncomingMidiMessage (const juce::MidiMessage &, MPESourceID) override
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
void	setEnabled (bool) override
void	loadProps () override
void	saveProps () override
juce::StringArray	getMIDIInputSourceDevices () const
void	setMIDIInputSourceDevices (const juce::StringArray deviceIDs)
void	toggleMIDIInputSourceDevice (const juce::String &deviceID)
void	handleMessageFromPhysicalDevice (PhysicalMidiInputDevice &, const juce::MidiMessage &)
DeviceType	getDeviceType () const override
void	handleIncomingMidiMessage (juce::MidiInput *, const juce::MidiMessage &) override
virtual void	handleIncomingMidiMessage (const juce::MidiMessage &, MPESourceID)=0
Public Member Functions inherited from tracktion::engine::MidiInputDevice
	MidiInputDevice (Engine &, juce::String type, juce::String name, juce::String deviceID)
	~MidiInputDevice () override
bool	isMidi () const override
MidiChannel	getChannelToUse () const noexcept
void	setChannelToUse (int)
int	getProgramToUse () const noexcept
void	setProgramToUse (int)
void	setBankToUse (int)
int	getBankToUse () const
void	setChannelAllowed (int midiChannel, bool)
bool	isChannelAllowed (int midiChannel) const
void	setNoteFilterRange (NoteFilterRange)
NoteFilterRange	getNoteFilterRange () const
void	setOverridingNoteVelocities (bool)
bool	isOverridingNoteVelocities () const
void	setManualAdjustmentMs (double)
double	getManualAdjustmentMs () const
void	setMinimumLengthMs (double)
double	getMinimumLengthMs () const
bool	isMPEDevice () const
	Returns true if the given device is an MPE device and so should always record incoming MIDI to Note Expression.
void	masterTimeUpdate (double time) override
	This is a bit of a hack but allows the time for MIDI devices to be set through the base class interface.
void	connectionStateChanged ()
bool	handleIncomingMessage (juce::MidiMessage &)
	Updates the timestamp of the message and handles sending it out to listeners.
void	addInstance (MidiInputDeviceInstanceBase *)
void	removeInstance (MidiInputDeviceInstanceBase *)
Clip *	addMidiAsTransaction (Edit &, EditItemID targetID, Clip *takeClip, juce::MidiMessageSequence, TimeRange markedRange, MergeMode, MidiChannel)
void	handleIncomingMidiMessage (juce::MidiInput *, const juce::MidiMessage &) override
RetrospectiveMidiBuffer *	getRetrospectiveMidiBuffer () const
void	updateRetrospectiveBufferLength (double length) override
double	getAdjustSecs () const
juce::Array< AudioTrack * >	getDestinationTracks ()
MidiChannel	getMidiChannelFor (int rawChannelNumber) const
MPESourceID	getMPESourceID () const
Public Member Functions inherited from tracktion::engine::InputDevice
	InputDevice (Engine &, juce::String type, juce::String name, juce::String deviceID)
	~InputDevice () override
const juce::String &	getName () const
const juce::String &	getType () const
juce::String	getDeviceID () const
bool	isTrackDevice () const
juce::String	getAlias () const
	the alias is the name shown in the draggable input device components
void	setAlias (const juce::String &newAlias)
virtual bool	isAvailableToEdit () const
bool	isEnabled () const
MonitorMode	getMonitorMode () const
void	setMonitorMode (MonitorMode)
Public Member Functions inherited from tracktion::engine::Selectable
	Selectable ()
virtual	~Selectable ()
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.
virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object.
virtual void	selectableAboutToBeDeleted ()
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
void	addListener (SelectableListener *)
void	removeListener (SelectableListener *)
void	addSelectableListener (SelectableListener *)
void	removeSelectableListener (SelectableListener *)
void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.
void	deselect ()
void	propertiesChanged ()
void	notifyListenersOfDeletion ()
WeakRef	getWeakRef ()

Public Attributes
const bool	useAllInputs = false
Public Attributes inherited from tracktion::engine::MidiInputDevice
bool	mergeRecordings = true
bool	recordingEnabled = true
bool	replaceExistingClips = false
bool	recordToNoteAutomation = false
QuantisationType	quantisation
juce::MidiKeyboardState	keyboardState
Public Attributes inherited from tracktion::engine::InputDevice
Engine &	engine
LevelMeasurer	levelMeasurer
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Additional Inherited Members
Public Types inherited from tracktion::engine::MidiInputDevice
enum class	MergeMode { always , never , optional }
Public Types inherited from tracktion::engine::InputDevice
enum	DeviceType {   waveDevice , trackWaveDevice , physicalMidiDevice , virtualMidiDevice ,   trackMidiDevice }
	enum to allow quick querying of the device type. More...
enum class	MonitorMode { off , automatic , on }
	Enum to describe monitor modes. More...
Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >
Static Public Member Functions inherited from tracktion::engine::InputDevice
static void	setRetrospectiveLock (Engine &, const juce::Array< InputDeviceInstance * > &, bool lock)
Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()
static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.
Protected Member Functions inherited from tracktion::engine::MidiInputDevice
void	handleNoteOn (juce::MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void	handleNoteOff (juce::MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void	timerCallback () override
void	sendNoteOnToMidiKeyListeners (juce::MidiMessage &)
void	loadMidiProps (const juce::XmlElement *)
void	saveMidiProps (juce::XmlElement &)
void	sendMessageToInstances (const juce::MidiMessage &, MPESourceID)
Protected Attributes inherited from tracktion::engine::MidiInputDevice
std::atomic< double >	adjustSecs { 0 }
double	manualAdjustMs = 0
double	minimumLengthMs = 0
bool	overrideNoteVels = false
bool	eventReceivedFromDevice = false
juce::BigInteger	disallowedChannels
MidiChannel	channelToUse
int	programToUse = 0
int	bankToUse = 0
NoteFilterRange	noteFilterRange
MPESourceID	midiSourceID = createUniqueMPESourceID()
std::unique_ptr< NoteDispatcher >	noteDispatcher
std::vector< double >	lastNoteOns
juce::CriticalSection	noteLock
bool	keysDown [128]
bool	keysUp [128]
uint8_t	keyDownVelocities [128]
juce::SharedResourcePointer< MidiKeyChangeDispatcher >	midiKeyChangeDispatcher
juce::CriticalSection	instanceLock
juce::Array< MidiInputDeviceInstanceBase * >	instances
std::unique_ptr< RetrospectiveMidiBuffer >	retrospectiveBuffer
Protected Attributes inherited from tracktion::engine::InputDevice
std::atomic< bool >	enabled { false }
MonitorMode	monitorMode = MonitorMode::automatic
MonitorMode	defaultMonitorMode = MonitorMode::automatic
bool	retrospectiveRecordLock = false

Constructor & Destructor Documentation

VirtualMidiInputDevice()

tracktion::engine::VirtualMidiInputDevice::VirtualMidiInputDevice	(	Engine &	,
		juce::String	name,
		DeviceType	,
		juce::String	deviceID,
		bool	isAllMIDIIns
	)

~VirtualMidiInputDevice()

tracktion::engine::VirtualMidiInputDevice::~VirtualMidiInputDevice ( )

override

Member Function Documentation

createInstance()

InputDeviceInstance * tracktion::engine::VirtualMidiInputDevice::createInstance ( EditPlaybackContext &  )

overridevirtual

Creates an instance to use for a given playback context.

Implements tracktion::engine::InputDevice.

handleIncomingMidiMessage() [1/3]

void tracktion::engine::VirtualMidiInputDevice::handleIncomingMidiMessage ( const juce::MidiMessage &  , MPESourceID    )

overridevirtual

Implements tracktion::engine::MidiInputDevice.

getSelectableDescription()

juce::String tracktion::engine::VirtualMidiInputDevice::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Reimplemented from tracktion::engine::InputDevice.

setEnabled()

void tracktion::engine::VirtualMidiInputDevice::setEnabled ( bool  )

overridevirtual

Reimplemented from tracktion::engine::MidiInputDevice.

loadProps()

void tracktion::engine::VirtualMidiInputDevice::loadProps ( )

overridevirtual

Implements tracktion::engine::MidiInputDevice.

saveProps()

void tracktion::engine::VirtualMidiInputDevice::saveProps ( )

overridevirtual

Implements tracktion::engine::InputDevice.

getMIDIInputSourceDevices()

juce::StringArray tracktion::engine::VirtualMidiInputDevice::getMIDIInputSourceDevices

(

)

const

setMIDIInputSourceDevices()

void tracktion::engine::VirtualMidiInputDevice::setMIDIInputSourceDevices

(

const juce::StringArray

deviceIDs

)

toggleMIDIInputSourceDevice()

void tracktion::engine::VirtualMidiInputDevice::toggleMIDIInputSourceDevice

(

const juce::String &

deviceID

)

handleMessageFromPhysicalDevice()

void tracktion::engine::VirtualMidiInputDevice::handleMessageFromPhysicalDevice	(	PhysicalMidiInputDevice &	,
		const juce::MidiMessage &
	)

getDeviceType()

DeviceType tracktion::engine::VirtualMidiInputDevice::getDeviceType ( ) const

overridevirtual

Implements tracktion::engine::InputDevice.

handleIncomingMidiMessage() [2/3]

void tracktion::engine::MidiInputDevice::handleIncomingMidiMessage ( juce::MidiInput *  , const juce::MidiMessage &    )

override

handleIncomingMidiMessage() [3/3]

virtual void tracktion::engine::MidiInputDevice::handleIncomingMidiMessage ( const juce::MidiMessage &  , MPESourceID    )

virtual

Implements tracktion::engine::MidiInputDevice.

Member Data Documentation

useAllInputs

const bool tracktion::engine::VirtualMidiInputDevice::useAllInputs = false

---

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

• tracktion_VirtualMidiInputDevice.h