juce::ARADocument Class Reference

#include <juce_ARAModelObjects.h>

Inheritance diagram for juce::ARADocument:

Public Types
using	PropertiesPtr = ARA::PlugIn::PropertiesPtr<ARA::ARADocumentProperties>
using	Listener = ARADocumentListener

Public Member Functions
template<typename AudioSource_t = ARAAudioSource>
const std::vector< AudioSource_t * > &	getAudioSources () const noexcept
template<typename MusicalContext_t = ARAMusicalContext>
const std::vector< MusicalContext_t * > &	getMusicalContexts () const noexcept
template<typename RegionSequence_t = ARARegionSequence>
const std::vector< RegionSequence_t * > &	getRegionSequences () const noexcept
size_t	getNumChildren () const noexcept override
ARAObject *	getChild (size_t index) override
ARAObject *	getParent () override
void	visit (ARAObjectVisitor &visitor) override
Public Member Functions inherited from juce::ARAListenableModelClass< ARADocumentListener >
	ARAListenableModelClass ()=default
virtual	~ARAListenableModelClass ()=default
void	addListener (ARADocumentListener *l)
void	removeListener (ARADocumentListener *l)
void	notifyListeners (Callback &&callback)
Public Member Functions inherited from juce::ARAObject
virtual	~ARAObject ()=default
template<typename Fn>
void	traverse (Fn &&fn)

Detailed Description

Base class representing an ARA document.

@tags{ARA}

Member Typedef Documentation

Listener

using juce::ARADocument::Listener = ARADocumentListener

PropertiesPtr

using juce::ARADocument::PropertiesPtr = ARA::PlugIn::PropertiesPtr<ARA::ARADocumentProperties>

Member Function Documentation

getAudioSources()

template<typename AudioSource_t = ARAAudioSource>

const std::vector< AudioSource_t * > & juce::ARADocument::getAudioSources ( ) const

inlinenoexcept

Returns the result of ARA::PlugIn::Document::getAudioSources() with the pointers within cast to ARAAudioSource*.

If you have overridden ARADocumentControllerSpecialisation::doCreateAudioSource(), then you can use the template parameter to cast the pointers to your subclass of ARAAudioSource.

getChild()

ARAObject * juce::ARADocument::getChild ( size_t index )

overridevirtual

Returns the child object associated with the given index.

The index should be smaller than the value returned by getNumChildren().

Note that the index of a particular object may change when the ARA model graph is edited.

Implements juce::ARAObject.

getMusicalContexts()

template<typename MusicalContext_t = ARAMusicalContext>

const std::vector< MusicalContext_t * > & juce::ARADocument::getMusicalContexts ( ) const

inlinenoexcept

Returns the result of ARA::PlugIn::Document::getMusicalContexts() with the pointers within cast to ARAMusicalContext*.

If you have overridden ARADocumentControllerSpecialisation::doCreateMusicalContext(), then you can use the template parameter to cast the pointers to your subclass of ARAMusicalContext.

getNumChildren()

size_t juce::ARADocument::getNumChildren ( ) const

overridevirtualnoexcept

Returns the number of ARA model objects aggregated by this object. Objects that are merely referred to, but not aggregated by the current object are not included in this count, e.g. a referenced RegionSequence does not count as a child of the referring PlaybackRegion.

See the ARA documentation's ARA Model Graph Overview for more details.

Implements juce::ARAObject.

getParent()

ARAObject * juce::ARADocument::getParent ( )

inlineoverridevirtual

Returns the ARA model object that aggregates this object.

Returns nullptr for the ARADocument root object.

Implements juce::ARAObject.

getRegionSequences()

template<typename RegionSequence_t = ARARegionSequence>

const std::vector< RegionSequence_t * > & juce::ARADocument::getRegionSequences ( ) const

inlinenoexcept

Returns the result of ARA::PlugIn::Document::getRegionSequences() with the pointers within cast to ARARegionSequence*.

If you have overridden ARADocumentControllerSpecialisation::doCreateRegionSequence(), then you can use the template parameter to cast the pointers to your subclass of ARARegionSequence.

visit()

void juce::ARADocument::visit ( ARAObjectVisitor & visitor )

inlineoverridevirtual

Allows the retrieval of the concrete type of a model object.

To use this, create a new class derived from ARAObjectVisitor and override its functions depending on which concrete types you are interested in.

Calling this function inside the function passed to ARAObject::traverse() allows you to map the entire ARA model graph.

Implements juce::ARAObject.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/ARA/juce_ARAModelObjects.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/ARA/juce_ARAModelObjects.cpp