JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::AudioDeviceManager Class Reference

Manages the state of some audio and midi i/o devices. More...

#include <juce_AudioDeviceManager.h>

Inheritance diagram for juce::AudioDeviceManager:
Collaboration diagram for juce::AudioDeviceManager:

Classes

struct  AudioDeviceSetup
 This structure holds a set of properties describing the current audio setup. More...
 
struct  LevelMeter
 A simple reference-counted struct that holds a level-meter value that can be read using getCurrentLevel(). More...
 
struct  MidiCallbackInfo
 

Public Member Functions

 AudioDeviceManager ()
 Creates a default AudioDeviceManager. More...
 
 ~AudioDeviceManager () override
 Destructor. More...
 
void addAudioCallback (AudioIODeviceCallback *newCallback)
 Registers an audio callback to be used. More...
 
void addAudioDeviceType (std::unique_ptr< AudioIODeviceType > newDeviceType)
 Adds a new device type to the list of types. More...
 
void addChangeListener (ChangeListener *listener)
 Registers a listener to receive change callbacks from this broadcaster. More...
 
void addMidiInputDeviceCallback (const String &deviceIdentifier, MidiInputCallback *callback)
 Registers a listener for callbacks when midi events arrive from a midi input. More...
 
void closeAudioDevice ()
 Closes the currently-open device. More...
 
virtual void createAudioDeviceTypes (OwnedArray< AudioIODeviceType > &types)
 Creates a list of available types. More...
 
std::unique_ptr< XmlElementcreateStateXml () const
 Returns some XML representing the current state of the manager. More...
 
void dispatchPendingMessages ()
 If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately. More...
 
CriticalSectiongetAudioCallbackLock () noexcept
 Returns the a lock that can be used to synchronise access to the audio callback. More...
 
AudioDeviceSetup getAudioDeviceSetup () const
 Returns the current device properties that are in use. More...
 
void getAudioDeviceSetup (AudioDeviceSetup &result) const
 Returns the current device properties that are in use. More...
 
const OwnedArray< AudioIODeviceType > & getAvailableDeviceTypes ()
 Returns a list of the types of device supported. More...
 
double getCpuUsage () const
 Returns the average proportion of available CPU being spent inside the audio callbacks. More...
 
AudioIODevicegetCurrentAudioDevice () const noexcept
 Returns the currently-active audio device. More...
 
String getCurrentAudioDeviceType () const
 Returns the type of audio device currently in use. More...
 
AudioIODeviceTypegetCurrentDeviceTypeObject () const
 Returns the currently active audio device type object. More...
 
MidiOutputgetDefaultMidiOutput () const noexcept
 Returns the current default midi output device. More...
 
const StringgetDefaultMidiOutputIdentifier () const noexcept
 Returns the name of the default midi output. More...
 
LevelMeter::Ptr getInputLevelGetter () noexcept
 Returns a reference-counted object that can be used to get the current input level. More...
 
CriticalSectiongetMidiCallbackLock () noexcept
 Returns the a lock that can be used to synchronise access to the midi callback. More...
 
LevelMeter::Ptr getOutputLevelGetter () noexcept
 Returns a reference-counted object that can be used to get the current output level. More...
 
int getXRunCount () const noexcept
 Returns the number of under- or over runs reported. More...
 
String initialise (int numInputChannelsNeeded, int numOutputChannelsNeeded, const XmlElement *savedState, bool selectDefaultDeviceOnFailure, const String &preferredDefaultDeviceName=String(), const AudioDeviceSetup *preferredSetupOptions=nullptr)
 Opens a set of audio devices ready for use. More...
 
String initialiseWithDefaultDevices (int numInputChannelsNeeded, int numOutputChannelsNeeded)
 Resets everything to a default device setup, clearing any stored settings. More...
 
bool isMidiInputDeviceEnabled (const String &deviceIdentifier) const
 Returns true if a given midi input device is being used. More...
 
