JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
AudioIODeviceType Class Referenceabstract

Represents a type of audio driver, such as DirectSound, ASIO, CoreAudio, etc. More...

Classes

class  Listener
 A class for receiving events when audio devices are inserted or removed. More...
 

Public Member Functions

const StringgetTypeName () const noexcept
 Returns the name of this type of driver that this object manages.
 
virtual void scanForDevices ()=0
 Refreshes the object's cached list of known devices.
 
virtual StringArray getDeviceNames (bool wantInputNames=false) const =0
 Returns the list of available devices of this type.
 
virtual int getDefaultDeviceIndex (bool forInput) const =0
 Returns the name of the default device.
 
virtual int getIndexOfDevice (AudioIODevice *device, bool asInput) const =0
 Returns the index of a given device in the list of device names.
 
virtual bool hasSeparateInputsAndOutputs () const =0
 Returns true if two different devices can be used for the input and output.
 
virtual AudioIODevicecreateDevice (const String &outputDeviceName, const String &inputDeviceName)=0
 Creates one of the devices of this type.
 
void addListener (Listener *listener)
 Adds a listener that will be called when this type of device is added or removed from the system.
 
void removeListener (Listener *listener)
 Removes a listener that was previously added with addListener().
 
virtual ~AudioIODeviceType ()
 Destructor.
 

Static Public Member Functions

static AudioIODeviceTypecreateAudioIODeviceType_CoreAudio ()
 Creates a CoreAudio device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_iOSAudio ()
 Creates an iOS device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_WASAPI ()
 Creates a WASAPI device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_DirectSound ()
 Creates a DirectSound device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_ASIO ()
 Creates an ASIO device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_ALSA ()
 Creates an ALSA device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_JACK ()
 Creates a JACK device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_Android ()
 Creates an Android device type if it's available on this platform, or returns null.
 
static AudioIODeviceTypecreateAudioIODeviceType_OpenSLES ()
 Creates an Android OpenSLES device type if it's available on this platform, or returns null.
 

Protected Member Functions

 AudioIODeviceType (const String &typeName)
 
void callDeviceChangeListeners ()
 Synchronously calls all the registered device list change listeners.
 

Detailed Description

Represents a type of audio driver, such as DirectSound, ASIO, CoreAudio, etc.

To get a list of available audio driver types, use the AudioDeviceManager::createAudioDeviceTypes() method. Each of the objects returned can then be used to list the available devices of that type. E.g.

myAudioDeviceManager.createAudioDeviceTypes (types);
for (int i = 0; i < types.size(); ++i)
{
String typeName (types[i]->getTypeName()); // This will be things like "DirectSound", "CoreAudio", etc.
types[i]->scanForDevices(); // This must be called before getting the list of devices
StringArray deviceNames (types[i]->getDeviceNames()); // This will now return a list of available devices of this type
for (int j = 0; j < deviceNames.size(); ++j)
{
AudioIODevice* device = types[i]->createDevice (deviceNames [j]);
...
}
}

For an easier way of managing audio devices and their settings, have a look at the AudioDeviceManager class.

See Also
AudioIODevice, AudioDeviceManager

Constructor & Destructor Documentation

virtual AudioIODeviceType::~AudioIODeviceType ( )
virtual

Destructor.

AudioIODeviceType::AudioIODeviceType ( const String typeName)
explicitprotected

Member Function Documentation

const String& AudioIODeviceType::getTypeName ( ) const
noexcept

Returns the name of this type of driver that this object manages.

This will be something like "DirectSound", "ASIO", "CoreAudio", "ALSA", etc.

virtual void AudioIODeviceType::scanForDevices ( )
pure virtual

Refreshes the object's cached list of known devices.

This must be called at least once before calling getDeviceNames() or any of the other device creation methods.

virtual StringArray AudioIODeviceType::getDeviceNames ( bool  wantInputNames = false) const
pure virtual

Returns the list of available devices of this type.

The scanForDevices() method must have been called to create this list.

Parameters
wantInputNamesonly really used by DirectSound where devices are split up into inputs and outputs, this indicates whether to use the input or output name to refer to a pair of devices.
virtual int AudioIODeviceType::getDefaultDeviceIndex ( bool  forInput) const
pure virtual

Returns the name of the default device.

This will be one of the names from the getDeviceNames() list.

Parameters
forInputif true, this means that a default input device should be returned; if false, it should return the default output
virtual int AudioIODeviceType::getIndexOfDevice ( AudioIODevice device,
bool  asInput 
) const
pure virtual

Returns the index of a given device in the list of device names.

If asInput is true, it shows the index in the inputs list, otherwise it looks for it in the outputs list.

virtual bool AudioIODeviceType::hasSeparateInputsAndOutputs ( ) const
pure virtual

Returns true if two different devices can be used for the input and output.

virtual AudioIODevice* AudioIODeviceType::createDevice ( const String outputDeviceName,
const String inputDeviceName 
)
pure virtual

Creates one of the devices of this type.

The deviceName must be one of the strings returned by getDeviceNames(), and scanForDevices() must have been called before this method is used.

void AudioIODeviceType::addListener ( Listener listener)

Adds a listener that will be called when this type of device is added or removed from the system.

void AudioIODeviceType::removeListener ( Listener listener)

Removes a listener that was previously added with addListener().

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_CoreAudio ( )
static

Creates a CoreAudio device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_iOSAudio ( )
static

Creates an iOS device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_WASAPI ( )
static

Creates a WASAPI device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_DirectSound ( )
static

Creates a DirectSound device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_ASIO ( )
static

Creates an ASIO device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_ALSA ( )
static

Creates an ALSA device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_JACK ( )
static

Creates a JACK device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_Android ( )
static

Creates an Android device type if it's available on this platform, or returns null.

static AudioIODeviceType* AudioIODeviceType::createAudioIODeviceType_OpenSLES ( )
static

Creates an Android OpenSLES device type if it's available on this platform, or returns null.

void AudioIODeviceType::callDeviceChangeListeners ( )
protected

Synchronously calls all the registered device list change listeners.


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