tracktion::engine::OutputDevice Class Reference

Base class for audio or midi output devices, to which a track's output can be sent. More...

#include <tracktion_OutputDevice.h>

Inheritance diagram for tracktion::engine::OutputDevice:

Public Member Functions
	OutputDevice (Engine &, juce::String type, juce::String name, juce::String deviceID)
	~OutputDevice () override
virtual juce::String	getName () const
juce::String	getAlias () const
	the alias is the name shown in the draggable input device components
void	setAlias (const juce::String &alias)
juce::String	getDeviceID () const
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
bool	isEnabled () const
virtual void	setEnabled (bool b)=0
virtual bool	isMidi () const
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
Engine &	engine
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Protected Member Functions
virtual juce::String	openDevice ()=0
virtual void	closeDevice ()=0

Protected Attributes
bool	enabled = false

Additional Inherited Members
Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >
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.

Detailed Description

Base class for audio or midi output devices, to which a track's output can be sent.

The DeviceManager keeps a list of these objects.

Constructor & Destructor Documentation

OutputDevice()

tracktion::engine::OutputDevice::OutputDevice	(	Engine &	,
		juce::String	type,
		juce::String	name,
		juce::String	deviceID
	)

~OutputDevice()

tracktion::engine::OutputDevice::~OutputDevice ( )

override

Member Function Documentation

getName()

virtual juce::String tracktion::engine::OutputDevice::getName ( ) const

virtual

getAlias()

juce::String tracktion::engine::OutputDevice::getAlias

(

)

const

the alias is the name shown in the draggable input device components

setAlias()

void tracktion::engine::OutputDevice::setAlias

(

const juce::String &

alias

)

getDeviceID()

juce::String tracktion::engine::OutputDevice::getDeviceID

(

)

const

getSelectableDescription()

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

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

isEnabled()

bool tracktion::engine::OutputDevice::isEnabled

(

)

const

setEnabled()

virtual void tracktion::engine::OutputDevice::setEnabled ( bool  b )

pure virtual

Implemented in tracktion::engine::MidiOutputDevice, and tracktion::engine::WaveOutputDevice.

isMidi()

virtual bool tracktion::engine::OutputDevice::isMidi ( ) const

virtual

Reimplemented in tracktion::engine::MidiOutputDevice.

openDevice()

virtual juce::String tracktion::engine::OutputDevice::openDevice ( )

protectedpure virtual

Implemented in tracktion::engine::MidiOutputDevice, and tracktion::engine::WaveOutputDevice.

closeDevice()

virtual void tracktion::engine::OutputDevice::closeDevice ( )

protectedpure virtual

Implemented in tracktion::engine::MidiOutputDevice, and tracktion::engine::WaveOutputDevice.

Member Data Documentation

engine

Engine& tracktion::engine::OutputDevice::engine

enabled

bool tracktion::engine::OutputDevice::enabled = false

protected

---

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

• tracktion_OutputDevice.h