void playTestSound ()
 Plays a beep through the current audio device. More...
 
void removeAllChangeListeners ()
 Removes all listeners from the list. More...
 
void removeAudioCallback (AudioIODeviceCallback *callback)
 Deregisters a previously added callback. More...
 
void removeAudioDeviceType (AudioIODeviceType *deviceTypeToRemove)
 Removes a previously added device type from the manager. More...
 
void removeChangeListener (ChangeListener *listener)
 Unregisters a listener from the list. More...
 
void removeMidiInputDeviceCallback (const String &deviceIdentifier, MidiInputCallback *callback)
 Removes a listener that was previously registered with addMidiInputDeviceCallback(). More...
 
void restartLastAudioDevice ()
 Tries to reload the last audio device that was running. More...
 
void sendChangeMessage ()
 Causes an asynchronous change message to be sent to all the registered listeners. More...
 
void sendSynchronousChangeMessage ()
 Sends a synchronous change message to all the registered listeners. More...
 
String setAudioDeviceSetup (const AudioDeviceSetup &newSetup, bool treatAsChosenDevice)
 Changes the current device or its settings. More...
 
void setCurrentAudioDeviceType (const String &type, bool treatAsChosenDevice)
 Changes the class of audio device being used. More...
 
void setDefaultMidiOutputDevice (const String &deviceIdentifier)
 Sets a midi output device to use as the default. More...
 
void setMidiInputDeviceEnabled (const String &deviceIdentifier, bool enabled)
 Enables or disables a midi input device. More...
 

Private Member Functions

void audioDeviceAboutToStartInt (AudioIODevice *)
 
void audioDeviceErrorInt (const String &)
 
void audioDeviceIOCallbackInt (const float **inputChannelData, int totalNumInputChannels, float **outputChannelData, int totalNumOutputChannels, int numSamples)
 
void audioDeviceListChanged ()
 
void audioDeviceStoppedInt ()
 
void callListeners ()
 
int chooseBestBufferSize (int preferred) const
 
double chooseBestSampleRate (double preferred) const
 
void createDeviceTypesIfNeeded ()
 
void deleteCurrentDevice ()
 
AudioIODeviceTypefindType (const String &inputName, const String &outputName)
 
AudioIODeviceTypefindType (const String &typeName)
 
void handleIncomingMidiMessageInt (MidiInput *, const MidiMessage &)
 
String initialiseDefault (const String &preferredDefaultDeviceName, const AudioDeviceSetup *)
 
String initialiseFromXML (const XmlElement &, bool selectDefaultDeviceOnFailure, const String &preferredDefaultDeviceName, const AudioDeviceSetup *)
 
void insertDefaultDeviceNames (AudioDeviceSetup &) const
 
void pickCurrentDeviceTypeWithDevices ()
 
String restartDevice (int blockSizeToUse, double sampleRateToUse, const BigInteger &ins, const BigInteger &outs)
 
void scanDevicesIfNeeded ()
 
void stopDevice ()
 
void updateCurrentSetup ()
 
void updateXml ()
 

Private Attributes

std::atomic< boolanyListeners { false }
 
CriticalSection audioCallbackLock
 
OwnedArray< AudioIODeviceTypeavailableDeviceTypes
 
ChangeBroadcasterCallback broadcastCallback
 
std::unique_ptr< CallbackHandler > callbackHandler
 
Array< AudioIODeviceCallback * > callbacks
 
ListenerList< ChangeListenerchangeListeners
 
std::unique_ptr< AudioIODevicecurrentAudioDevice
 
String currentDeviceType
 
AudioDeviceSetup currentSetup
 
std::unique_ptr< MidiOutputdefaultMidiOutput
 
MidiDeviceInfo defaultMidiOutputDeviceInfo
 
std::vector< std::unique_ptr< MidiInput > > enabledMidiInputs
 
LevelMeter::Ptr inputLevelGetter { new LevelMeter() }
 
