juce::ARADocumentControllerConfiguration Struct Reference

Detailed Description

This class provides customisable configuration options that are available at the ARAFactory construction's time.

This is used as the ARAConfigurationType type member inside ARADocumentControllerSpecialisation.

If you wish to override the default configuration values, shadow ARADocumentControllerSpecialisation::ARAConfigurationType with a custom type of your own that has the same member function signatures as this struct.

See also

ARADocumentControllerSpecialisation::ARAConfigurationType

---

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

• juce_audio_processors_headless/utilities/ARA/juce_ARADocumentController.h

Static Public Member Functions
static constexpr ARA::ARAAPIGeneration	getHighestSupportedApiGeneration () noexcept
	In order to report kARAAPIGeneration_2_3_Final or higher, the plugin must notify the host via the ARA::PlugIn::HostModelUpdateController::notifyDocumentDataChanged() function whenever any private, opaque document state is changed, that must be persisted.

Member Functions

getHighestSupportedApiGeneration()

constexpr ARA::ARAAPIGeneration juce::ARADocumentControllerConfiguration::getHighestSupportedApiGeneration ( )

inlinestaticconstexprnoexcept

In order to report kARAAPIGeneration_2_3_Final or higher, the plugin must notify the host via the ARA::PlugIn::HostModelUpdateController::notifyDocumentDataChanged() function whenever any private, opaque document state is changed, that must be persisted.

Likewise, notifyAudioSourceContentChanged() and notifyAudioModificationContentChanged() must be called whenever the persistent state of the respective objects changes.

Otherwise data loss may occur. Reporting this version signals to the host that the plugin conforms to the ARA 2.3 partial persistence features.

e.g.

getDocumentController()->getHostModelUpdateController()->notifyDocumentDataChanged();