JUCE
Public Member Functions | List of all members
ARAAudioModificationListener Class Reference

A base class for listeners that want to know about changes to an ARAAudioModification object. More...

Inheritance diagram for ARAAudioModificationListener:

Public Member Functions

virtual ~ARAAudioModificationListener ()=default
 Destructor. More...
 
virtual ARA_DISABLE_UNREFERENCED_PARAMETER_WARNING_BEGIN void willUpdateAudioModificationProperties (ARAAudioModification *audioModification, ARA::PlugIn::PropertiesPtr< ARA::ARAAudioModificationProperties > newProperties)
 Called before the audio modification's properties are updated. More...
 
virtual void didUpdateAudioModificationProperties (ARAAudioModification *audioModification)
 Called after the audio modification's properties are updated. More...
 
virtual void didUpdateAudioModificationContent (ARAAudioModification *audioModification, ARAContentUpdateScopes scopeFlags)
 Called when the audio modification's content (i.e. More...
 
virtual void willDeactivateAudioModificationForUndoHistory (ARAAudioModification *audioModification, bool deactivate)
 Called before an audio modification is activated or deactivated when being removed / added from the host's undo history. More...
 
virtual void didDeactivateAudioModificationForUndoHistory (ARAAudioModification *audioModification, bool deactivate)
 Called after an audio modification is activated or deactivated when being removed / added from the host's undo history. More...
 
virtual void didAddPlaybackRegionToAudioModification (ARAAudioModification *audioModification, ARAPlaybackRegion *playbackRegion)
 Called after a playback region is added to the audio modification. More...
 
virtual void willRemovePlaybackRegionFromAudioModification (ARAAudioModification *audioModification, ARAPlaybackRegion *playbackRegion)
 Called before a playback region is removed from the audio modification. More...
 
virtual void willDestroyAudioModification (ARAAudioModification *audioModification)
 Called before the audio modification is destroyed. More...
 

Detailed Description

A base class for listeners that want to know about changes to an ARAAudioModification object.

Use ARAAudioModification::addListener() to register your listener with an ARAAudioModification.

Constructor & Destructor Documentation

◆ ~ARAAudioModificationListener()

virtual ARAAudioModificationListener::~ARAAudioModificationListener ( )
virtualdefault

Destructor.

Member Function Documentation

◆ willUpdateAudioModificationProperties()

virtual ARA_DISABLE_UNREFERENCED_PARAMETER_WARNING_BEGIN void ARAAudioModificationListener::willUpdateAudioModificationProperties ( ARAAudioModification audioModification,
ARA::PlugIn::PropertiesPtr< ARA::ARAAudioModificationProperties >  newProperties 
)
virtual

Called before the audio modification's properties are updated.

Parameters
audioModificationThe audio modification whose properties will be updated.
newPropertiesThe audio modification properties that will be assigned to audioModification.

References ignoreUnused().

◆ didUpdateAudioModificationProperties()

virtual void ARAAudioModificationListener::didUpdateAudioModificationProperties ( ARAAudioModification audioModification)
virtual

Called after the audio modification's properties are updated.

Parameters
audioModificationThe audio modification whose properties were updated.

References ignoreUnused().

◆ didUpdateAudioModificationContent()

virtual void ARAAudioModificationListener::didUpdateAudioModificationContent ( ARAAudioModification audioModification,
ARAContentUpdateScopes  scopeFlags 
)
virtual

Called when the audio modification's content (i.e.

samples or notes) changes.

Parameters
audioModificationThe audio modification with updated content.
scopeFlagsThe scope of the content update.

References ignoreUnused().

◆ willDeactivateAudioModificationForUndoHistory()

virtual void ARAAudioModificationListener::willDeactivateAudioModificationForUndoHistory ( ARAAudioModification audioModification,
bool  deactivate 
)
virtual

Called before an audio modification is activated or deactivated when being removed / added from the host's undo history.

Parameters
audioModificationThe audio modification that was activated or deactivated
deactivateA bool indicating whether audioModification was deactivated or activated.

References ignoreUnused().

◆ didDeactivateAudioModificationForUndoHistory()

virtual void ARAAudioModificationListener::didDeactivateAudioModificationForUndoHistory ( ARAAudioModification audioModification,
bool  deactivate 
)
virtual

Called after an audio modification is activated or deactivated when being removed / added from the host's undo history.

Parameters
audioModificationThe audio modification that was activated or deactivated
deactivateA bool indicating whether audioModification was deactivated or activated.

References ignoreUnused().

◆ didAddPlaybackRegionToAudioModification()

virtual void ARAAudioModificationListener::didAddPlaybackRegionToAudioModification ( ARAAudioModification audioModification,
ARAPlaybackRegion playbackRegion 
)
virtual

Called after a playback region is added to the audio modification.

Parameters
audioModificationThe audio modification that playbackRegion was added to.
playbackRegionThe playback region that was added to audioModification.

References ignoreUnused().

◆ willRemovePlaybackRegionFromAudioModification()

virtual void ARAAudioModificationListener::willRemovePlaybackRegionFromAudioModification ( ARAAudioModification audioModification,
ARAPlaybackRegion playbackRegion 
)
virtual

Called before a playback region is removed from the audio modification.

Parameters
audioModificationThe audio modification that playbackRegion will be removed from.
playbackRegionThe playback region that will be removed from audioModification.

References ignoreUnused().

◆ willDestroyAudioModification()

virtual void ARAAudioModificationListener::willDestroyAudioModification ( ARAAudioModification audioModification)
virtual

Called before the audio modification is destroyed.

Parameters
audioModificationThe audio modification that will be destroyed.

References ignoreUnused().


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