OwnedArray< AudioDeviceSetuplastDeviceTypeConfigs
 
std::unique_ptr< XmlElementlastExplicitSettings
 
bool listNeedsScanning = true
 
AudioProcessLoadMeasurer loadMeasurer
 
CriticalSection midiCallbackLock
 
Array< MidiCallbackInfomidiCallbacks
 
Array< MidiDeviceInfomidiDeviceInfosFromXml
 
int numInputChansNeeded = 0
 
int numOutputChansNeeded = 2
 
LevelMeter::Ptr outputLevelGetter { new LevelMeter() }
 
String preferredDeviceName
 
AudioBuffer< floattempBuffer
 
std::unique_ptr< AudioBuffer< float > > testSound
 
int testSoundPosition = 0
 

Detailed Description

Manages the state of some audio and midi i/o devices.

This class keeps tracks of a currently-selected audio device, through with which it continuously streams data from an audio callback, as well as one or more midi inputs.

The idea is that your application will create one global instance of this object, and let it take care of creating and deleting specific types of audio devices internally. So when the device is changed, your callbacks will just keep running without having to worry about this.

The manager can save and reload all of its device settings as XML, which makes it very easy for you to save and reload the audio setup of your application.

And to make it easy to let the user change its settings, there's a component to do just that - the AudioDeviceSelectorComponent class, which contains a set of device selection/sample-rate/latency controls.

To use an AudioDeviceManager, create one, and use initialise() to set it up. Then call addAudioCallback() to register your audio callback with it, and use that to process your audio data.

The manager also acts as a handy hub for incoming midi messages, allowing a listener to register for messages from either a specific midi device, or from whatever the current default midi input device is. The listener then doesn't have to worry about re-registering with different midi devices if they are changed or deleted.

And yet another neat trick is that amount of CPU time being used is measured and available with the getCpuUsage() method.

The AudioDeviceManager is a ChangeBroadcaster, and will send a change message to listeners whenever one of its settings is changed.

See also
AudioDeviceSelectorComponent, AudioIODevice, AudioIODeviceType

@tags{Audio}

Constructor & Destructor Documentation

◆ AudioDeviceManager()

juce::AudioDeviceManager::AudioDeviceManager ( )

Creates a default AudioDeviceManager.

Initially no audio device will be selected. You should call the initialise() method and register an audio callback with setAudioCallback() before it'll be able to actually make any noise.

◆ ~AudioDeviceManager()

juce::AudioDeviceManager::~AudioDeviceManager ( )
override

Destructor.

Member Function Documentation

◆ addAudioCallback()

void juce::AudioDeviceManager::addAudioCallback ( AudioIODeviceCallback newCallback)

Registers an audio callback to be used.

The manager will redirect callbacks from whatever audio device is currently in use to all registered callback objects. If more than one callback is active, they will all be given the same input data, and their outputs will be summed.

If necessary, this method will invoke audioDeviceAboutToStart() on the callback object before returning.

To remove a callback, use removeAudioCallback().

Referenced by juce::StandalonePluginHolder::setupAudioDevices().

◆ addAudioDeviceType()

void juce::AudioDeviceManager::addAudioDeviceType ( std::unique_ptr< AudioIODeviceType newDeviceType)

Adds a new device type to the list of types.

◆ addChangeListener()

void juce::ChangeBroadcaster::addChangeListener ( ChangeListener listener)
inherited

Registers a listener to receive change callbacks from this broadcaster.

Trying to add a listener that's already on the list will have no effect.

◆ addMidiInputDeviceCallback()

void juce::AudioDeviceManager::addMidiInputDeviceCallback ( const String deviceIdentifier,
MidiInputCallback callback 
)

Registers a listener for callbacks when midi events arrive from a midi input.

The device identifier can be empty to indicate that it wants to receive all incoming events from all the enabled MIDI inputs. Or it can be the identifier of one of the MIDI input devices if it just wants the events from that device. (see MidiInput::getAvailableDevices() for the list of devices).

