API Generations

Detailed Description

While purely additive features can be handled through ARA's versioned structs, ARA API generations allow for non-backwards-compatible, fundamental API changes. For hosts that rely on a certain minimum ARA feature set provided by the plug-ins, it also offers a convenient way to filter incompatible plug-ins. Plug-ins on the other hand can use the API generation chosen by the host to optimize their feature set for the given environment, such as disabling potentially costly fallback code required for older hosts when running in a modern host.

Macros

#define ARA_DEPRECATED(generation)
 Markup for outdated API that should no longer be used in future development, but can still be supported for backwards compatibility with older plug-ins/hosts if desired.
By defining ARA_ENABLE_DEPRECATION_WARNINGS as non-zero value it is possible to get deprecation warnings in the most common compilers, for inspecting deprecated API usage in a given project. These warnings are disabled by default in order to not interfere with code that supports older APIs.
 
#define ARA_ADDENDUM(generation)
 Markup for struct elements which were added in later revisions of the API and may be omitted from the struct when dealing with older plug-ins/hosts.
 
#define ARA_DRAFT   ARA_ADDENDUM(2_X_Draft)
 Markup for draft API that is still under active development and not yet properly versioned - when using those struct elements, host and plug-in must agree on a specific draft header version!
All uses of this macro will be replaced by ARA_ADDENDUM() upon final release. To quickly find all places in your project that use draft API, it's possible to temporarily redefine ARA_DRAFT to ARA_WARN_DEPRECATED(...).
 

Enumeration Type Documentation

◆ ARAAPIGeneration

Enumerator
kARAAPIGeneration_1_0_Draft 

private API between Studio One and Melodyne

kARAAPIGeneration_1_0_Final 

supported by Studio One, Cakewalk/SONAR, Samplitude Pro, Mixcraft, Waveform/Tracktion, Melodyne, VocAlign, AutoTune

kARAAPIGeneration_2_0_Draft 

supported by Studio One, Logic Pro, Cubase/Nuendo, Cakewalk, REAPER, Melodyne, ReVoice Pro, VocAlign, Auto-Align, SpectraLayers

kARAAPIGeneration_2_0_Final 

most developers supporting kARAAPIGeneration_2_0_Draft are already working on updating to kARAAPIGeneration_2_0_Final (this is also required for ARM builds)

kARAAPIGeneration_2_X_Draft 

reserved for future development