This class contains the customisation points for the JUCE provided ARA document controller implementation. More...

#include <juce_ARADocumentController.h>

Inheritance diagram for juce::ARADocumentControllerSpecialisation:

[legend]

Collaboration diagram for juce::ARADocumentControllerSpecialisation:

[legend]

Classes
class	FactoryConfig

Public Member Functions
	ARADocumentControllerSpecialisation (const ARA::PlugIn::PlugInEntry entry, const ARA::ARADocumentControllerHostInstance instance)
	Constructor.

virtual	~ARADocumentControllerSpecialisation ()
	Destructor.

virtual void	didAddAudioModificationToAudioSource (ARAAudioSource audioSource, ARAAudioModification audioModification)
	Called after an audio modification is added to the audio source.

virtual void	didAddAudioSourceToDocument (ARADocument document, ARAAudioSource audioSource)
	Called after an audio source is added to the document.

virtual void	didAddMusicalContextToDocument (ARADocument document, ARAMusicalContext musicalContext)
	Called after a musical context is added to the document.

virtual void	didAddPlaybackRegionToAudioModification (ARAAudioModification audioModification, ARAPlaybackRegion playbackRegion)
	Called after a playback region is added to the audio modification.

virtual void	didAddPlaybackRegionToRegionSequence (ARARegionSequence regionSequence, ARAPlaybackRegion playbackRegion)
	Called after a playback region is added to the region sequence.

virtual void	didAddRegionSequenceToDocument (ARADocument document, ARARegionSequence regionSequence)
	Called after a region sequence is added to the document.

virtual void	didAddRegionSequenceToMusicalContext (ARAMusicalContext musicalContext, ARARegionSequence regionSequence)
	Called after a region sequence is added to the musical context.

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.

virtual void	didDeactivateAudioSourceForUndoHistory (ARAAudioSource *audioSource, bool deactivate)
	Called after an audio source is activated or deactivated when being removed / added from the host's undo history.

virtual void	didEnableAudioSourceSamplesAccess (ARAAudioSource *audioSource, bool enable)
	Called after access to an audio source's samples is enabled or disabled.

virtual void	didEndEditing (ARADocument *document)
	Called after the document exits an editing state.

virtual void	didNotifyModelUpdates (ARADocument *document)
	Called after sending model updates do the host.

virtual void	didReorderMusicalContextsInDocument (ARADocument *document)
	Called after the musical contexts are reordered in an ARA document.

virtual void	didReorderRegionSequencesInDocument (ARADocument *document)
	Called after the region sequences are reordered in an ARA document.

virtual void	didReorderRegionSequencesInMusicalContext (ARAMusicalContext *musicalContext)
	Called after the region sequences are reordered in an ARA MusicalContext.

virtual void	didUpdateAudioModificationContent (ARAAudioModification *audioModification, ARAContentUpdateScopes scopeFlags)
	Called when the audio modification's content (i.e.

virtual void	didUpdateAudioModificationProperties (ARAAudioModification *audioModification)
	Called after the audio modification's properties are updated.

virtual void	didUpdateAudioSourceAnalysisProgress (ARAAudioSource *audioSource, ARA::ARAAnalysisProgressState state, float progress)
	Called to notify progress when an audio source is being analyzed.

virtual void	didUpdateAudioSourceProperties (ARAAudioSource *audioSource)
	Called after the audio source's properties are updated.

virtual void	didUpdateDocumentProperties (ARADocument *document)
	Called after the document's properties are updated.

virtual void	didUpdateMusicalContextProperties (ARAMusicalContext *musicalContext)
	Called after the musical context's properties are updated by the host.

virtual void	didUpdatePlaybackRegionContent (ARAPlaybackRegion *playbackRegion, ARAContentUpdateScopes scopeFlags)
	Called when the playback region's content (i.e.

virtual void	didUpdatePlaybackRegionProperties (ARAPlaybackRegion *playbackRegion)
	Called after the playback region's properties are updated.

virtual void	didUpdateRegionSequenceProperties (ARARegionSequence *regionSequence)
	Called after the region sequence's properties are updated.

virtual void	doUpdateAudioSourceContent (ARAAudioSource *audioSource, ARAContentUpdateScopes scopeFlags)
	Called when the audio source's content (i.e.

virtual void	doUpdateMusicalContextContent (ARAMusicalContext *musicalContext, ARAContentUpdateScopes scopeFlags)
	Called when the musical context's content (i.e tempo entries or chords) changes.

template<typename DocumentType = ARADocument>
DocumentType *	getDocument ()
	Returns a pointer to the ARA document root maintained by this document controller.

ARA::PlugIn::DocumentController *	getDocumentController () noexcept
	Returns the underlying DocumentController object that references this specialisation.

virtual void	willBeginEditing (ARADocument *document)
	Called before the document enters an editing state.

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.

virtual void	willDeactivateAudioSourceForUndoHistory (ARAAudioSource *audioSource, bool deactivate)
	Called before an audio source is activated or deactivated when being removed / added from the host's undo history.

virtual void	willDestroyAudioModification (ARAAudioModification *audioModification)
	Called before the audio modification is destroyed.

virtual void	willDestroyAudioSource (ARAAudioSource *audioSource)
	Called before the audio source is destroyed.

virtual void	willDestroyDocument (ARADocument *document)
	Called before the document is destroyed by the ARA host.

virtual void	willDestroyMusicalContext (ARAMusicalContext *musicalContext)
	Called before the musical context is destroyed.

virtual void	willDestroyPlaybackRegion (ARAPlaybackRegion *playbackRegion)
	Called before the playback region is destroyed.

virtual void	willDestroyRegionSequence (ARARegionSequence *regionSequence)
	Called before the region sequence is destroyed.

virtual void	willEnableAudioSourceSamplesAccess (ARAAudioSource *audioSource, bool enable)
	Called before access to an audio source's samples is enabled or disabled.

virtual void	willNotifyModelUpdates (ARADocument *document)
	Called before sending model updates do the host.

virtual void	willRemoveAudioModificationFromAudioSource (ARAAudioSource audioSource, ARAAudioModification audioModification)
	Called before an audio modification is removed from the audio source.

virtual void	willRemoveAudioSourceFromDocument (ARADocument document, ARAAudioSource audioSource)
	Called before an audio source is removed from the document.

virtual void	willRemoveMusicalContextFromDocument (ARADocument document, ARAMusicalContext musicalContext)
	Called before a musical context is removed from the document.

