tracktion::engine::IODevice Class Reference

A base class for input/output devices. More...

#include <tracktion_IODevice.h>

Inherits Selectable.

Public Member Functions
	IODevice (Engine &, juce::String name, juce::String deviceID)
	~IODevice () override
const juce::String &	getName () const
juce::String	getDeviceID () const
bool	isEnabled () const
virtual void	setEnabled (bool)=0
virtual bool	isMidi () const =0
virtual bool	isTrackDevice () const =0
virtual juce::String	getDeviceTypeDescription () const =0
void	setAlias (const juce::String &newAlias)
	the alias is the name shown in the draggable input device components
juce::String	getAliasOrName () const
	Returns the alias if set, otherwise the name.
juce::String	getAliasIfSet () const
	Returns the alias, or an empty string if not set.
juce::String	getSelectableDescription () override

Public Attributes
Engine &	engine

Protected Attributes
std::atomic< bool >	enabled { false }
const juce::String	deviceID
const juce::String	name

Detailed Description

A base class for input/output devices.

See InputDevice and OutputDevice for more details.

Constructor & Destructor Documentation

IODevice()

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

~IODevice()

tracktion::engine::IODevice::~IODevice ( )

override

Member Function Documentation

getName()

const juce::String & tracktion::engine::IODevice::getName

(

)

const

References name.

getDeviceID()

juce::String tracktion::engine::IODevice::getDeviceID

(

)

const

References deviceID.

isEnabled()

bool tracktion::engine::IODevice::isEnabled

(

)

const

setEnabled()

virtual void tracktion::engine::IODevice::setEnabled ( bool  )

pure virtual

isMidi()

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

pure virtual

isTrackDevice()

virtual bool tracktion::engine::IODevice::isTrackDevice ( ) const

pure virtual

getDeviceTypeDescription()

virtual juce::String tracktion::engine::IODevice::getDeviceTypeDescription ( ) const

pure virtual

setAlias()

void tracktion::engine::IODevice::setAlias

(

const juce::String &

newAlias

)

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

getAliasOrName()

juce::String tracktion::engine::IODevice::getAliasOrName

(

)

const

Returns the alias if set, otherwise the name.

getAliasIfSet()

juce::String tracktion::engine::IODevice::getAliasIfSet

(

)

const

Returns the alias, or an empty string if not set.

getSelectableDescription()

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

override

Member Data Documentation

engine

Engine& tracktion::engine::IODevice::engine

enabled

std::atomic<bool> tracktion::engine::IODevice::enabled { false }

protected

deviceID

const juce::String tracktion::engine::IODevice::deviceID

protected

Referenced by getDeviceID().

name

const juce::String tracktion::engine::IODevice::name

protected

Referenced by getName().

---

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

• tracktion_IODevice.h