Loading...
Searching...
No Matches
juce_audio_devices.h File Reference

## Namespaces

namespace | juce

## Macros

#define | JUCE_AUDIO_DEVICES_H_INCLUDED
#define | JUCE_USE_WINRT_MIDI 0
| Config: JUCE_USE_WINRT_MIDI Enables the use of the Windows Runtime API for MIDI, allowing connections to Bluetooth Low Energy devices on Windows 10 version 1809 (October 2018 Update) and later.
#define | JUCE_USE_WINDOWS_MIDI_SERVICES 0
| Config: JUCE_USE_WINDOWS_MIDI_SERVICES Enables the use of Windows MIDI Services, in turn enabling MIDI 2.0 support on some Windows versions.
#define | JUCE_ASIO 0
| Config: JUCE_ASIO Enables ASIO audio devices (MS Windows only).
#define | JUCE_ASIO_USE_EXTERNAL_SDK 0
| Config: JUCE_ASIO_USE_EXTERNAL_SDK The default behaviour of the JUCE_ASIO flag is to include a bundled header from the ASIO SDK.
#define | JUCE_WASAPI 1
| Config: JUCE_WASAPI Enables WASAPI audio devices (Windows Vista and above).
#define | JUCE_DIRECTSOUND 1
| Config: JUCE_DIRECTSOUND Enables DirectSound audio (MS Windows only).
#define | JUCE_ALSA 1
| Config: JUCE_ALSA Enables ALSA audio devices (Linux only).
#define | JUCE_JACK 0
| Config: JUCE_JACK Enables JACK audio devices.
#define | JUCE_USE_ANDROID_OBOE 1
| Config: JUCE_USE_ANDROID_OBOE Enables Oboe devices (Android only).
#define | JUCE_USE_ANDROID_OBOE_STABILIZED_CALLBACK 0
| Config: JUCE_USE_OBOE_STABILIZED_CALLBACK If JUCE_USE_ANDROID_OBOE is enabled, enabling this will wrap output audio streams in the oboe::StabilizedCallback class.
#define | JUCE_USE_ANDROID_OPENSLES 0
| Config: JUCE_USE_ANDROID_OPENSLES Enables OpenSLES devices (Android only).
#define | JUCE_DISABLE_AUDIO_MIXING_WITH_OTHER_APPS 0
| Config: JUCE_DISABLE_AUDIO_MIXING_WITH_OTHER_APPS Turning this on gives your app exclusive access to the system's audio on platforms which support it (currently iOS only).

## Enumerations

enum class | juce::WASAPIDeviceMode { juce::shared , juce::exclusive , juce::sharedLowLatency }
| Available modes for the WASAPI audio device. More...

## Macro Definition Documentation

## JUCE_AUDIO_DEVICES_H_INCLUDED

#define JUCE_AUDIO_DEVICES_H_INCLUDED

## JUCE_USE_WINRT_MIDI

#define JUCE_USE_WINRT_MIDI 0

Config: JUCE_USE_WINRT_MIDI Enables the use of the Windows Runtime API for MIDI, allowing connections to Bluetooth Low Energy devices on Windows 10 version 1809 (October 2018 Update) and later.

If you enable this flag then older versions of Windows will automatically fall back to using the regular Win32 MIDI API.

You will need version 10.0.14393.0 of the Windows Standalone SDK to compile and you may need to add the path to the WinRT headers. The path to the headers will be something similar to "C:\Program Files (x86)\Windows Kits\10\Include\10.0.14393.0\winrt".

## JUCE_USE_WINDOWS_MIDI_SERVICES

#define JUCE_USE_WINDOWS_MIDI_SERVICES 0

Config: JUCE_USE_WINDOWS_MIDI_SERVICES Enables the use of Windows MIDI Services, in turn enabling MIDI 2.0 support on some Windows versions.

At time of writing, this only works on the Canary insiders build of Windows 11, but eventually this will work on the final release of Windows 10 too.

In order to enable this functionality, your target and minimum Windows SDK versions must be set to at least 10.0.20348.0.

