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

## Macros

#define | JUCE_VST3_CAN_REPLACE_VST2 1
| Config: JUCE_VST3_CAN_REPLACE_VST2.
#define | JUCE_FORCE_USE_LEGACY_PARAM_IDS 0
| Config: JUCE_FORCE_USE_LEGACY_PARAM_IDS.
#define | JUCE_FORCE_LEGACY_PARAMETER_AUTOMATION_TYPE 0
| Config: JUCE_FORCE_LEGACY_PARAMETER_AUTOMATION_TYPE.
#define | JUCE_USE_STUDIO_ONE_COMPATIBLE_PARAMETERS 1
| Config: JUCE_USE_STUDIO_ONE_COMPATIBLE_PARAMETERS.
#define | JUCE_AU_WRAPPERS_SAVE_PROGRAM_STATES 0
| Config: JUCE_AU_WRAPPERS_SAVE_PROGRAM_STATES.
#define | JUCE_STANDALONE_FILTER_WINDOW_USE_KIOSK_MODE (JUCE_IOS || JUCE_ANDROID)
| Config: JUCE_STANDALONE_FILTER_WINDOW_USE_KIOSK_MODE.
#define | JUCE_IGNORE_VST3_MISMATCHED_PARAMETER_ID_WARNING 0
| Config: JUCE_IGNORE_VST3_MISMATCHED_PARAMETER_ID_WARNING.

## Macro Definition Documentation

## JUCE_VST3_CAN_REPLACE_VST2

#define JUCE_VST3_CAN_REPLACE_VST2 1

Config: JUCE_VST3_CAN_REPLACE_VST2.

Enable this if you want your VST3 plug-in to load and save VST2 compatible state. This allows hosts to replace VST2 plug-ins with VST3 plug-ins. If you change this option then your VST3 plug-in will, by default, be incompatible with previous versions.

If you've already released a VST2 and VST3 with this flag set to 0, you can still enable migration from VST2 to VST3 on newer hosts by defining the JUCE_VST3_COMPATIBLE_CLASSES preprocessor and implementing the VST3ClientExtensions::getCompatibleParameterIds() method.

## JUCE_FORCE_USE_LEGACY_PARAM_IDS

#define JUCE_FORCE_USE_LEGACY_PARAM_IDS 0

Config: JUCE_FORCE_USE_LEGACY_PARAM_IDS.

Enable this if you want to force JUCE to use a continuous parameter index to identify a parameter in a DAW (this was the default in old versions of JUCE, and is always the default for VST2 plugins). This index is usually used by the DAW to save automation data. Changing this setting may mess up user's DAW projects, see VST3ClientExtensions::getCompatibleParameterIds() for a way to overcome this issue on newer VST3 hosts.

## JUCE_FORCE_LEGACY_PARAMETER_AUTOMATION_TYPE

#define JUCE_FORCE_LEGACY_PARAMETER_AUTOMATION_TYPE 0

Config: JUCE_FORCE_LEGACY_PARAMETER_AUTOMATION_TYPE.

Enable this if you want to force JUCE to use a legacy scheme for identifying plug-in parameters as either continuous or discrete. DAW projects with automation data written by an AudioUnit, VST3 or AAX plug-in built with JUCE version 5.1.1 or earlier may load incorrectly when opened by an AudioUnit, VST3 or AAX plug-in built with JUCE version 5.2.0 and later.

## JUCE_USE_STUDIO_ONE_COMPATIBLE_PARAMETERS

#define JUCE_USE_STUDIO_ONE_COMPATIBLE_PARAMETERS 1

Config: JUCE_USE_STUDIO_ONE_COMPATIBLE_PARAMETERS.

Enable this if you want JUCE to use parameter ids which are compatible with Studio One, as Studio One ignores any parameter ids which are negative. Enabling this option will make JUCE generate only positive parameter ids. Note that if you have already released a plug-in prior to JUCE 4.3.0 then enabling this will change your parameter ids, making your plug-in incompatible with old automation data.

## JUCE_AU_WRAPPERS_SAVE_PROGRAM_STATES

#define JUCE_AU_WRAPPERS_SAVE_PROGRAM_STATES 0

Config: JUCE_AU_WRAPPERS_SAVE_PROGRAM_STATES.

Enable this if you want to receive get/setProgramStateInformation calls, instead of get/setStateInformation calls, from the AU and AUv3 plug-in wrappers. In JUCE version 5.4.5 and earlier this was the default behaviour, so if you have modified the default implementations of get/setProgramStateInformation (where the default implementations simply call through to get/setStateInformation) then you may need to enable this configuration option to maintain backwards compatibility with previously saved state.

## JUCE_STANDALONE_FILTER_WINDOW_USE_KIOSK_MODE

#define JUCE_STANDALONE_FILTER_WINDOW_USE_KIOSK_MODE (JUCE_IOS || JUCE_ANDROID)

Config: JUCE_STANDALONE_FILTER_WINDOW_USE_KIOSK_MODE.

Enable this if you want your standalone plugin window to use kiosk mode. By default, kiosk mode is enabled on iOS and Android.

## JUCE_IGNORE_VST3_MISMATCHED_PARAMETER_ID_WARNING

#define JUCE_IGNORE_VST3_MISMATCHED_PARAMETER_ID_WARNING 0

Config: JUCE_IGNORE_VST3_MISMATCHED_PARAMETER_ID_WARNING.

Enable this to ignore a warning caused by enabling JUCE_VST3_CAN_REPLACE_VST2 and not enabling JUCE_FORCE_USE_LEGACY_PARAM_IDS.

### 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