Only devices which are enabled (see the setMidiInputDeviceEnabled() method) will have their events forwarded on to listeners.

Referenced by juce::StandalonePluginHolder::setupAudioDevices().

◆ audioDeviceAboutToStartInt()

void juce::AudioDeviceManager::audioDeviceAboutToStartInt ( AudioIODevice )
private

◆ audioDeviceErrorInt()

void juce::AudioDeviceManager::audioDeviceErrorInt ( const String )
private

◆ audioDeviceIOCallbackInt()

void juce::AudioDeviceManager::audioDeviceIOCallbackInt ( const float **  inputChannelData,
int  totalNumInputChannels,
float **  outputChannelData,
int  totalNumOutputChannels,
int  numSamples 
)
private

◆ audioDeviceListChanged()

void juce::AudioDeviceManager::audioDeviceListChanged ( )
private

◆ audioDeviceStoppedInt()

void juce::AudioDeviceManager::audioDeviceStoppedInt ( )
private

◆ callListeners()

void juce::ChangeBroadcaster::callListeners ( )
privateinherited

◆ chooseBestBufferSize()

int juce::AudioDeviceManager::chooseBestBufferSize ( int  preferred) const
private

◆ chooseBestSampleRate()

double juce::AudioDeviceManager::chooseBestSampleRate ( double  preferred) const
private

◆ closeAudioDevice()

void juce::AudioDeviceManager::closeAudioDevice ( )

Closes the currently-open device.

You can call restartLastAudioDevice() later to reopen it in the same state that it was just in.

◆ createAudioDeviceTypes()

virtual void juce::AudioDeviceManager::createAudioDeviceTypes ( OwnedArray< AudioIODeviceType > &  types)
virtual

Creates a list of available types.

This will add a set of new AudioIODeviceType objects to the specified list, to represent each available types of device.

You can override this if your app needs to do something specific, like avoid using DirectSound devices, etc.

◆ createDeviceTypesIfNeeded()

void juce::AudioDeviceManager::createDeviceTypesIfNeeded ( )
private

◆ createStateXml()

std::unique_ptr<XmlElement> juce::AudioDeviceManager::createStateXml ( ) const

Returns some XML representing the current state of the manager.

This stores the current device, its samplerate, block size, etc, and can be restored later with initialise().

Note that this can return a null pointer if no settings have been explicitly changed (i.e. if the device manager has just been left in its default state).

Referenced by juce::StandalonePluginHolder::saveAudioDeviceState().

◆ deleteCurrentDevice()

void juce::AudioDeviceManager::deleteCurrentDevice ( )
private

◆ dispatchPendingMessages()

void juce::ChangeBroadcaster::dispatchPendingMessages ( )
inherited

If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately.

For thread-safety reasons, you must only call this method on the main message thread.

◆ findType() [1/2]

AudioIODeviceType* juce::AudioDeviceManager::findType ( const String inputName,
const String outputName 
)
private

◆ findType() [2/2]

AudioIODeviceType* juce::AudioDeviceManager::findType ( const String typeName)
private

◆ getAudioCallbackLock()

CriticalSection& juce::AudioDeviceManager::getAudioCallbackLock ( )
inlinenoexcept

Returns the a lock that can be used to synchronise access to the audio callback.

Obviously while this is locked, you're blocking the audio thread from running, so it must only be used for very brief periods when absolutely necessary.

◆ getAudioDeviceSetup() [1/2]

AudioDeviceSetup juce::AudioDeviceManager::getAudioDeviceSetup ( ) const

Returns the current device properties that are in use.

See also
setAudioDeviceSetup

◆ getAudioDeviceSetup() [2/2]

void juce::AudioDeviceManager::getAudioDeviceSetup ( AudioDeviceSetup result) const

Returns the current device properties that are in use.

This is an old method, kept around for compatibility, but you should prefer the new version which returns the result rather than taking an out-parameter.