This functionality depends on the CppWinRT tool and the Windows MIDI Services NuGet package at build-time. If you're using the Projucer, this will be set up for you automatically when this flag is enabled. If you're using CMake, you'll need to pass "NEEDS_WINDOWS_MIDI_SERVICES TRUE" to your juce_add_<target> call.

Currently, the Windows MIDI Services NuGet package is not hosted in the official repository. In order to allow NuGet and/or Visual Studio to find the package, you'll need to set up a local repository pointing at a local folder holding the package. You can do this from the Visual Studio package management UI.

Because this API is implemented using code generated by the CppWinRT tool, it can only be built by compilers that understand the generated code. MSVC is most likely to work; some versions of Clang may work but this is not guaranteed.

Even once the Windows MIDI Services are stable and enabled in Windows, the service won't be usable until the service's SDK package is installed. Therefore, you will need to ensure that the installer for your software also installs this SDK package, or informs the user how to install the dependency. If the SDK is not available, JUCE will fall back to using the older WinRT API (if enabled) or the Win32 API otherwise. These APIs do not support MIDI 2.0.

## JUCE_ASIO

#define JUCE_ASIO 0

Config: JUCE_ASIO Enables ASIO audio devices (MS Windows only).

IMPORTANT: Turning this on will cause your program to depend on source files from the ASIO SDK from Steinberg, so your resulting program must adhere to the license terms of those files.

By default, this option will use the bundled ASIO headers distributed alongside JUCE. See the documentation for JUCE_ASIO_USE_EXTERNAL_SDK to learn how to use a different version of those headers.

## JUCE_ASIO_USE_EXTERNAL_SDK

#define JUCE_ASIO_USE_EXTERNAL_SDK 0

Config: JUCE_ASIO_USE_EXTERNAL_SDK The default behaviour of the JUCE_ASIO flag is to include a bundled header from the ASIO SDK.

If you need to supply your own version of this header, instead of using the bundled one, you can enable this flag. If you do, then you must also ensure that the file "iasiodrv.h" from the SDK can be located via your project's header include paths.

The option only has an effect when JUCE_ASIO is also enabled.

## JUCE_WASAPI

#define JUCE_WASAPI 1

Config: JUCE_WASAPI Enables WASAPI audio devices (Windows Vista and above).

## JUCE_DIRECTSOUND

#define JUCE_DIRECTSOUND 1

Config: JUCE_DIRECTSOUND Enables DirectSound audio (MS Windows only).

## JUCE_ALSA

#define JUCE_ALSA 1

Config: JUCE_ALSA Enables ALSA audio devices (Linux only).

## JUCE_JACK

#define JUCE_JACK 0

Config: JUCE_JACK Enables JACK audio devices.

## JUCE_USE_ANDROID_OBOE

#define JUCE_USE_ANDROID_OBOE 1

Config: JUCE_USE_ANDROID_OBOE Enables Oboe devices (Android only).

## JUCE_USE_ANDROID_OBOE_STABILIZED_CALLBACK

#define JUCE_USE_ANDROID_OBOE_STABILIZED_CALLBACK 0

Config: JUCE_USE_OBOE_STABILIZED_CALLBACK If JUCE_USE_ANDROID_OBOE is enabled, enabling this will wrap output audio streams in the oboe::StabilizedCallback class.

This class attempts to keep the CPU spinning to avoid it being scaled down on certain devices. (Android only).

## JUCE_USE_ANDROID_OPENSLES

#define JUCE_USE_ANDROID_OPENSLES 0

Config: JUCE_USE_ANDROID_OPENSLES Enables OpenSLES devices (Android only).

## JUCE_DISABLE_AUDIO_MIXING_WITH_OTHER_APPS

#define JUCE_DISABLE_AUDIO_MIXING_WITH_OTHER_APPS 0

Config: JUCE_DISABLE_AUDIO_MIXING_WITH_OTHER_APPS Turning this on gives your app exclusive access to the system's audio on platforms which support it (currently iOS only).

### Purchase

Get JUCE

### Discover

What's New in JUCE Features

### Learn

Documentaion Tutorials Made with JUCE Resources

### Support

JUCE Forum Newsletter Archive

### About

Contact Us JUCE Legal JUCE Licensing FAQ

### Events

Audio Developer Conference
© Raw Material Software Limited