virtual void	willRemovePlaybackRegionFromAudioModification (ARAAudioModification audioModification, ARAPlaybackRegion playbackRegion)
	Called before a playback region is removed from the audio modification.

virtual void	willRemovePlaybackRegionFromRegionSequence (ARARegionSequence regionSequence, ARAPlaybackRegion playbackRegion)
	Called before a playback region is removed from the region sequence.

virtual void	willRemoveRegionSequenceFromDocument (ARADocument document, ARARegionSequence regionSequence)
	Called before a region sequence is removed from the document.

virtual void	willRemoveRegionSequenceFromMusicalContext (ARAMusicalContext musicalContext, ARARegionSequence regionSequence)
	Called before a region sequence is removed from the musical context.

virtual void	willUpdateAudioModificationProperties (ARAAudioModification *audioModification, ARA::PlugIn::PropertiesPtr< ARA::ARAAudioModificationProperties > newProperties)
	Called before the audio modification's properties are updated.

virtual void	willUpdateAudioSourceProperties (ARAAudioSource *audioSource, ARA::PlugIn::PropertiesPtr< ARA::ARAAudioSourceProperties > newProperties)
	Called before the audio source's properties are updated.

virtual void	willUpdateDocumentProperties (ARADocument *document, ARA::PlugIn::PropertiesPtr< ARA::ARADocumentProperties > newProperties)
	Called before the document's properties are updated.

virtual void	willUpdateMusicalContextProperties (ARAMusicalContext *musicalContext, ARA::PlugIn::PropertiesPtr< ARA::ARAMusicalContextProperties > newProperties)
	Called before the musical context's properties are updated.

virtual void	willUpdatePlaybackRegionProperties (ARAPlaybackRegion *playbackRegion, ARA::PlugIn::PropertiesPtr< ARA::ARAPlaybackRegionProperties > newProperties)
	Called before the playback region's properties are updated.

virtual void	willUpdateRegionSequenceProperties (ARARegionSequence *regionSequence, ARA::PlugIn::PropertiesPtr< ARA::ARARegionSequenceProperties > newProperties)
	Called before the region sequence's properties are updated.

Static Public Member Functions
template<typename SpecialisationType >
static const ARA::ARAFactory *	createARAFactory ()
	Helper function for implementing the global createARAFactory() function.

template<typename Specialisation = ARADocumentControllerSpecialisation>
static Specialisation *	getSpecialisedDocumentController (ARA::PlugIn::DocumentController *dc)
	Returns a pointer to the ARADocumentControllerSpecialisation instance that is referenced by the provided DocumentController.

Protected Member Functions
virtual ARAAudioModification *	doCreateAudioModification (ARAAudioSource audioSource, ARA::ARAAudioModificationHostRef hostRef, const ARAAudioModification optionalModificationToClone)
	Override to return a custom subclass instance of ARAAudioModification.

virtual ARA::PlugIn::ContentReader *	doCreateAudioModificationContentReader (ARA::PlugIn::AudioModification audioModification, ARA::ARAContentType type, const ARA::ARAContentTimeRange range)
	Override to implement createAudioModificationContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested `type`.

virtual ARAAudioSource *	doCreateAudioSource (ARADocument *document, ARA::ARAAudioSourceHostRef hostRef)
	Override to return a custom subclass instance of ARAAudioSource.

virtual ARA::PlugIn::ContentReader *	doCreateAudioSourceContentReader (ARA::PlugIn::AudioSource audioSource, ARA::ARAContentType type, const ARA::ARAContentTimeRange range)
	Override to implement createAudioSourceContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested type.

virtual ARADocument *	doCreateDocument ()
	Override to return a custom subclass instance of ARADocument.

virtual ARAEditorRenderer *	doCreateEditorRenderer ()
	Override to return a custom subclass instance of ARAEditorRenderer.

virtual ARAEditorView *	doCreateEditorView ()
	Override to return a custom subclass instance of ARAEditorView.

virtual ARAMusicalContext *	doCreateMusicalContext (ARADocument *document, ARA::ARAMusicalContextHostRef hostRef)
	Override to return a custom subclass instance of ARAMusicalContext.

virtual ARAPlaybackRegion *	doCreatePlaybackRegion (ARAAudioModification *modification, ARA::ARAPlaybackRegionHostRef hostRef)
	Override to return a custom subclass instance of ARAPlaybackRegion.

virtual ARA::PlugIn::ContentReader *	doCreatePlaybackRegionContentReader (ARA::PlugIn::PlaybackRegion playbackRegion, ARA::ARAContentType type, const ARA::ARAContentTimeRange range)
	Override to implement createPlaybackRegionContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested type.

virtual ARAPlaybackRenderer *	doCreatePlaybackRenderer ()
	Override to return a custom subclass instance of ARAPlaybackRenderer.

virtual ARARegionSequence *	doCreateRegionSequence (ARADocument *document, ARA::ARARegionSequenceHostRef hostRef)
	Override to return a custom subclass instance of ARARegionSequence.

virtual ARA::ARAContentGrade	doGetAudioModificationContentGrade (const ARA::PlugIn::AudioModification *audioModification, ARA::ARAContentType type)
	Override to implement getAudioModificationContentGrade() for all your supported content types.

virtual ARA::ARAContentGrade	doGetAudioSourceContentGrade (const ARA::PlugIn::AudioSource *audioSource, ARA::ARAContentType type)
	Override to implement getAudioSourceContentGrade() for all your supported content types.

virtual ARA::ARAContentGrade	doGetPlaybackRegionContentGrade (const ARA::PlugIn::PlaybackRegion *playbackRegion, ARA::ARAContentType type)
	Override to implement getPlaybackRegionContentGrade() for all your supported content types.

virtual void	doGetPlaybackRegionHeadAndTailTime (const ARA::PlugIn::PlaybackRegion playbackRegion, ARA::ARATimeDuration headTime, ARA::ARATimeDuration *tailTime)
	Override to implement getPlaybackRegionHeadAndTailTime().

virtual ARA::ARAInt32	doGetProcessingAlgorithmForAudioSource (const ARA::PlugIn::AudioSource *audioSource)
	Override to implement getProcessingAlgorithmForAudioSource().

virtual const ARA::ARAProcessingAlgorithmProperties *	doGetProcessingAlgorithmProperties (ARA::ARAInt32 algorithmIndex)
	Override to implement getProcessingAlgorithmProperties().

virtual ARA::ARAInt32	doGetProcessingAlgorithmsCount ()
	Override to implement getProcessingAlgorithmsCount().

