Classes | |
| class | ARA::IMainFactory |
| Interface class to be implemented by an object provided by the VST3 factory. The host can use the VST3 factory to directly obtain the ARA factory, which allows for creating and maintaining the model independently of any IAudioProcessor instances, enabling tasks such as automatic tempo detection or audio-to-MIDI conversion. For rendering and editing the model however, there must be an associated IAudioProcessor class provided in the same binary. This match is usually trivial because there typically is only one such class in the binary, but there are cases such as WaveShell where multiple plug-ins live in the same binary, and only a subset of those plug-ins support ARA. In this scenario, the plug-in must use the same class name for the matching pair of ARA::IMainFactory and IAudioProcessor classes - this enables the host to quickly identify the matching pairs without having to create instances of all the IAudioProcessor classes to query their IPlugInEntryPoint::getFactory ()->factoryID to perform the matching. More... | |
| class | ARA::IPlugInEntryPoint |
| Interface class to be implemented by the VST3 IAudioProcessor component (kVstAudioEffectClass). More... | |
| class | ARA::IPlugInEntryPoint2 |
| ARA 2 extension of IPlugInEntryPoint. More... | |
Macros | |
| #define | kARAMainFactoryClass "ARA Main Factory Class" |
| Class category name for the ARA::IMainFactory. | |
| class ARA::IMainFactory |
Interface class to be implemented by an object provided by the VST3 factory. The host can use the VST3 factory to directly obtain the ARA factory, which allows for creating and maintaining the model independently of any IAudioProcessor instances, enabling tasks such as automatic tempo detection or audio-to-MIDI conversion. For rendering and editing the model however, there must be an associated IAudioProcessor class provided in the same binary. This match is usually trivial because there typically is only one such class in the binary, but there are cases such as WaveShell where multiple plug-ins live in the same binary, and only a subset of those plug-ins support ARA. In this scenario, the plug-in must use the same class name for the matching pair of ARA::IMainFactory and IAudioProcessor classes - this enables the host to quickly identify the matching pairs without having to create instances of all the IAudioProcessor classes to query their IPlugInEntryPoint::getFactory ()->factoryID to perform the matching.
Inherits Steinberg::FUnknown.
Public Member Functions | |
| virtual const ARAFactory *PLUGIN_API | getFactory ()=0 |
| Get the ARA factory. The returned pointer must remain valid throughout the lifetime of the object that provided it. The returned ARAFactory must be equal to the ARAFactory provided by the associated IAudioProcessor class through its IPlugInEntryPoint. | |
| class ARA::IPlugInEntryPoint |
Interface class to be implemented by the VST3 IAudioProcessor component (kVstAudioEffectClass).
Inherits Steinberg::FUnknown.
Public Member Functions | |
| virtual const ARAFactory *PLUGIN_API | getFactory ()=0 |
| Get the ARA factory. The returned pointer must remain valid throughout the lifetime of the object that provided it. The returned ARAFactory must be equal to the ARAFactory provided by the associated IMainFactory. To prevent ambiguities, the name of the plug-in as stored in the PClassInfo.name of this class must match the ARAFactory.plugInName returned here. | |
| virtual const ARAPlugInExtensionInstance *PLUGIN_API | bindToDocumentController (ARADocumentControllerRef documentControllerRef)=0 |
| Bind the VST3 instance to an ARA document controller, switching it from "normal" operation to ARA mode, and exposing the ARA plug-in extension. Note that since ARA 2.0, this call has been deprecated and replaced with bindToDocumentControllerWithRoles (). This deprecated call is equivalent to the new call with no known roles set, however all ARA 1.x hosts are in fact using all instances with playback renderer, edit renderer and editor view role enabled, so plug-ins implementing ARA 1 backwards compatibility can safely assume those three roles to be enabled if this call was made. Same call order rules as bindToDocumentControllerWithRoles () apply. | |
| class ARA::IPlugInEntryPoint2 |
ARA 2 extension of IPlugInEntryPoint.
Inherits Steinberg::FUnknown.
Public Member Functions | |
| virtual const ARAPlugInExtensionInstance *PLUGIN_API | bindToDocumentControllerWithRoles (ARADocumentControllerRef documentControllerRef, ARAPlugInInstanceRoleFlags knownRoles, ARAPlugInInstanceRoleFlags assignedRoles)=0 |
Extended version of bindToDocumentController (): bind the VST3 instance to an ARA document controller, switching it from "normal" operation to ARA mode with the assigned roles, and exposing the ARA plug-in extension. knownRoles encodes all roles that the host considered in its implementation and will explicitly assign to some plug-in instance(s), while assignedRoles describes the roles that this specific instance will fulfill. This may be called only once during the lifetime of the IAudioProcessor component, before the first call to setActive () or setState () or getProcessContextRequirements () or the creation of the GUI (see IPlugView). The ARA document controller must remain valid as long as the plug-in is in use - rendering, showing its UI, etc. However, when tearing down the plug-in, the actual order for deleting the IAudioProcessor instance and for deleting ARA document controller is undefined. Plug-ins must handle both potential destruction orders to allow for a simpler reference counting implementation on the host side. | |