See also
getAudioDeviceSetup()

◆ getAvailableDeviceTypes()

const OwnedArray<AudioIODeviceType>& juce::AudioDeviceManager::getAvailableDeviceTypes ( )

Returns a list of the types of device supported.

◆ getCpuUsage()

double juce::AudioDeviceManager::getCpuUsage ( ) const

Returns the average proportion of available CPU being spent inside the audio callbacks.

Returns
A value between 0 and 1.0 to indicate the approximate proportion of CPU time spent in the callbacks.

◆ getCurrentAudioDevice()

AudioIODevice* juce::AudioDeviceManager::getCurrentAudioDevice ( ) const
inlinenoexcept

◆ getCurrentAudioDeviceType()

String juce::AudioDeviceManager::getCurrentAudioDeviceType ( ) const
inline

Returns the type of audio device currently in use.

See also
setCurrentAudioDeviceType

◆ getCurrentDeviceTypeObject()

AudioIODeviceType* juce::AudioDeviceManager::getCurrentDeviceTypeObject ( ) const

Returns the currently active audio device type object.

Don't keep a copy of this pointer - it's owned by the device manager and could change at any time.

◆ getDefaultMidiOutput()

MidiOutput* juce::AudioDeviceManager::getDefaultMidiOutput ( ) const
inlinenoexcept

Returns the current default midi output device.

If no device has been selected, or the device can't be opened, this will return nullptr.

See also
getDefaultMidiOutputIdentifier

Referenced by juce::StandalonePluginHolder::audioDeviceAboutToStart().

◆ getDefaultMidiOutputIdentifier()

const String& juce::AudioDeviceManager::getDefaultMidiOutputIdentifier ( ) const
inlinenoexcept

Returns the name of the default midi output.

See also
setDefaultMidiOutputDevice, getDefaultMidiOutput

◆ getInputLevelGetter()

LevelMeter::Ptr juce::AudioDeviceManager::getInputLevelGetter ( )
inlinenoexcept

Returns a reference-counted object that can be used to get the current input level.

You need to store this object locally to ensure that the reference count is incremented and decremented properly. The current input level value can be read using getCurrentLevel().

◆ getMidiCallbackLock()

CriticalSection& juce::AudioDeviceManager::getMidiCallbackLock ( )
inlinenoexcept

Returns the a lock that can be used to synchronise access to the midi callback.

Obviously while this is locked, you're blocking the midi system from running, so it must only be used for very brief periods when absolutely necessary.

◆ getOutputLevelGetter()

LevelMeter::Ptr juce::AudioDeviceManager::getOutputLevelGetter ( )
inlinenoexcept

Returns a reference-counted object that can be used to get the current output level.

You need to store this object locally to ensure that the reference count is incremented and decremented properly. The current output level value can be read using getCurrentLevel().

◆ getXRunCount()

int juce::AudioDeviceManager::getXRunCount ( ) const
noexcept

Returns the number of under- or over runs reported.

This method will use the underlying device's native getXRunCount if it supports it. Otherwise it will estimate the number of under-/overruns by measuring the time it spent in the audio callback.

◆ handleIncomingMidiMessageInt()

void juce::AudioDeviceManager::handleIncomingMidiMessageInt ( MidiInput ,
const MidiMessage  
)
private

◆ initialise()

String juce::AudioDeviceManager::initialise ( int  numInputChannelsNeeded,
int  numOutputChannelsNeeded,
const XmlElement savedState,
bool  selectDefaultDeviceOnFailure,
const String preferredDefaultDeviceName = String(),
const AudioDeviceSetup preferredSetupOptions = nullptr 
)

Opens a set of audio devices ready for use.

This will attempt to open either a default audio device, or one that was previously saved as XML.