virtual bool	doIsAudioModificationContentAvailable (const ARA::PlugIn::AudioModification *audioModification, ARA::ARAContentType type)
	Override to implement isAudioModificationContentAvailable() for all your supported content types - the default implementation always returns false.

virtual bool	doIsAudioSourceContentAnalysisIncomplete (const ARA::PlugIn::AudioSource *audioSource, ARA::ARAContentType type)
	Override to implement isAudioSourceContentAnalysisIncomplete().

virtual bool	doIsAudioSourceContentAvailable (const ARA::PlugIn::AudioSource *audioSource, ARA::ARAContentType type)
	Override to implement isAudioSourceContentAvailable() for all your supported content types - the default implementation always returns false, preventing any calls to doGetAudioSourceContentGrade() and doCreateAudioSourceContentReader().

virtual bool	doIsPlaybackRegionContentAvailable (const ARA::PlugIn::PlaybackRegion *playbackRegion, ARA::ARAContentType type)
	Override to implement isPlaybackRegionContentAvailable() for all your supported content types - the default implementation always returns false.

virtual void	doRequestAudioSourceContentAnalysis (ARA::PlugIn::AudioSource *audioSource, std::vector< ARA::ARAContentType > const &contentTypes)
	Override to implement requestAudioSourceContentAnalysis().

virtual void	doRequestProcessingAlgorithmForAudioSource (ARA::PlugIn::AudioSource *audioSource, ARA::ARAInt32 algorithmIndex)
	Override to implement requestProcessingAlgorithmForAudioSource().

virtual bool	doRestoreObjectsFromStream (ARAInputStream &input, const ARARestoreObjectsFilter *filter)=0
	Read an ARADocument archive from a juce::InputStream.

virtual bool	doStoreObjectsToStream (ARAOutputStream &output, const ARAStoreObjectsFilter *filter)=0
	Write an ARADocument archive to a juce::OutputStream.

Private Member Functions
ARADocument *	getDocumentImpl ()

Static Private Member Functions
static ARADocumentControllerSpecialisation *	getSpecialisedDocumentControllerImpl (ARA::PlugIn::DocumentController *)

Private Attributes
std::unique_ptr< ARADocumentControllerImpl >	documentController

Detailed Description

This class contains the customisation points for the JUCE provided ARA document controller implementation.

Every ARA enabled plugin must provide its own document controller implementation. To do this, inherit from this class, and override its protected methods as needed. Then you need to implement a global function somewhere in your module called createARAFactory(). This function must return an ARAFactory* that will instantiate document controller objects using your specialisation. There are helper functions inside ARADocumentControllerSpecialisation, so the implementation of createARAFactory() can always be a simple one-liner. For example

class MyDocumentController : public ARADocumentControllerSpecialisation
{
    //...
};
 
const ARA::ARAFactory* JUCE_CALLTYPE createARAFactory()
{
    return juce::ARADocumentControllerSpecialisation::createARAFactory<MyDocumentController>();
}

Most member functions have a default implementation so you can build up your required feature set gradually. The protected functions of this class fall in three distinct groups:

interactive editing and playback,
analysis features provided by the plugin and utilised by the host, and
maintaining the ARA model graph.

On top of the pure virtual functions, you will probably want to override doCreatePlaybackRenderer() at the very least if you want your plugin to play any sound. This function belongs to the first group.

If your plugin has analysis capabilities and wants to allow the host to access these, functions in the second group should be overridden.

The default implementation of the ARA model object classes - i.e. ARADocument, ARAMusicalContext, ARARegionSequence, ARAAudioSource, ARAAudioModification, ARAPlaybackRegion - should be sufficient for maintaining a representation of the ARA model graph, hence overriding the model object creation functions e.g. doCreateMusicalContext() is considered an advanced use case. Hence you should be able to get a lot done without overriding functions in the third group.

In order to react to the various ARA state changes you can override any of the ARA model object Listener functions that ARADocumentControllerSpecialisation inherits from. Such listener functions can be attached to one particular model objects instance, but the listener functions inside ARADocumentControllerSpecialisation will respond to the events of all instances of the model objects.

@tags{ARA}

Constructor & Destructor Documentation

◆ ARADocumentControllerSpecialisation()

juce::ARADocumentControllerSpecialisation::ARADocumentControllerSpecialisation	(	const ARA::PlugIn::PlugInEntry *	entry,
		const ARA::ARADocumentControllerHostInstance *	instance
	)

Constructor.

Used internally by the ARAFactory implementation.

◆ ~ARADocumentControllerSpecialisation()

virtual juce::ARADocumentControllerSpecialisation::~ARADocumentControllerSpecialisation ( )

virtual

Destructor.

Member Function Documentation

◆ createARAFactory()

template<typename SpecialisationType >

static const ARA::ARAFactory * juce::ARADocumentControllerSpecialisation::createARAFactory ( )

inlinestatic

Helper function for implementing the global createARAFactory() function.

For example

class MyDocumentController : public ARADocumentControllerSpecialisation
{
    //...
};
 
const ARA::ARAFactory* JUCE_CALLTYPE createARAFactory()
{
    return juce::ARADocumentControllerSpecialisation::createARAFactory<MyDocumentController>();
}

◆ didAddAudioModificationToAudioSource()

virtual void juce::ARAAudioSourceListener::didAddAudioModificationToAudioSource	(	ARAAudioSource *	audioSource,
		ARAAudioModification *	audioModification
	)

virtualinherited

Called after an audio modification is added to the audio source.

Parameters

audioSource	The region sequence that `audioModification` was added to.
audioModification	The playback region that was added to `audioSource`.

◆ didAddAudioSourceToDocument()

virtual void juce::ARADocumentListener::didAddAudioSourceToDocument	(	ARADocument *	document,
		ARAAudioSource *	audioSource
	)

virtualinherited

Called after an audio source is added to the document.

Parameters

document	The document that `audioSource` was added to.
audioSource	The audio source that was added to `document`.

◆ didAddMusicalContextToDocument()

virtual void juce::ARADocumentListener::didAddMusicalContextToDocument	(	ARADocument *	document,
		ARAMusicalContext *	musicalContext
	)

virtualinherited

Called after a musical context is added to the document.

Parameters

document	The document that `musicalContext` was added to.
musicalContext	The musical context that was added to `document`.

◆ didAddPlaybackRegionToAudioModification()

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

virtualinherited

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

Parameters

audioModification	The audio modification that `playbackRegion` was added to.
playbackRegion	The playback region that was added to `audioModification`.

