#include <tracktion_ARAFileReader.h>

Public Member Functions
	ARADocumentHolder (Edit &, const juce::ValueTree &)

	~ARADocumentHolder ()

void	flushStateToValueTree ()

bool	bindPluginToDocument (ExternalPlugin &, const juce::PluginDescription &)
	Binds an already-loaded, ARA-capable ExternalPlugin to this Edit's ARA document controller for the given description (lazily creating the document), putting the plugin into ARA mode.

void	musicalContextContentChanged ()
	Notifies every existing ARA document that the edit's tempo/key/chord content has changed so the plugins re-read their musical contexts.

Pimpl *	getPimpl ()

Constructor & Destructor Documentation

◆ ARADocumentHolder()

engine::ARADocumentHolder::ARADocumentHolder	(	Edit &	,
		const juce::ValueTree &
	)

◆ ~ARADocumentHolder()

engine::ARADocumentHolder::~ARADocumentHolder ( )

Member Function Documentation

◆ flushStateToValueTree()

void engine::ARADocumentHolder::flushStateToValueTree ( )

◆ bindPluginToDocument()

bool engine::ARADocumentHolder::bindPluginToDocument	(	ExternalPlugin &	,
		const juce::PluginDescription &
	)

Binds an already-loaded, ARA-capable ExternalPlugin to this Edit's ARA document controller for the given description (lazily creating the document), putting the plugin into ARA mode.

No audio source, playback region or musical context is created.

The plugin takes ownership of the binding (ExternalPlugin::setARADocumentBinding), which lasts for the lifetime of its loaded instance - if the plugin is already bound (e.g. it came back from the PluginCache), the existing binding is kept.

Returns false if the plugin isn't ARA-capable, its instance isn't loaded yet, or the binding fails.

◆ musicalContextContentChanged()

void engine::ARADocumentHolder::musicalContextContentChanged ( )

Notifies every existing ARA document that the edit's tempo/key/chord content has changed so the plugins re-read their musical contexts.

Called from Edit::sendTempoOrPitchSequenceChangedUpdates so it also covers documents with no clips (e.g. a browser/panel-only instance - QA 16550). Doesn't trigger document creation.

◆ getPimpl()

Pimpl * engine::ARADocumentHolder::getPimpl ( )

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

tracktion_ARAFileReader.h

Public Member Functions