Parameters
numInputChannelsNeededthe maximum number of input channels your app would like to use (the actual number of channels opened may be less than the number requested)
numOutputChannelsNeededthe maximum number of output channels your app would like to use (the actual number of channels opened may be less than the number requested)
savedStateeither a previously-saved state that was produced by createStateXml(), or nullptr if you want the manager to choose the best device to open.
selectDefaultDeviceOnFailureif true, then if the device specified in the XML fails to open, then a default device will be used instead. If false, then on failure, no device is opened.
preferredDefaultDeviceNameif this is not empty, and there's a device with this name, then that will be used as the default device (assuming that there wasn't one specified in the XML). The string can actually be a simple wildcard, containing "*" and "?" characters
preferredSetupOptionsif this is non-null, the structure will be used as the set of preferred settings when opening the device. If you use this parameter, the preferredDefaultDeviceName field will be ignored. If you set the outputDeviceName or inputDeviceName data members of the AudioDeviceSetup to empty strings, then a default device will be used.
Returns
an error message if anything went wrong, or an empty string if it worked ok.

Referenced by juce::StandalonePluginHolder::reloadAudioDeviceState().

◆ initialiseDefault()

String juce::AudioDeviceManager::initialiseDefault ( const String preferredDefaultDeviceName,
const AudioDeviceSetup  
)
private

◆ initialiseFromXML()

String juce::AudioDeviceManager::initialiseFromXML ( const XmlElement ,
bool  selectDefaultDeviceOnFailure,
const String preferredDefaultDeviceName,
const AudioDeviceSetup  
)
private

◆ initialiseWithDefaultDevices()

String juce::AudioDeviceManager::initialiseWithDefaultDevices ( int  numInputChannelsNeeded,
int  numOutputChannelsNeeded 
)

Resets everything to a default device setup, clearing any stored settings.

◆ insertDefaultDeviceNames()

void juce::AudioDeviceManager::insertDefaultDeviceNames ( AudioDeviceSetup ) const
private

◆ isMidiInputDeviceEnabled()

bool juce::AudioDeviceManager::isMidiInputDeviceEnabled ( const String deviceIdentifier) const

Returns true if a given midi input device is being used.

See also
setMidiInputDeviceEnabled

◆ pickCurrentDeviceTypeWithDevices()

void juce::AudioDeviceManager::pickCurrentDeviceTypeWithDevices ( )
private

◆ playTestSound()

void juce::AudioDeviceManager::playTestSound ( )

Plays a beep through the current audio device.

This is here to allow the audio setup UI panels to easily include a "test" button so that the user can check where the audio is coming from.

◆ removeAllChangeListeners()

void juce::ChangeBroadcaster::removeAllChangeListeners ( )
inherited

Removes all listeners from the list.

◆ removeAudioCallback()

void juce::AudioDeviceManager::removeAudioCallback ( AudioIODeviceCallback callback)

Deregisters a previously added callback.

If necessary, this method will invoke audioDeviceStopped() on the callback object before returning.

See also
addAudioCallback

Referenced by juce::StandalonePluginHolder::shutDownAudioDevices().

◆ removeAudioDeviceType()

void juce::AudioDeviceManager::removeAudioDeviceType ( AudioIODeviceType deviceTypeToRemove)

Removes a previously added device type from the manager.

◆ removeChangeListener()

void juce::ChangeBroadcaster::removeChangeListener ( ChangeListener listener)
inherited

Unregisters a listener from the list.

If the listener isn't on the list, this won't have any effect.

◆ removeMidiInputDeviceCallback()

void juce::AudioDeviceManager::removeMidiInputDeviceCallback ( const String deviceIdentifier,
MidiInputCallback callback 
)

Removes a listener that was previously registered with addMidiInputDeviceCallback().

Referenced by juce::StandalonePluginHolder::shutDownAudioDevices().

◆ restartDevice()

String juce::AudioDeviceManager::restartDevice ( int  blockSizeToUse,
double  sampleRateToUse,
const BigInteger ins,
const BigInteger outs 
)
private

◆ restartLastAudioDevice()

void juce::AudioDeviceManager::restartLastAudioDevice ( )