◆ didAddPlaybackRegionToRegionSequence()

virtual void juce::ARARegionSequenceListener::didAddPlaybackRegionToRegionSequence	(	ARARegionSequence *	regionSequence,
		ARAPlaybackRegion *	playbackRegion
	)

virtualinherited

Called after a playback region is added to the region sequence.

Parameters

regionSequence	The region sequence that `playbackRegion` was added to.
playbackRegion	The playback region that was added to `regionSequence`.

◆ didAddRegionSequenceToDocument()

virtual void juce::ARADocumentListener::didAddRegionSequenceToDocument	(	ARADocument *	document,
		ARARegionSequence *	regionSequence
	)

virtualinherited

Called after a region sequence is added to the document.

Parameters

document	The document that `regionSequence` was added to.
regionSequence	The region sequence that was added to `document`.

◆ didAddRegionSequenceToMusicalContext()

virtual void juce::ARAMusicalContextListener::didAddRegionSequenceToMusicalContext	(	ARAMusicalContext *	musicalContext,
		ARARegionSequence *	regionSequence
	)

virtualinherited

Called after a region sequence is added to the musical context.

Parameters

musicalContext	The musical context that `regionSequence` was added to.
regionSequence	The region sequence that was added to `musicalContext`.

◆ didDeactivateAudioModificationForUndoHistory()

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

virtualinherited

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

Parameters

audioModification	The audio modification that was activated or deactivated
deactivate	A bool indicating whether `audioModification` was deactivated or activated.

◆ didDeactivateAudioSourceForUndoHistory()

virtual void juce::ARAAudioSourceListener::didDeactivateAudioSourceForUndoHistory	(	ARAAudioSource *	audioSource,
		bool	deactivate
	)

virtualinherited

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

Parameters

audioSource	The audio source that was activated or deactivated
deactivate	A bool indicating whether `audioSource` was deactivated or activated.

◆ didEnableAudioSourceSamplesAccess()

virtual void juce::ARAAudioSourceListener::didEnableAudioSourceSamplesAccess	(	ARAAudioSource *	audioSource,
		bool	enable
	)

virtualinherited

Called after access to an audio source's samples is enabled or disabled.

Parameters

audioSource	The audio source whose sample access state was changed.
enable	A bool indicating whether or not sample access was enabled or disabled.

Reimplemented in juce::ARAAudioSourceReader.

◆ didEndEditing()

virtual void juce::ARADocumentListener::didEndEditing ( ARADocument * document )

virtualinherited

Called after the document exits an editing state.

Parameters

document The document about exit an editing state.

◆ didNotifyModelUpdates()

virtual void juce::ARADocumentListener::didNotifyModelUpdates ( ARADocument * document )

virtualinherited

Called after sending model updates do the host.

Parameters

document The document whose model updates have just been sent.

◆ didReorderMusicalContextsInDocument()

virtual void juce::ARADocumentListener::didReorderMusicalContextsInDocument ( ARADocument * document )

virtualinherited

Called after the musical contexts are reordered in an ARA document.

Musical contexts are sorted by their order index - this callback signals a change in this ordering within the document.

Parameters

document The document with reordered musical contexts.

◆ didReorderRegionSequencesInDocument()

virtual void juce::ARADocumentListener::didReorderRegionSequencesInDocument ( ARADocument * document )

virtualinherited

Called after the region sequences are reordered in an ARA document.

Region sequences are sorted by their order index - this callback signals a change in this ordering within the document.

Parameters

document The document with reordered region sequences.

◆ didReorderRegionSequencesInMusicalContext()

virtual void juce::ARAMusicalContextListener::didReorderRegionSequencesInMusicalContext ( ARAMusicalContext * musicalContext )

virtualinherited

Called after the region sequences are reordered in an ARA MusicalContext.

Region sequences are sorted by their order index - this callback signals a change in this ordering within the musical context.

Parameters

musicalContext The musical context with reordered region sequences.

◆ didUpdateAudioModificationContent()

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

virtualinherited

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

samples or notes) changes.

Parameters

audioModification	The audio modification with updated content.
scopeFlags	The scope of the content update.

◆ didUpdateAudioModificationProperties()

virtual void juce::ARAAudioModificationListener::didUpdateAudioModificationProperties ( ARAAudioModification * audioModification )

virtualinherited

Called after the audio modification's properties are updated.

Parameters

audioModification The audio modification whose properties were updated.

◆ didUpdateAudioSourceAnalysisProgress()

virtual void juce::ARAAudioSourceListener::didUpdateAudioSourceAnalysisProgress	(	ARAAudioSource *	audioSource,
		ARA::ARAAnalysisProgressState	state,
		float	progress
	)

virtualinherited

Called to notify progress when an audio source is being analyzed.

Parameters

audioSource	The audio source being analyzed.
state	Indicates start, intermediate update or completion of the analysis.
progress	Progress normalized to the 0..1 range.

◆ didUpdateAudioSourceProperties()

virtual void juce::ARAAudioSourceListener::didUpdateAudioSourceProperties ( ARAAudioSource * audioSource )

virtualinherited

Called after the audio source's properties are updated.

Parameters

audioSource The audio source whose properties were updated.

◆ didUpdateDocumentProperties()

virtual void juce::ARADocumentListener::didUpdateDocumentProperties ( ARADocument * document )

virtualinherited

Called after the document's properties are updated.

Parameters

document The document whose properties were updated.

◆ didUpdateMusicalContextProperties()

virtual void juce::ARAMusicalContextListener::didUpdateMusicalContextProperties ( ARAMusicalContext * musicalContext )

virtualinherited

Called after the musical context's properties are updated by the host.

Parameters

musicalContext The musical context whose properties were updated.

◆ didUpdatePlaybackRegionContent()

virtual void juce::ARAPlaybackRegionListener::didUpdatePlaybackRegionContent	(	ARAPlaybackRegion *	playbackRegion,
		ARAContentUpdateScopes	scopeFlags
	)

virtualinherited

Called when the playback region's content (i.e.

samples or notes) changes.

Parameters

playbackRegion	The playback region with updated content.
scopeFlags	The scope of the content update.

Reimplemented in juce::ARAPlaybackRegionReader.

◆ didUpdatePlaybackRegionProperties()

virtual void juce::ARAPlaybackRegionListener::didUpdatePlaybackRegionProperties ( ARAPlaybackRegion * playbackRegion )

virtualinherited

Called after the playback region's properties are updated.

Parameters

