tracktion::engine::ARAFileReader Class Reference

Manages an ARA plugin instance for an audio clip. More...

#include <tracktion_ARAFileReader.h>

Inherits juce::ReferenceCountedObject, and juce::ChangeBroadcaster.

Public Types
using	Ptr = juce::ReferenceCountedObjectPtr< ARAFileReader >

Public Member Functions
	ARAFileReader (Edit &, AudioClipBase &)
	ARAFileReader (Edit &, AudioClipBase &, ARAFileReader &oneToClone)
	~ARAFileReader ()
bool	isValid () const noexcept
ExternalPlugin *	getPlugin ()
void	showPluginWindow ()
void	hidePluginWindow ()
bool	isAnalysingContent ()
juce::MidiMessageSequence	getAnalysedMIDISequence ()
void	sourceClipChanged ()
void	contentHasChanged ()
	Notifies that the ARA content has changed (e.g.
juce::MemoryBlock	storeARAArchiveForCopy ()
	Store a partial ARA archive of this clip's plugin edits for copy/paste.
void	restoreARAArchiveForPaste (const juce::MemoryBlock &data, const juce::String &archivedSourceID, const juce::String &archivedModID)
	Restore a partial ARA archive into this clip after paste.
juce::String	getAudioSourcePersistentID () const
	Returns the persistent ID of the current audio source, or empty if ARA is not active.
juce::String	getAudioModificationPersistentID () const
	Returns the persistent ID of the current audio modification, or empty if ARA is not active.

Static Public Member Functions
static void	cleanUpOnShutdown ()

Detailed Description

Manages an ARA plugin instance for an audio clip.

This class handles the ARA (Audio Random Access) integration, allowing plugins like Melodyne to provide advanced audio analysis and manipulation.

Member Typedef Documentation

Ptr

using tracktion::engine::ARAFileReader::Ptr = juce::ReferenceCountedObjectPtr<ARAFileReader>

Constructor & Destructor Documentation

ARAFileReader() [1/2]

tracktion::engine::ARAFileReader::ARAFileReader	(	Edit &	,
		AudioClipBase &
	)

ARAFileReader() [2/2]

tracktion::engine::ARAFileReader::ARAFileReader	(	Edit &	,
		AudioClipBase &	,
		ARAFileReader &	oneToClone
	)

~ARAFileReader()

tracktion::engine::ARAFileReader::~ARAFileReader

(

)

Member Function Documentation

cleanUpOnShutdown()

static void tracktion::engine::ARAFileReader::cleanUpOnShutdown ( )

static

isValid()

bool tracktion::engine::ARAFileReader::isValid ( ) const

noexcept

getPlugin()

ExternalPlugin * tracktion::engine::ARAFileReader::getPlugin

(

)

showPluginWindow()

void tracktion::engine::ARAFileReader::showPluginWindow

(

)

hidePluginWindow()

void tracktion::engine::ARAFileReader::hidePluginWindow

(

)

isAnalysingContent()

bool tracktion::engine::ARAFileReader::isAnalysingContent

(

)

getAnalysedMIDISequence()

juce::MidiMessageSequence tracktion::engine::ARAFileReader::getAnalysedMIDISequence

(

)

sourceClipChanged()

void tracktion::engine::ARAFileReader::sourceClipChanged

(

)

contentHasChanged()

void tracktion::engine::ARAFileReader::contentHasChanged

(

)

Notifies that the ARA content has changed (e.g.

notes edited in Melodyne). This re-reads the content and broadcasts a change message.

storeARAArchiveForCopy()

juce::MemoryBlock tracktion::engine::ARAFileReader::storeARAArchiveForCopy

(

)

Store a partial ARA archive of this clip's plugin edits for copy/paste.

Returns an empty MemoryBlock if ARA is not active.

restoreARAArchiveForPaste()

void tracktion::engine::ARAFileReader::restoreARAArchiveForPaste	(	const juce::MemoryBlock &	data,
		const juce::String &	archivedSourceID,
		const juce::String &	archivedModID
	)

Restore a partial ARA archive into this clip after paste.

Parameters

data	The archive data (from storeARAArchiveForCopy)
archivedSourceID	The audio source persistent ID from when the archive was created
archivedModID	The audio modification persistent ID from when the archive was created

getAudioSourcePersistentID()

juce::String tracktion::engine::ARAFileReader::getAudioSourcePersistentID

(

)

const

Returns the persistent ID of the current audio source, or empty if ARA is not active.

getAudioModificationPersistentID()

juce::String tracktion::engine::ARAFileReader::getAudioModificationPersistentID

(

)

const

Returns the persistent ID of the current audio modification, or empty if ARA is not active.

---

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

• tracktion_ARAFileReader.h