Tries to reload the last audio device that was running.

Note that this only reloads the last device that was running before closeAudioDevice() was called - it doesn't reload any kind of saved-state, and can only be called after a device has been opened with setAudioDeviceSetup().

If a device is already open, this call will do nothing.

◆ scanDevicesIfNeeded()

void juce::AudioDeviceManager::scanDevicesIfNeeded ( )
private

◆ sendChangeMessage()

void juce::ChangeBroadcaster::sendChangeMessage ( )
inherited

Causes an asynchronous change message to be sent to all the registered listeners.

The message will be delivered asynchronously by the main message thread, so this method will return immediately. To call the listeners synchronously use sendSynchronousChangeMessage().

Referenced by juce::SelectedItemSet< SelectableItemType >::changed().

◆ sendSynchronousChangeMessage()

void juce::ChangeBroadcaster::sendSynchronousChangeMessage ( )
inherited

Sends a synchronous change message to all the registered listeners.

This will immediately call all the listeners that are registered. For thread-safety reasons, you must only call this method on the main message thread.

See also
dispatchPendingMessages

Referenced by juce::SelectedItemSet< SelectableItemType >::changed().

◆ setAudioDeviceSetup()

String juce::AudioDeviceManager::setAudioDeviceSetup ( const AudioDeviceSetup newSetup,
bool  treatAsChosenDevice 
)

Changes the current device or its settings.

If you want to change a device property, like the current sample rate or block size, you can call getAudioDeviceSetup() to retrieve the current settings, then tweak the appropriate fields in the AudioDeviceSetup structure, and pass it back into this method to apply the new settings.

Parameters
newSetupthe settings that you'd like to use. If you don't need an input or output device, set the inputDeviceName or outputDeviceName data members respectively to empty strings. Note that this behaviour differs from the behaviour of initialise().
treatAsChosenDeviceif this is true and if the device opens correctly, these new settings will be taken as having been explicitly chosen by the user, and the next time createStateXml() is called, these settings will be returned. If it's false, then the device is treated as a temporary or default device, and a call to createStateXml() will return either the last settings that were made with treatAsChosenDevice as true, or the last XML settings that were passed into initialise().
Returns
an error message if anything went wrong, or an empty string if it worked ok.
See also
getAudioDeviceSetup

◆ setCurrentAudioDeviceType()

void juce::AudioDeviceManager::setCurrentAudioDeviceType ( const String type,
bool  treatAsChosenDevice 
)

Changes the class of audio device being used.

This switches between, e.g. ASIO and DirectSound. On the Mac you probably won't ever call this because there's only one type: CoreAudio.

For a list of types, see getAvailableDeviceTypes().

◆ setDefaultMidiOutputDevice()

void juce::AudioDeviceManager::setDefaultMidiOutputDevice ( const String deviceIdentifier)

Sets a midi output device to use as the default.

The list of devices can be obtained with the MidiOutput::getAvailableDevices() method.

The specified device will be opened automatically and can be retrieved with the getDefaultMidiOutput() method.

Pass in an empty string to deselect all devices. For the default device, you can use MidiOutput::getDefaultDevice().

See also
getDefaultMidiOutput, getDefaultMidiOutputIdentifier

◆ setMidiInputDeviceEnabled()

void juce::AudioDeviceManager::setMidiInputDeviceEnabled ( const String deviceIdentifier,
bool  enabled 
)

Enables or disables a midi input device.

The list of devices can be obtained with the MidiInput::getAvailableDevices() method.

Any incoming messages from enabled input devices will be forwarded on to all the listeners that have been registered with the addMidiInputDeviceCallback() method. They can either register for messages from a particular device, or from just the "default" midi input.

Routing the midi input via an AudioDeviceManager means that when a listener registers for the default midi input, this default device can be changed by the manager without the listeners having to know about it or re-register.

It also means that a listener can stay registered for a midi input that is disabled or not present, so that when the input is re-enabled, the listener will start receiving messages again.

