tracktion::engine::WaveOutputDevice Class Reference

A (virtual) audio output device. More...

#include "tracktion_WaveOutputDevice.h"

Inheritance diagram for tracktion::engine::WaveOutputDevice:

Public Member Functions
	WaveOutputDevice (Engine &, const WaveDeviceDescription &)
void	resetToDefault ()
void	setEnabled (bool) override
const std::vector< ChannelIndex > &	getChannels () const noexcept
const juce::AudioChannelSet &	getChannelSet () const noexcept
void	reverseChannels (bool)
bool	isReversed () const
void	setDithered (bool)
bool	isDithered () const
int	getLeftChannel () const
	Returns the left channel index.
int	getRightChannel () const
	Returns the right channel index.
bool	isStereoPair () const
	Returns true if the output is a stereo pair.
void	setStereoPair (bool)
WaveOutputDeviceInstance *	createInstance (EditPlaybackContext &)
Public Member Functions inherited from tracktion::engine::OutputDevice
	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 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 ()

Protected Member Functions
juce::String	openDevice () override
void	closeDevice () override

Friends
class	DeviceManager
class	WaveOutputDeviceInstance

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.
Public Attributes inherited from tracktion::engine::OutputDevice
Engine &	engine
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference
Protected Attributes inherited from tracktion::engine::OutputDevice
bool	enabled

Detailed Description

A (virtual) audio output device.

There'll be multiple instances of these, representing mono or stereo pairs of output channels.

Definition at line 19 of file tracktion_WaveOutputDevice.h.

Constructor & Destructor Documentation

WaveOutputDevice()

tracktion::engine::WaveOutputDevice::WaveOutputDevice	(	Engine &	e,
		const WaveDeviceDescription &	desc
	)

Definition at line 14 of file tracktion_WaveOutputDevice.cpp.

~WaveOutputDevice()

tracktion::engine::WaveOutputDevice::~WaveOutputDevice ( )

override

Definition at line 25 of file tracktion_WaveOutputDevice.cpp.

Member Function Documentation

closeDevice()

void tracktion::engine::WaveOutputDevice::closeDevice ( )

overrideprotectedvirtual

Implements tracktion::engine::OutputDevice.

Definition at line 53 of file tracktion_WaveOutputDevice.cpp.

createInstance()

WaveOutputDeviceInstance * tracktion::engine::WaveOutputDevice::createInstance

(

EditPlaybackContext &

c

)

Definition at line 103 of file tracktion_WaveOutputDevice.cpp.

getChannels()

const std::vector< ChannelIndex > & tracktion::engine::WaveOutputDevice::getChannels ( ) const

noexcept

Definition at line 27 of file tracktion_WaveOutputDevice.h.

getChannelSet()

const juce::AudioChannelSet & tracktion::engine::WaveOutputDevice::getChannelSet ( ) const

noexcept

Definition at line 28 of file tracktion_WaveOutputDevice.h.

getLeftChannel()

int tracktion::engine::WaveOutputDevice::getLeftChannel

(

)

const

Returns the left channel index.

N.B. this doesn't take into account if the channels are reversed as the reversing will be applied during the rendering stage.

Definition at line 126 of file tracktion_WaveOutputDevice.cpp.

getRightChannel()

int tracktion::engine::WaveOutputDevice::getRightChannel

(

)

const

Returns the right channel index.

N.B. this doesn't take into account if the channels are reversed as the reversing will be applied during the rendering stage.

Definition at line 131 of file tracktion_WaveOutputDevice.cpp.

isDithered()

bool tracktion::engine::WaveOutputDevice::isDithered

(

)

const

Definition at line 34 of file tracktion_WaveOutputDevice.h.

isReversed()

bool tracktion::engine::WaveOutputDevice::isReversed

(

)

const

Definition at line 31 of file tracktion_WaveOutputDevice.h.

isStereoPair()

bool tracktion::engine::WaveOutputDevice::isStereoPair

(

)

const

Returns true if the output is a stereo pair.

I.e. has two channels.

Definition at line 136 of file tracktion_WaveOutputDevice.cpp.

openDevice()

juce::String tracktion::engine::WaveOutputDevice::openDevice ( )

overrideprotectedvirtual

Implements tracktion::engine::OutputDevice.

Definition at line 48 of file tracktion_WaveOutputDevice.cpp.

resetToDefault()

void tracktion::engine::WaveOutputDevice::resetToDefault

(

)

Definition at line 31 of file tracktion_WaveOutputDevice.cpp.

reverseChannels()

void tracktion::engine::WaveOutputDevice::reverseChannels

(

bool

shouldReverse

)

Definition at line 80 of file tracktion_WaveOutputDevice.cpp.

setDithered()

void tracktion::engine::WaveOutputDevice::setDithered

(

bool

dither

)

Definition at line 92 of file tracktion_WaveOutputDevice.cpp.

setEnabled()

void tracktion::engine::WaveOutputDevice::setEnabled ( bool  b )

overridevirtual

Implements tracktion::engine::OutputDevice.

Definition at line 37 of file tracktion_WaveOutputDevice.cpp.

setStereoPair()

void tracktion::engine::WaveOutputDevice::setStereoPair

(

bool

stereo

)

Definition at line 141 of file tracktion_WaveOutputDevice.cpp.

Friends And Related Symbol Documentation

DeviceManager

friend class DeviceManager

friend

Definition at line 60 of file tracktion_WaveOutputDevice.h.

WaveOutputDeviceInstance

friend class WaveOutputDeviceInstance

friend

Definition at line 61 of file tracktion_WaveOutputDevice.h.

---

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

• tracktion_engine/playback/devices/tracktion_WaveOutputDevice.h
• tracktion_engine/playback/devices/tracktion_WaveOutputDevice.cpp