playbackRegion The playback region whose properties were updated.

◆ didUpdateRegionSequenceProperties()

virtual void juce::ARARegionSequenceListener::didUpdateRegionSequenceProperties ( ARARegionSequence * regionSequence )

virtualinherited

Called after the region sequence's properties are updated.

Parameters

regionSequence The region sequence whose properties were updated.

◆ doCreateAudioModification()

virtual ARAAudioModification * juce::ARADocumentControllerSpecialisation::doCreateAudioModification	(	ARAAudioSource *	audioSource,
		ARA::ARAAudioModificationHostRef	hostRef,
		const ARAAudioModification *	optionalModificationToClone
	)

protectedvirtual

Override to return a custom subclass instance of ARAAudioModification.

◆ doCreateAudioModificationContentReader()

virtual ARA::PlugIn::ContentReader * juce::ARADocumentControllerSpecialisation::doCreateAudioModificationContentReader	(	ARA::PlugIn::AudioModification *	audioModification,
		ARA::ARAContentType	type,
		const ARA::ARAContentTimeRange *	range
	)

protectedvirtual

Override to implement createAudioModificationContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested type.

For read-only data directly inherited from the underlying audio source you can just delegate the call to the audio source, but user-editable modification data must be specifically handled here.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doCreateAudioModificationContentReader.

◆ doCreateAudioSource()

virtual ARAAudioSource * juce::ARADocumentControllerSpecialisation::doCreateAudioSource	(	ARADocument *	document,
		ARA::ARAAudioSourceHostRef	hostRef
	)

protectedvirtual

Override to return a custom subclass instance of ARAAudioSource.

◆ doCreateAudioSourceContentReader()

virtual ARA::PlugIn::ContentReader * juce::ARADocumentControllerSpecialisation::doCreateAudioSourceContentReader	(	ARA::PlugIn::AudioSource *	audioSource,
		ARA::ARAContentType	type,
		const ARA::ARAContentTimeRange *	range
	)

protectedvirtual

Override to implement createAudioSourceContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested type.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doCreateAudioSourceContentReader.

◆ doCreateDocument()

virtual ARADocument * juce::ARADocumentControllerSpecialisation::doCreateDocument ( )

protectedvirtual

Override to return a custom subclass instance of ARADocument.

◆ doCreateEditorRenderer()

virtual ARAEditorRenderer * juce::ARADocumentControllerSpecialisation::doCreateEditorRenderer ( )

protectedvirtual

Override to return a custom subclass instance of ARAEditorRenderer.

◆ doCreateEditorView()

virtual ARAEditorView * juce::ARADocumentControllerSpecialisation::doCreateEditorView ( )

protectedvirtual

Override to return a custom subclass instance of ARAEditorView.

◆ doCreateMusicalContext()

virtual ARAMusicalContext * juce::ARADocumentControllerSpecialisation::doCreateMusicalContext	(	ARADocument *	document,
		ARA::ARAMusicalContextHostRef	hostRef
	)

protectedvirtual

Override to return a custom subclass instance of ARAMusicalContext.

◆ doCreatePlaybackRegion()

virtual ARAPlaybackRegion * juce::ARADocumentControllerSpecialisation::doCreatePlaybackRegion	(	ARAAudioModification *	modification,
		ARA::ARAPlaybackRegionHostRef	hostRef
	)

protectedvirtual

Override to return a custom subclass instance of ARAPlaybackRegion.

◆ doCreatePlaybackRegionContentReader()

virtual ARA::PlugIn::ContentReader * juce::ARADocumentControllerSpecialisation::doCreatePlaybackRegionContentReader	(	ARA::PlugIn::PlaybackRegion *	playbackRegion,
		ARA::ARAContentType	type,
		const ARA::ARAContentTimeRange *	range
	)

protectedvirtual

Override to implement createPlaybackRegionContentReader() for all your supported content types, returning a custom subclass instance of ContentReader providing data of the requested type.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doCreatePlaybackRegionContentReader.

◆ doCreatePlaybackRenderer()

virtual ARAPlaybackRenderer * juce::ARADocumentControllerSpecialisation::doCreatePlaybackRenderer ( )

protectedvirtual

Override to return a custom subclass instance of ARAPlaybackRenderer.

◆ doCreateRegionSequence()

virtual ARARegionSequence * juce::ARADocumentControllerSpecialisation::doCreateRegionSequence	(	ARADocument *	document,
		ARA::ARARegionSequenceHostRef	hostRef
	)

protectedvirtual

Override to return a custom subclass instance of ARARegionSequence.

◆ doGetAudioModificationContentGrade()

