PlaybackRegionAndSource Class Reference

#include <tracktion_ARAWrapperInterfaces.h>

Public Member Functions
	PlaybackRegionAndSource (ARADocument &doc, AudioClipBase &audioClip, const ARAFactory &f, const ARAPlugInExtensionInstance &pluginExtensionInstance, const juce::String &itemID, PlaybackRegionAndSource *instanceToClone)
	~PlaybackRegionAndSource ()
void	enable ()
void	disable ()
bool	playbackRegionLayoutMatches (bool isLooping, double clipLengthSecs, double loopLengthSecs) const
	Returns true if the current set of playback regions still matches the given clip state, i.e.
void	rebuildPlaybackRegions ()
	Rebuilds all playback regions based on whether the clip is looping.
PlaybackRegionWrapper *	getFirstPlaybackRegion () const
	Returns the first playback region, or nullptr if none exist.
bool	hasPlaybackRegions () const
	Returns true if there is at least one playback region.

Static Public Member Functions
static size_t	getNumLoopRegions (double clipLengthSecs, double loopLengthSecs)
	Returns the number of playback regions a looping clip of the given length needs.

Public Attributes
std::vector< std::unique_ptr< PlaybackRegionWrapper > >	playbackRegions
std::shared_ptr< AudioSourceWrapper >	audioSource
std::unique_ptr< AudioModificationWrapper >	audioModification
juce::String	audioSourceKey

Constructor & Destructor Documentation

PlaybackRegionAndSource()

PlaybackRegionAndSource::PlaybackRegionAndSource	(	ARADocument &	doc,
		AudioClipBase &	audioClip,
		const ARAFactory &	f,
		const ARAPlugInExtensionInstance &	pluginExtensionInstance,
		const juce::String &	itemID,
		PlaybackRegionAndSource *	instanceToClone
	)

References ARADocument::acquireAudioSource(), audioModification, audioSource, audioSourceKey, CRASH_TRACER, enable(), playbackRegions, and rebuildPlaybackRegions().

~PlaybackRegionAndSource()

PlaybackRegionAndSource::~PlaybackRegionAndSource

(

)

Note

Destruction order matters here

References audioModification, audioSource, audioSourceKey, CRASH_TRACER, disable(), playbackRegions, and ARADocument::releaseAudioSource().

Member Function Documentation

enable()

void PlaybackRegionAndSource::enable

(

)

References audioSource, and CRASH_TRACER.

Referenced by PlaybackRegionAndSource().

disable()

void PlaybackRegionAndSource::disable

(

)

References audioSource, and CRASH_TRACER.

Referenced by ~PlaybackRegionAndSource().

getNumLoopRegions()

static size_t PlaybackRegionAndSource::getNumLoopRegions ( double  clipLengthSecs, double  loopLengthSecs  )

static

Returns the number of playback regions a looping clip of the given length needs.

Uses a small tolerance so a length sitting on a loop boundary always produces a stable count - deriving it any other way (e.g. repeated subtraction) can disagree with ceil() by one and make the layout check rebuild the regions endlessly.

Referenced by playbackRegionLayoutMatches(), and rebuildPlaybackRegions().

playbackRegionLayoutMatches()

bool PlaybackRegionAndSource::playbackRegionLayoutMatches	(	bool	isLooping,
		double	clipLengthSecs,
		double	loopLengthSecs
	)		const

Returns true if the current set of playback regions still matches the given clip state, i.e.

no rebuild is needed and updateRange() suffices.

References getNumLoopRegions(), and playbackRegions.

rebuildPlaybackRegions()

void PlaybackRegionAndSource::rebuildPlaybackRegions

(

)

Rebuilds all playback regions based on whether the clip is looping.

If looping, creates one PlaybackRegionWrapper per loop iteration. If not looping, creates a single region covering the whole clip.

References audioModification, CRASH_TRACER, getNumLoopRegions(), and playbackRegions.

Referenced by PlaybackRegionAndSource().

getFirstPlaybackRegion()

PlaybackRegionWrapper * PlaybackRegionAndSource::getFirstPlaybackRegion

(

)

const

Returns the first playback region, or nullptr if none exist.

References playbackRegions.

hasPlaybackRegions()

bool PlaybackRegionAndSource::hasPlaybackRegions

(

)

const

Returns true if there is at least one playback region.

References playbackRegions.

Member Data Documentation

playbackRegions

std::vector<std::unique_ptr<PlaybackRegionWrapper> > PlaybackRegionAndSource::playbackRegions

Referenced by getFirstPlaybackRegion(), hasPlaybackRegions(), PlaybackRegionAndSource(), playbackRegionLayoutMatches(), rebuildPlaybackRegions(), and ~PlaybackRegionAndSource().

audioSource

std::shared_ptr<AudioSourceWrapper> PlaybackRegionAndSource::audioSource

Referenced by disable(), enable(), PlaybackRegionAndSource(), and ~PlaybackRegionAndSource().

audioModification

std::unique_ptr<AudioModificationWrapper> PlaybackRegionAndSource::audioModification

Referenced by PlaybackRegionAndSource(), rebuildPlaybackRegions(), and ~PlaybackRegionAndSource().

audioSourceKey

juce::String PlaybackRegionAndSource::audioSourceKey

Referenced by PlaybackRegionAndSource(), and ~PlaybackRegionAndSource().

---

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

• tracktion_ARAWrapperInterfaces.h