ARADocument Class Reference

As specified by the Celmony: More...

#include <tracktion_ARAWrapperInterfaces.h>

Classes
struct	ScopedEdit

Public Member Functions
	ARADocument (Edit &sourceEdit, ARAInstance *validPluginWrapper, const ARAPlugInExtensionInstance &, const ARADocumentControllerInstance &dc, ARADocumentControllerHostInstance *dchi)
	~ARADocument ()
bool	canEdit (bool dontCheckMusicalContext) const
void	beginEditing (bool dontCheckMusicalContext)
void	endEditing (bool dontCheckMusicalContext)
void	flushStateToValueTree (juce::ValueTree &v)
void	beginRestoringState (const juce::ValueTree &state)
void	endRestoringState ()
juce::MemoryBlock	storeObjectsForCopy (ARAAudioSourceRef source, ARAAudioModificationRef modification)
	Store a partial ARA archive containing just the given audio source and modification.
void	restoreObjectsForPaste (const juce::MemoryBlock &data, const juce::String &archivedSourceID, const juce::String &currentSourceID, const juce::String &archivedModID, const juce::String &currentModID)
	Restore a partial ARA archive, mapping archived persistent IDs to current ones.
void	willCreatePlaybackRegionOnTrack (Track *track)
void	willDestroyPlaybackRegionOnTrack (Track *track)

Public Attributes
Edit &	edit
const ARADocumentControllerInterface *	dci
ARADocumentControllerRef	dcRef
std::unique_ptr< MusicalContextWrapper >	musicalContext
std::map< Track *, std::unique_ptr< RegionSequenceWrapper > >	regionSequences
std::map< Track *, int >	regionSequencePlaybackRegionCount
std::unique_ptr< juce::MemoryBlock >	lastArchiveState

Detailed Description

As specified by the Celmony:

• 1 document per Edit
• 1 musical context per edit

Constructor & Destructor Documentation

ARADocument()

ARADocument::ARADocument	(	Edit &	sourceEdit,
		ARAInstance *	validPluginWrapper,
		const ARAPlugInExtensionInstance &	,
		const ARADocumentControllerInstance &	dc,
		ARADocumentControllerHostInstance *	dchi
	)

References CRASH_TRACER.

~ARADocument()

ARADocument::~ARADocument

(

)

References CRASH_TRACER.

Member Function Documentation

canEdit()

bool ARADocument::canEdit

(

bool

dontCheckMusicalContext

)

const

beginEditing()

void ARADocument::beginEditing

(

bool

dontCheckMusicalContext

)

endEditing()

void ARADocument::endEditing

(

bool

dontCheckMusicalContext

)

flushStateToValueTree()

void ARADocument::flushStateToValueTree

(

juce::ValueTree &

v

)

References CRASH_TRACER.

beginRestoringState()

void ARADocument::beginRestoringState

(

const juce::ValueTree &

state

)

Note

Must not be editing or already restoring the document while restoring from a state.

References CRASH_TRACER.

endRestoringState()

void ARADocument::endRestoringState

(

)

References CRASH_TRACER.

storeObjectsForCopy()

juce::MemoryBlock ARADocument::storeObjectsForCopy	(	ARAAudioSourceRef	source,
		ARAAudioModificationRef	modification
	)

Store a partial ARA archive containing just the given audio source and modification.

Used by clipboard copy to capture ARA plugin edits (e.g. Melodyne note corrections).

References CRASH_TRACER.

restoreObjectsForPaste()

void ARADocument::restoreObjectsForPaste	(	const juce::MemoryBlock &	data,
		const juce::String &	archivedSourceID,
		const juce::String &	currentSourceID,
		const juce::String &	archivedModID,
		const juce::String &	currentModID
	)

Restore a partial ARA archive, mapping archived persistent IDs to current ones.

Used by clipboard paste to restore ARA plugin edits into a newly pasted clip.

References CRASH_TRACER.

willCreatePlaybackRegionOnTrack()

void ARADocument::willCreatePlaybackRegionOnTrack

(

Track *

track

)

Referenced by PlaybackRegionWrapper::PlaybackRegionWrapper().

willDestroyPlaybackRegionOnTrack()

void ARADocument::willDestroyPlaybackRegionOnTrack

(

Track *

track

)

Referenced by PlaybackRegionWrapper::~PlaybackRegionWrapper().

Member Data Documentation

edit

Edit& ARADocument::edit

Referenced by AudioModificationWrapper::AudioModificationWrapper(), MusicalContextWrapper::MusicalContextWrapper(), PlaybackRegionWrapper::PlaybackRegionWrapper(), and RegionSequenceWrapper::RegionSequenceWrapper().

dci

const ARADocumentControllerInterface* ARADocument::dci

Referenced by AudioModificationWrapper::AudioModificationWrapper(), AudioSourceWrapper::AudioSourceWrapper(), AudioSourceWrapper::enableAccess(), MusicalContextWrapper::MusicalContextWrapper(), PlaybackRegionWrapper::PlaybackRegionWrapper(), RegionSequenceWrapper::RegionSequenceWrapper(), MusicalContextWrapper::update(), PlaybackRegionWrapper::updateRange(), AudioModificationWrapper::~AudioModificationWrapper(), AudioSourceWrapper::~AudioSourceWrapper(), MusicalContextWrapper::~MusicalContextWrapper(), PlaybackRegionWrapper::~PlaybackRegionWrapper(), and RegionSequenceWrapper::~RegionSequenceWrapper().

dcRef

ARADocumentControllerRef ARADocument::dcRef

Referenced by AudioModificationWrapper::AudioModificationWrapper(), AudioSourceWrapper::AudioSourceWrapper(), AudioSourceWrapper::enableAccess(), MusicalContextWrapper::MusicalContextWrapper(), PlaybackRegionWrapper::PlaybackRegionWrapper(), RegionSequenceWrapper::RegionSequenceWrapper(), MusicalContextWrapper::update(), PlaybackRegionWrapper::updateRange(), AudioModificationWrapper::~AudioModificationWrapper(), AudioSourceWrapper::~AudioSourceWrapper(), MusicalContextWrapper::~MusicalContextWrapper(), PlaybackRegionWrapper::~PlaybackRegionWrapper(), and RegionSequenceWrapper::~RegionSequenceWrapper().

musicalContext

std::unique_ptr<MusicalContextWrapper> ARADocument::musicalContext

Referenced by PlaybackRegionWrapper::getPlaybackRegionProperties(), RegionSequenceWrapper::getRegionSequenceProperties(), and PlaybackRegionWrapper::PlaybackRegionWrapper().

regionSequences

std::map<Track*, std::unique_ptr<RegionSequenceWrapper> > ARADocument::regionSequences

Referenced by PlaybackRegionWrapper::getPlaybackRegionProperties().

regionSequencePlaybackRegionCount

std::map<Track*, int> ARADocument::regionSequencePlaybackRegionCount

lastArchiveState

std::unique_ptr<juce::MemoryBlock> ARADocument::lastArchiveState

---

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

• tracktion_ARAWrapperInterfaces.h