virtual ARA::ARAContentGrade juce::ARADocumentControllerSpecialisation::doGetAudioModificationContentGrade	(	const ARA::PlugIn::AudioModification *	audioModification,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement getAudioModificationContentGrade() for all your supported content types.

For read-only data directly inherited from the underlying audio source you can just delegate the call to the audio source, but user-editable modification data must be specifically handled here.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetAudioModificationContentGrade.

◆ doGetAudioSourceContentGrade()

virtual ARA::ARAContentGrade juce::ARADocumentControllerSpecialisation::doGetAudioSourceContentGrade	(	const ARA::PlugIn::AudioSource *	audioSource,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement getAudioSourceContentGrade() for all your supported content types.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetAudioSourceContentGrade.

◆ doGetPlaybackRegionContentGrade()

virtual ARA::ARAContentGrade juce::ARADocumentControllerSpecialisation::doGetPlaybackRegionContentGrade	(	const ARA::PlugIn::PlaybackRegion *	playbackRegion,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement getPlaybackRegionContentGrade() for all your supported content types.

Typically, this call can directly delegate to the underlying audio modification, since most plug-ins will apply their modification data to the playback region with a transformation that does not affect content grade.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetPlaybackRegionContentGrade.

◆ doGetPlaybackRegionHeadAndTailTime()

virtual void juce::ARADocumentControllerSpecialisation::doGetPlaybackRegionHeadAndTailTime	(	const ARA::PlugIn::PlaybackRegion *	playbackRegion,
		ARA::ARATimeDuration *	headTime,
		ARA::ARATimeDuration *	tailTime
	)

protectedvirtual

Override to implement getPlaybackRegionHeadAndTailTime().

This function is called within ARA::PlugIn::DocumentControllerDelegate::doGetPlaybackRegionHeadAndTailTime.

◆ doGetProcessingAlgorithmForAudioSource()

virtual ARA::ARAInt32 juce::ARADocumentControllerSpecialisation::doGetProcessingAlgorithmForAudioSource ( const ARA::PlugIn::AudioSource * audioSource )

protectedvirtual

Override to implement getProcessingAlgorithmForAudioSource().

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetProcessingAlgorithmForAudioSource.

◆ doGetProcessingAlgorithmProperties()

virtual const ARA::ARAProcessingAlgorithmProperties * juce::ARADocumentControllerSpecialisation::doGetProcessingAlgorithmProperties ( ARA::ARAInt32 algorithmIndex )

protectedvirtual

Override to implement getProcessingAlgorithmProperties().

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetProcessingAlgorithmProperties.

◆ doGetProcessingAlgorithmsCount()

virtual ARA::ARAInt32 juce::ARADocumentControllerSpecialisation::doGetProcessingAlgorithmsCount ( )

protectedvirtual

Override to implement getProcessingAlgorithmsCount().

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doGetProcessingAlgorithmsCount.

◆ doIsAudioModificationContentAvailable()

virtual bool juce::ARADocumentControllerSpecialisation::doIsAudioModificationContentAvailable	(	const ARA::PlugIn::AudioModification *	audioModification,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement isAudioModificationContentAvailable() for all your supported content types - the default implementation always returns false.

For read-only data directly inherited from the underlying audio source you can just delegate the call to the audio source, but user-editable modification data must be specifically handled here.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doIsAudioModificationContentAvailable.

◆ doIsAudioSourceContentAnalysisIncomplete()

virtual bool juce::ARADocumentControllerSpecialisation::doIsAudioSourceContentAnalysisIncomplete	(	const ARA::PlugIn::AudioSource *	audioSource,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement isAudioSourceContentAnalysisIncomplete().

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doIsAudioSourceContentAnalysisIncomplete.

◆ doIsAudioSourceContentAvailable()

virtual bool juce::ARADocumentControllerSpecialisation::doIsAudioSourceContentAvailable	(	const ARA::PlugIn::AudioSource *	audioSource,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement isAudioSourceContentAvailable() for all your supported content types - the default implementation always returns false, preventing any calls to doGetAudioSourceContentGrade() and doCreateAudioSourceContentReader().

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doIsAudioSourceContentAvailable.

◆ doIsPlaybackRegionContentAvailable()

virtual bool juce::ARADocumentControllerSpecialisation::doIsPlaybackRegionContentAvailable	(	const ARA::PlugIn::PlaybackRegion *	playbackRegion,
		ARA::ARAContentType	type
	)

protectedvirtual

Override to implement isPlaybackRegionContentAvailable() for all your supported content types - the default implementation always returns false.

Typically, this call can directly delegate to the underlying audio modification, since most plug-ins will apply their modification data to the playback region with a transformation that does not affect content availability.

This function's result is returned from ARA::PlugIn::DocumentControllerDelegate::doIsPlaybackRegionContentAvailable.

◆ doRequestAudioSourceContentAnalysis()

virtual void juce::ARADocumentControllerSpecialisation::doRequestAudioSourceContentAnalysis	(	ARA::PlugIn::AudioSource *	audioSource,
		std::vector< ARA::ARAContentType > const &	contentTypes
	)

protectedvirtual

Override to implement requestAudioSourceContentAnalysis().

This function's called from ARA::PlugIn::DocumentControllerDelegate::doRequestAudioSourceContentAnalysis.

◆ doRequestProcessingAlgorithmForAudioSource()

virtual void juce::ARADocumentControllerSpecialisation::doRequestProcessingAlgorithmForAudioSource	(	ARA::PlugIn::AudioSource *	audioSource,
		ARA::ARAInt32	algorithmIndex
	)

protectedvirtual

Override to implement requestProcessingAlgorithmForAudioSource().

This function's called from ARA::PlugIn::DocumentControllerDelegate::doRequestProcessingAlgorithmForAudioSource.

◆ doRestoreObjectsFromStream()

virtual bool juce::ARADocumentControllerSpecialisation::doRestoreObjectsFromStream	(	ARAInputStream &	input,
		const ARARestoreObjectsFilter *	filter
	)

protectedpure virtual

Read an ARADocument archive from a juce::InputStream.

Parameters

input	Data stream containing previously persisted data to be used when restoring the ARADocument
filter	A filter to be applied to the stream

Return true if the operation is successful.

See also: ARADocumentControllerInterface::restoreObjectsFromArchive

◆ doStoreObjectsToStream()

virtual bool juce::ARADocumentControllerSpecialisation::doStoreObjectsToStream	(	ARAOutputStream &	output,
		const ARAStoreObjectsFilter *	filter
	)

protectedpure virtual

Write an ARADocument archive to a juce::OutputStream.

Parameters

output	Data stream that should be used to write the persistent ARADocument data
filter	A filter to be applied to the stream

Returns true if the operation is successful.

See also: ARADocumentControllerInterface::storeObjectsToArchive

◆ doUpdateAudioSourceContent()

virtual void juce::ARAAudioSourceListener::doUpdateAudioSourceContent	(	ARAAudioSource *	audioSource,
		ARAContentUpdateScopes	scopeFlags
	)

virtualinherited

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

samples or notes) changes.

Parameters

audioSource	The audio source with updated content.
scopeFlags	The scope of the content update.

Reimplemented in juce::ARAAudioSourceReader.

◆ doUpdateMusicalContextContent()

virtual void juce::ARAMusicalContextListener::doUpdateMusicalContextContent	(	ARAMusicalContext *	musicalContext,
		ARAContentUpdateScopes	scopeFlags
	)

virtualinherited

Called when the musical context's content (i.e tempo entries or chords) changes.

Parameters

musicalContext	The musical context with updated content.
scopeFlags	The scope of the content update indicating what has changed.

◆ getDocument()

template<typename DocumentType = ARADocument>

DocumentType * juce::ARADocumentControllerSpecialisation::getDocument ( )

inline

Returns a pointer to the ARA document root maintained by this document controller.

References getDocumentImpl().

◆ getDocumentController()

ARA::PlugIn::DocumentController * juce::ARADocumentControllerSpecialisation::getDocumentController ( )

noexcept

Returns the underlying DocumentController object that references this specialisation.

◆ getDocumentImpl()

ARADocument * juce::ARADocumentControllerSpecialisation::getDocumentImpl ( )

private

Referenced by getDocument().

◆ getSpecialisedDocumentController()

template<typename Specialisation = ARADocumentControllerSpecialisation>

static Specialisation * juce::ARADocumentControllerSpecialisation::getSpecialisedDocumentController ( ARA::PlugIn::DocumentController * dc )

inlinestatic

Returns a pointer to the ARADocumentControllerSpecialisation instance that is referenced by the provided DocumentController.

You can use this function to access your specialisation from anywhere where you have access to ARA::PlugIn::DocumentController*.

References getSpecialisedDocumentControllerImpl().

Referenced by juce::ARADocumentControllerSpecialisation::FactoryConfig< SpecialisationType >::destroyDocumentController().

◆ getSpecialisedDocumentControllerImpl()

static ARADocumentControllerSpecialisation * juce::ARADocumentControllerSpecialisation::getSpecialisedDocumentControllerImpl ( ARA::PlugIn::DocumentController * )

staticprivate

Referenced by getSpecialisedDocumentController().

◆ willBeginEditing()

virtual void juce::ARADocumentListener::willBeginEditing ( ARADocument * document )

virtualinherited

Called before the document enters an editing state.

Parameters

document The document about to enter an editing state.

◆ willDeactivateAudioModificationForUndoHistory()

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

virtualinherited

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

Parameters

audioModification	The audio modification that was activated or deactivated
deactivate	A bool indicating whether `audioModification` was deactivated or activated.

◆ willDeactivateAudioSourceForUndoHistory()

virtual void juce::ARAAudioSourceListener::willDeactivateAudioSourceForUndoHistory	(	ARAAudioSource *	audioSource,
		bool	deactivate
	)

virtualinherited

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

Parameters

audioSource	The audio source that will be activated or deactivated
deactivate	A bool indicating whether `audioSource` was deactivated or activated.

◆ willDestroyAudioModification()

virtual void juce::ARAAudioModificationListener::willDestroyAudioModification ( ARAAudioModification * audioModification )

virtualinherited

Called before the audio modification is destroyed.

Parameters

audioModification The audio modification that will be destroyed.

◆ willDestroyAudioSource()

virtual void juce::ARAAudioSourceListener::willDestroyAudioSource ( ARAAudioSource * audioSource )

virtualinherited

Called before the audio source is destroyed.

Parameters

audioSource The audio source that will be destroyed.

Reimplemented in juce::ARAAudioSourceReader.

◆ willDestroyDocument()

virtual void juce::ARADocumentListener::willDestroyDocument ( ARADocument * document )

virtualinherited

Called before the document is destroyed by the ARA host.

Parameters

document The document that will be destroyed.

◆ willDestroyMusicalContext()

virtual void juce::ARAMusicalContextListener::willDestroyMusicalContext ( ARAMusicalContext * musicalContext )

virtualinherited

Called before the musical context is destroyed.

Parameters

musicalContext The musical context that will be destroyed.

◆ willDestroyPlaybackRegion()

virtual void juce::ARAPlaybackRegionListener::willDestroyPlaybackRegion ( ARAPlaybackRegion * playbackRegion )

virtualinherited

Called before the playback region is destroyed.

Parameters

playbackRegion The playback region that will be destroyed.

Reimplemented in juce::ARAPlaybackRegionReader.

◆ willDestroyRegionSequence()

virtual void juce::ARARegionSequenceListener::willDestroyRegionSequence ( ARARegionSequence * regionSequence )

virtualinherited

Called before the region sequence is destroyed.

Parameters

regionSequence The region sequence that will be destroyed.

◆ willEnableAudioSourceSamplesAccess()

virtual void juce::ARAAudioSourceListener::willEnableAudioSourceSamplesAccess	(	ARAAudioSource *	audioSource,
		bool	enable
	)

virtualinherited

Called before access to an audio source's samples is enabled or disabled.

Parameters

audioSource	The audio source whose sample access state will be changed.
enable	A bool indicating whether or not sample access will be enabled or disabled.

Reimplemented in juce::ARAAudioSourceReader.

◆ willNotifyModelUpdates()

virtual void juce::ARADocumentListener::willNotifyModelUpdates ( ARADocument * document )

virtualinherited

Called before sending model updates do the host.

Parameters

document The document whose model updates are about to be sent.

◆ willRemoveAudioModificationFromAudioSource()

virtual void juce::ARAAudioSourceListener::willRemoveAudioModificationFromAudioSource	(	ARAAudioSource *	audioSource,
		ARAAudioModification *	audioModification
	)

virtualinherited

Called before an audio modification is removed from the audio source.

Parameters

audioSource	The audio source that `audioModification` will be removed from.
audioModification	The audio modification that will be removed from `audioSource`.

◆ willRemoveAudioSourceFromDocument()

virtual void juce::ARADocumentListener::willRemoveAudioSourceFromDocument	(	ARADocument *	document,
		ARAAudioSource *	audioSource
	)

virtualinherited

Called before an audio source is removed from the document.

Parameters

document	The document that `audioSource` will be removed from .
audioSource	The audio source that will be removed from `document`.

◆ willRemoveMusicalContextFromDocument()

virtual void juce::ARADocumentListener::willRemoveMusicalContextFromDocument	(	ARADocument *	document,
		ARAMusicalContext *	musicalContext
	)

virtualinherited

Called before a musical context is removed from the document.

Parameters

document	The document that `musicalContext` will be removed from.
musicalContext	The musical context that will be removed from `document`.

◆ willRemovePlaybackRegionFromAudioModification()

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

virtualinherited

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

Parameters

audioModification	The audio modification that `playbackRegion` will be removed from.
playbackRegion	The playback region that will be removed from `audioModification`.

◆ willRemovePlaybackRegionFromRegionSequence()

virtual void juce::ARARegionSequenceListener::willRemovePlaybackRegionFromRegionSequence	(	ARARegionSequence *	regionSequence,
		ARAPlaybackRegion *	playbackRegion
	)

virtualinherited

Called before a playback region is removed from the region sequence.

Parameters

regionSequence	The region sequence that `playbackRegion` will be removed from.
playbackRegion	The playback region that will be removed from `regionSequence`.

◆ willRemoveRegionSequenceFromDocument()

virtual void juce::ARADocumentListener::willRemoveRegionSequenceFromDocument	(	ARADocument *	document,
		ARARegionSequence *	regionSequence
	)

virtualinherited

Called before a region sequence is removed from the document.

Parameters

document	The document that `regionSequence` will be removed from.
regionSequence	The region sequence that will be removed from `document`.

◆ willRemoveRegionSequenceFromMusicalContext()

virtual void juce::ARAMusicalContextListener::willRemoveRegionSequenceFromMusicalContext	(	ARAMusicalContext *	musicalContext,
		ARARegionSequence *	regionSequence
	)

virtualinherited

Called before a region sequence is removed from the musical context.

Parameters

musicalContext	The musical context that `regionSequence` will be removed from.
regionSequence	The region sequence that will be removed from `musicalContext`.

◆ willUpdateAudioModificationProperties()

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

virtualinherited

Called before the audio modification's properties are updated.

Parameters

audioModification	The audio modification whose properties will be updated.
newProperties	The audio modification properties that will be assigned to `audioModification`.

◆ willUpdateAudioSourceProperties()

virtual void juce::ARAAudioSourceListener::willUpdateAudioSourceProperties	(	ARAAudioSource *	audioSource,
		ARA::PlugIn::PropertiesPtr< ARA::ARAAudioSourceProperties >	newProperties
	)

virtualinherited

Called before the audio source's properties are updated.

Parameters

audioSource	The audio source whose properties will be updated.
newProperties	The audio source properties that will be assigned to `audioSource`.

Reimplemented in juce::ARAAudioSourceReader.

◆ willUpdateDocumentProperties()

virtual void juce::ARADocumentListener::willUpdateDocumentProperties	(	ARADocument *	document,
		ARA::PlugIn::PropertiesPtr< ARA::ARADocumentProperties >	newProperties
	)

virtualinherited

Called before the document's properties are updated.

Parameters

document	The document whose properties will be updated.
newProperties	The document properties that will be assigned to `document`.

◆ willUpdateMusicalContextProperties()

virtual void juce::ARAMusicalContextListener::willUpdateMusicalContextProperties	(	ARAMusicalContext *	musicalContext,
		ARA::PlugIn::PropertiesPtr< ARA::ARAMusicalContextProperties >	newProperties
	)

virtualinherited

Called before the musical context's properties are updated.

Parameters

musicalContext	The musical context whose properties will be updated.
newProperties	The musical context properties that will be assigned to `musicalContext`.

◆ willUpdatePlaybackRegionProperties()

virtual void juce::ARAPlaybackRegionListener::willUpdatePlaybackRegionProperties	(	ARAPlaybackRegion *	playbackRegion,
		ARA::PlugIn::PropertiesPtr< ARA::ARAPlaybackRegionProperties >	newProperties
	)

virtualinherited

Called before the playback region's properties are updated.

Parameters

playbackRegion	The playback region whose properties will be updated.
newProperties	The playback region properties that will be assigned to `playbackRegion`.

Reimplemented in juce::ARAPlaybackRegionReader.

◆ willUpdateRegionSequenceProperties()

virtual void juce::ARARegionSequenceListener::willUpdateRegionSequenceProperties	(	ARARegionSequence *	regionSequence,
		ARA::PlugIn::PropertiesPtr< ARA::ARARegionSequenceProperties >	newProperties
	)

virtualinherited

Called before the region sequence's properties are updated.

Parameters

regionSequence	The region sequence whose properties will be updated.
newProperties	The region sequence properties that will be assigned to `regionSequence`.

Member Data Documentation

◆ documentController

std::unique_ptr<ARADocumentControllerImpl> juce::ARADocumentControllerSpecialisation::documentController

private

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

juce_ARADocumentController.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ARADocumentControllerSpecialisation()

◆ ~ARADocumentControllerSpecialisation()

Member Function Documentation

◆ createARAFactory()

◆ didAddAudioModificationToAudioSource()

◆ didAddAudioSourceToDocument()

◆ didAddMusicalContextToDocument()

◆ didAddPlaybackRegionToAudioModification()

◆ didAddPlaybackRegionToRegionSequence()

◆ didAddRegionSequenceToDocument()

◆ didAddRegionSequenceToMusicalContext()

◆ didDeactivateAudioModificationForUndoHistory()

◆ didDeactivateAudioSourceForUndoHistory()

◆ didEnableAudioSourceSamplesAccess()

◆ didEndEditing()

◆ didNotifyModelUpdates()

◆ didReorderMusicalContextsInDocument()

◆ didReorderRegionSequencesInDocument()

◆ didReorderRegionSequencesInMusicalContext()

◆ didUpdateAudioModificationContent()

◆ didUpdateAudioModificationProperties()

◆ didUpdateAudioSourceAnalysisProgress()

◆ didUpdateAudioSourceProperties()

◆ didUpdateDocumentProperties()

◆ didUpdateMusicalContextProperties()

◆ didUpdatePlaybackRegionContent()

◆ didUpdatePlaybackRegionProperties()

◆ didUpdateRegionSequenceProperties()

◆ doCreateAudioModification()

◆ doCreateAudioModificationContentReader()

◆ doCreateAudioSource()

◆ doCreateAudioSourceContentReader()

◆ doCreateDocument()

◆ doCreateEditorRenderer()

◆ doCreateEditorView()

◆ doCreateMusicalContext()

◆ doCreatePlaybackRegion()

◆ doCreatePlaybackRegionContentReader()

◆ doCreatePlaybackRenderer()

◆ doCreateRegionSequence()

◆ doGetAudioModificationContentGrade()

◆ doGetAudioSourceContentGrade()

◆ doGetPlaybackRegionContentGrade()

◆ doGetPlaybackRegionHeadAndTailTime()

◆ doGetProcessingAlgorithmForAudioSource()

◆ doGetProcessingAlgorithmProperties()

◆ doGetProcessingAlgorithmsCount()

◆ doIsAudioModificationContentAvailable()

◆ doIsAudioSourceContentAnalysisIncomplete()

◆ doIsAudioSourceContentAvailable()

◆ doIsPlaybackRegionContentAvailable()

◆ doRequestAudioSourceContentAnalysis()

◆ doRequestProcessingAlgorithmForAudioSource()

◆ doRestoreObjectsFromStream()

◆ doStoreObjectsToStream()

◆ doUpdateAudioSourceContent()

◆ doUpdateMusicalContextContent()

◆ getDocument()

◆ getDocumentController()

◆ getDocumentImpl()

◆ getSpecialisedDocumentController()

◆ getSpecialisedDocumentControllerImpl()

◆ willBeginEditing()

◆ willDeactivateAudioModificationForUndoHistory()

◆ willDeactivateAudioSourceForUndoHistory()

◆ willDestroyAudioModification()

◆ willDestroyAudioSource()

◆ willDestroyDocument()

◆ willDestroyMusicalContext()

◆ willDestroyPlaybackRegion()

◆ willDestroyRegionSequence()