See also
addMidiInputDeviceCallback, isMidiInputDeviceEnabled

Referenced by juce::StandalonePluginHolder::timerCallback().

◆ stopDevice()

void juce::AudioDeviceManager::stopDevice ( )
private

◆ updateCurrentSetup()

void juce::AudioDeviceManager::updateCurrentSetup ( )
private

◆ updateXml()

void juce::AudioDeviceManager::updateXml ( )
private

Member Data Documentation

◆ anyListeners

std::atomic<bool> juce::ChangeBroadcaster::anyListeners { false }
privateinherited

◆ audioCallbackLock

CriticalSection juce::AudioDeviceManager::audioCallbackLock
private

◆ availableDeviceTypes

OwnedArray<AudioIODeviceType> juce::AudioDeviceManager::availableDeviceTypes
private

◆ broadcastCallback

ChangeBroadcasterCallback juce::ChangeBroadcaster::broadcastCallback
privateinherited

◆ callbackHandler

std::unique_ptr<CallbackHandler> juce::AudioDeviceManager::callbackHandler
private

◆ callbacks

Array<AudioIODeviceCallback*> juce::AudioDeviceManager::callbacks
private

◆ changeListeners

ListenerList<ChangeListener> juce::ChangeBroadcaster::changeListeners
privateinherited

◆ currentAudioDevice

std::unique_ptr<AudioIODevice> juce::AudioDeviceManager::currentAudioDevice
private

◆ currentDeviceType

String juce::AudioDeviceManager::currentDeviceType
private

◆ currentSetup

AudioDeviceSetup juce::AudioDeviceManager::currentSetup
private

◆ defaultMidiOutput

std::unique_ptr<MidiOutput> juce::AudioDeviceManager::defaultMidiOutput
private

◆ defaultMidiOutputDeviceInfo

MidiDeviceInfo juce::AudioDeviceManager::defaultMidiOutputDeviceInfo
private

◆ enabledMidiInputs

std::vector<std::unique_ptr<MidiInput> > juce::AudioDeviceManager::enabledMidiInputs
private

◆ inputLevelGetter

LevelMeter::Ptr juce::AudioDeviceManager::inputLevelGetter { new LevelMeter() }
private

◆ lastDeviceTypeConfigs

OwnedArray<AudioDeviceSetup> juce::AudioDeviceManager::lastDeviceTypeConfigs
private

◆ lastExplicitSettings

std::unique_ptr<XmlElement> juce::AudioDeviceManager::lastExplicitSettings
private

◆ listNeedsScanning

bool juce::AudioDeviceManager::listNeedsScanning = true
mutableprivate

◆ loadMeasurer

AudioProcessLoadMeasurer juce::AudioDeviceManager::loadMeasurer
private

◆ midiCallbackLock

CriticalSection juce::AudioDeviceManager::midiCallbackLock
private

◆ midiCallbacks

Array<MidiCallbackInfo> juce::AudioDeviceManager::midiCallbacks
private

◆ midiDeviceInfosFromXml

Array<MidiDeviceInfo> juce::AudioDeviceManager::midiDeviceInfosFromXml
private

◆ numInputChansNeeded

int juce::AudioDeviceManager::numInputChansNeeded = 0
private

◆ numOutputChansNeeded

int juce::AudioDeviceManager::numOutputChansNeeded = 2
private

◆ outputLevelGetter

LevelMeter::Ptr juce::AudioDeviceManager::outputLevelGetter { new LevelMeter() }
private

◆ preferredDeviceName

String juce::AudioDeviceManager::preferredDeviceName
private

◆ tempBuffer

AudioBuffer<float> juce::AudioDeviceManager::tempBuffer
private

◆ testSound

std::unique_ptr<AudioBuffer<float> > juce::AudioDeviceManager::testSound
private

◆ testSoundPosition

int juce::AudioDeviceManager::testSoundPosition = 0
private

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