JUCE: ARAAudioModification Class Reference

JUCE

Public Types | Public Member Functions | List of all members
ARAAudioModification Class Reference
juce_audio_processors » utilities

Base class representing an ARA audio modification. More...

`#include <juce_ARAModelObjects.h>`

Inheritance diagram for ARAAudioModification:

## Public Types
using | PropertiesPtr = ARA::PlugIn::PropertiesPtr< ARA::ARAAudioModificationProperties >
using | Listener = ARAAudioModificationListener

## Public Member Functions
template<typename AudioSource_t = ARAAudioSource>
AudioSource_t * | getAudioSource () const noexcept
| Returns the result of ARA::PlugIn::AudioModification::getAudioSource() with the pointer cast to ARAAudioSource*. More...
template<typename PlaybackRegion_t = ARAPlaybackRegion>
const std::vector< PlaybackRegion_t * > & | getPlaybackRegions () const noexcept
| Returns the result of ARA::PlugIn::AudioModification::getPlaybackRegions() with the pointers within cast to ARAPlaybackRegion*. More...
size_t | getNumChildren () const noexcept override
| Returns the number of ARA model objects aggregated by this object. More...
ARAObject * | getChild (size_t index) override
| Returns the child object associated with the given index. More...
ARAObject * | getParent () override
| Returns the ARA model object that aggregates this object. More...
void | visit (ARAObjectVisitor &visitor) override
| Allows the retrieval of the concrete type of a model object. More...
void | notifyContentChanged (ARAContentUpdateScopes scopeFlags, bool notifyARAHost)
| Notify the ARA host and any listeners of a content update initiated by the plug-in. More...
Public Member Functions inherited from ARAListenableModelClass< ARAAudioModificationListener >
| ARAListenableModelClass ()=default
| Constructor. More...
virtual | ~ARAListenableModelClass ()=default
| Destructor. More...
void | addListener (ARAAudioModificationListener *l)
| Subscribe `l` to notified by changes to the object. More...
void | removeListener (ARAAudioModificationListener *l)
| Unsubscribe `l` from object notifications. More...
void | notifyListeners (Callback &&callback)
| Call the provided callback for each of the added listeners. More...
Public Member Functions inherited from ARAObject
virtual | ~ARAObject ()=default
| Destructor. More...
virtual size_t | getNumChildren () const noexcept=0
| Returns the number of ARA model objects aggregated by this object. More...
virtual ARAObject * | getChild (size_t index)=0
| Returns the child object associated with the given index. More...
virtual ARAObject * | getParent ()=0
| Returns the ARA model object that aggregates this object. More...
template<typename Fn >
void | traverse (Fn &&fn)
| Implements a depth first traversal of the ARA model graph starting from the current object, and visiting its children recursively. More...
virtual void | visit (ARAObjectVisitor &visitor)=0
| Allows the retrieval of the concrete type of a model object. More...

## Detailed Description

Base class representing an ARA audio modification.

## Member Typedef Documentation

## ◆ PropertiesPtr

using ARAAudioModification::PropertiesPtr = ARA::PlugIn::PropertiesPtr<ARA::ARAAudioModificationProperties>

## ◆ Listener

using ARAAudioModification::Listener = ARAAudioModificationListener

## Member Function Documentation

## ◆ getAudioSource()

template<typename AudioSource_t = ARAAudioSource>

AudioSource_t * ARAAudioModification::getAudioSource | ( |  | ) | const
| noexcept

Returns the result of ARA::PlugIn::AudioModification::getAudioSource() with the pointer 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.

## ◆ getPlaybackRegions()

template<typename PlaybackRegion_t = ARAPlaybackRegion>

const std::vector< PlaybackRegion_t * > & ARAAudioModification::getPlaybackRegions | ( |  | ) | const
| noexcept

Returns the result of ARA::PlugIn::AudioModification::getPlaybackRegions() with the pointers within cast to ARAPlaybackRegion*.

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

## ◆ getNumChildren()

size_t ARAAudioModification::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 ARAObject.

## ◆ getChild()

ARAObject * ARAAudioModification::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 ARAObject.

## ◆ getParent()

ARAObject * ARAAudioModification::getParent | ( |  | ) |
| overridevirtual

Returns the ARA model object that aggregates this object.

Returns nullptr for the ARADocument root object.

Implements ARAObject.

## ◆ visit()

void ARAAudioModification::visit | ( | ARAObjectVisitor & | visitor | ) |
| overridevirtual

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 ARAObject.

References ARAObjectVisitor::visitAudioModification().

## ◆ notifyContentChanged()

void ARAAudioModification::notifyContentChanged | ( | ARAContentUpdateScopes | scopeFlags,
|  | bool | notifyARAHost
| ) |  |

Notify the ARA host and any listeners of a content update initiated by the plug-in.

This must be called by the plug-in model management code on the message thread whenever updating the internal content representation, such as after the user editing the pitch of a note. Listeners will be notified immediately. If `notifyARAHost` is true, a notification to the host will be enqueued and sent out the next time it polls for updates. `notifyARAHost` must be false if the updated content is being restored from an archive.

Parameters

  scopeFlags | The scope of the content update.
  notifyARAHost | If true, the ARA host will be notified of the content change.

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

- juce_ARAModelObjects.h