tracktion::engine::WaveInputDevice Class Reference

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

#include <tracktion_WaveInputDevice.h>

Inheritance diagram for tracktion::engine::WaveInputDevice:

Public Member Functions
	WaveInputDevice (Engine &, const juce::String &type, const WaveDeviceDescription &, DeviceType)
	~WaveInputDevice () override
juce::StringArray	getRecordFormatNames ()
void	resetToDefault ()
void	setEnabled (bool) override
DeviceType	getDeviceType () const override
InputDeviceInstance *	createInstance (EditPlaybackContext &) override
	Creates an instance to use for a given playback context.
void	setRecordAdjustment (TimeDuration)
TimeDuration	getRecordAdjustment () const
void	setRecordAdjustmentMs (double ms)
double	getRecordAdjustmentMs () const
bool	isStereoPair () const
void	setStereoPair (bool)
juce::Array< int >	getAvailableBitDepths () const
void	setBitDepth (int)
int	getBitDepth () const
void	checkBitDepth ()
void	setInputGainDb (float gain)
float	getInputGainDb () const
void	setRecordTriggerDb (float)
float	getRecordTriggerDb () const
void	setFilenameMask (const juce::String &)
juce::String	getFilenameMask () const
void	setFilenameMaskToDefault ()
void	setOutputFormat (const juce::String &)
juce::String	getOutputFormat () const
void	setMergeMode (const juce::String &)
juce::String	getMergeMode () const
const std::vector< ChannelIndex > &	getChannels () const noexcept
const juce::AudioChannelSet &	getChannelSet () const noexcept
void	masterTimeUpdate (double) override
	This is a bit of a hack but allows the time for MIDI devices to be set through the base class interface.
void	consumeNextAudioBlock (const float *const *allChannels, int numChannels, int numSamples, double streamTime)
RetrospectiveRecordBuffer *	getRetrospectiveRecordBuffer ()
void	updateRetrospectiveBufferLength (double length) override
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
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
virtual bool	isMidi () 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 ()

Static Public Member Functions
static juce::StringArray	getMergeModes ()
static juce::String	getDefaultMask ()
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
juce::String	openDevice ()
void	closeDevice ()

Additional Inherited Members
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 >
Public Attributes inherited from tracktion::engine::InputDevice
Engine &	engine
LevelMeasurer	levelMeasurer
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference
Protected Attributes inherited from tracktion::engine::InputDevice
std::atomic< bool >	enabled { false }
MonitorMode	monitorMode = MonitorMode::automatic
MonitorMode	defaultMonitorMode = MonitorMode::automatic
bool	retrospectiveRecordLock = false

Detailed Description

A (virtual) audio input device.

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

Constructor & Destructor Documentation

WaveInputDevice()

tracktion::engine::WaveInputDevice::WaveInputDevice	(	Engine &	,
		const juce::String &	type,
		const WaveDeviceDescription &	,
		DeviceType
	)

~WaveInputDevice()

tracktion::engine::WaveInputDevice::~WaveInputDevice ( )

override

Member Function Documentation

getMergeModes()

static juce::StringArray tracktion::engine::WaveInputDevice::getMergeModes ( )

static

getRecordFormatNames()

juce::StringArray tracktion::engine::WaveInputDevice::getRecordFormatNames

(

)

resetToDefault()

void tracktion::engine::WaveInputDevice::resetToDefault

(

)

setEnabled()

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

overridevirtual

Implements tracktion::engine::InputDevice.

getDeviceType()

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

overridevirtual

Implements tracktion::engine::InputDevice.

createInstance()

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

overridevirtual

Creates an instance to use for a given playback context.

Implements tracktion::engine::InputDevice.

setRecordAdjustment()

void tracktion::engine::WaveInputDevice::setRecordAdjustment

(

TimeDuration

)

getRecordAdjustment()

TimeDuration tracktion::engine::WaveInputDevice::getRecordAdjustment

(

)

const

setRecordAdjustmentMs()

void tracktion::engine::WaveInputDevice::setRecordAdjustmentMs

(

double

ms

)

getRecordAdjustmentMs()

double tracktion::engine::WaveInputDevice::getRecordAdjustmentMs

(

)

const

isStereoPair()

bool tracktion::engine::WaveInputDevice::isStereoPair

(

)

const

setStereoPair()

void tracktion::engine::WaveInputDevice::setStereoPair

(

bool

)

getAvailableBitDepths()

juce::Array< int > tracktion::engine::WaveInputDevice::getAvailableBitDepths

(

)

const

setBitDepth()

void tracktion::engine::WaveInputDevice::setBitDepth

(

int

)

getBitDepth()

int tracktion::engine::WaveInputDevice::getBitDepth

(

)

const

checkBitDepth()

void tracktion::engine::WaveInputDevice::checkBitDepth

(

)

setInputGainDb()

void tracktion::engine::WaveInputDevice::setInputGainDb

(

float

gain

)

getInputGainDb()

float tracktion::engine::WaveInputDevice::getInputGainDb

(

)

const

setRecordTriggerDb()

void tracktion::engine::WaveInputDevice::setRecordTriggerDb

(

float

)

getRecordTriggerDb()

float tracktion::engine::WaveInputDevice::getRecordTriggerDb

(

)

const

setFilenameMask()

void tracktion::engine::WaveInputDevice::setFilenameMask

(

const juce::String &

)

getFilenameMask()

juce::String tracktion::engine::WaveInputDevice::getFilenameMask

(

)

const

setFilenameMaskToDefault()

void tracktion::engine::WaveInputDevice::setFilenameMaskToDefault

(

)

getDefaultMask()

static juce::String tracktion::engine::WaveInputDevice::getDefaultMask ( )

static

setOutputFormat()

void tracktion::engine::WaveInputDevice::setOutputFormat

(

const juce::String &

)

getOutputFormat()

juce::String tracktion::engine::WaveInputDevice::getOutputFormat

(

)

const

setMergeMode()

void tracktion::engine::WaveInputDevice::setMergeMode

(

const juce::String &

)

getMergeMode()

juce::String tracktion::engine::WaveInputDevice::getMergeMode

(

)

const

getChannels()

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

noexcept

getChannelSet()

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

noexcept

masterTimeUpdate()

void tracktion::engine::WaveInputDevice::masterTimeUpdate ( double  time )

overridevirtual

This is a bit of a hack but allows the time for MIDI devices to be set through the base class interface.

Implements tracktion::engine::InputDevice.

consumeNextAudioBlock()

void tracktion::engine::WaveInputDevice::consumeNextAudioBlock	(	const float *const *	allChannels,
		int	numChannels,
		int	numSamples,
		double	streamTime
	)

getRetrospectiveRecordBuffer()

RetrospectiveRecordBuffer * tracktion::engine::WaveInputDevice::getRetrospectiveRecordBuffer

(

)

updateRetrospectiveBufferLength()

void tracktion::engine::WaveInputDevice::updateRetrospectiveBufferLength ( double  length )

overridevirtual

Implements tracktion::engine::InputDevice.

getSelectableDescription()

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

overridevirtual

Subclasses must return a description of what they are.

Reimplemented from tracktion::engine::InputDevice.

openDevice()

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

protected

closeDevice()

void tracktion::engine::WaveInputDevice::closeDevice ( )

protected

---

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

• tracktion_WaveInputDevice.h