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)

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
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

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.

Definition at line 17 of file tracktion_OutputDevice.h.

Constructor & Destructor Documentation

◆ OutputDevice()

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

Definition at line 14 of file tracktion_OutputDevice.cpp.

◆ ~OutputDevice()

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

override

Definition at line 22 of file tracktion_OutputDevice.cpp.

Member Function Documentation

◆ getAlias()

juce::String tracktion::engine::OutputDevice::getAlias ( ) const

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

Definition at line 36 of file tracktion_OutputDevice.cpp.

◆ getDeviceID()

juce::String tracktion::engine::OutputDevice::getDeviceID ( ) const

Definition at line 30 of file tracktion_OutputDevice.h.

◆ getName()

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

virtual

Definition at line 31 of file tracktion_OutputDevice.cpp.

◆ getSelectableDescription()

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

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 62 of file tracktion_OutputDevice.cpp.

◆ isEnabled()

bool tracktion::engine::OutputDevice::isEnabled ( ) const

Definition at line 67 of file tracktion_OutputDevice.cpp.

◆ isMidi()

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

virtual

Definition at line 37 of file tracktion_OutputDevice.h.

◆ setAlias()

void tracktion::engine::OutputDevice::setAlias ( const juce::String & alias )

Definition at line 44 of file tracktion_OutputDevice.cpp.

Member Data Documentation

◆ enabled

bool tracktion::engine::OutputDevice::enabled

protected

Definition at line 43 of file tracktion_OutputDevice.h.

◆ engine

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

Definition at line 39 of file tracktion_OutputDevice.h.

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

tracktion_engine/playback/devices/tracktion_OutputDevice.h
tracktion_engine/playback/devices/tracktion_OutputDevice.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members