PlaybackRegionWrapper Class Reference

#include <tracktion_ARAWrapperInterfaces.h>

Public Member Functions
	PlaybackRegionWrapper (ARADocument &d, AudioClipBase &audioClip, const ARAFactory &factory, const AudioModificationWrapper &audioModification)
	Creates a playback region covering the whole clip (non-looping case).
	PlaybackRegionWrapper (ARADocument &d, AudioClipBase &audioClip, const ARAFactory &factory, const AudioModificationWrapper &audioModification, int loopIterationIndex)
	Creates a playback region for one loop iteration of a looping clip.
	~PlaybackRegionWrapper ()
void	updateRange ()
SizedStruct< ARA_STRUCT_MEMBER(ARAPlaybackRegionProperties, color)>	getPlaybackRegionProperties ()
	NB: This is where time-stretching is setup.

Public Attributes
ARAPlaybackRegionRef	playbackRegionRef = nullptr
ARADocument &	doc
AudioClipBase &	clip
EditItemID	trackID

Constructor & Destructor Documentation

PlaybackRegionWrapper() [1/2]

PlaybackRegionWrapper::PlaybackRegionWrapper	(	ARADocument &	d,
		AudioClipBase &	audioClip,
		const ARAFactory &	factory,
		const AudioModificationWrapper &	audioModification
	)

Creates a playback region covering the whole clip (non-looping case).

References clip, CRASH_TRACER, ARADocument::dci, ARADocument::dcRef, doc, ARADocument::edit, getPlaybackRegionProperties(), ARADocument::musicalContext, playbackRegionRef, and ARADocument::willCreatePlaybackRegionOnTrack().

PlaybackRegionWrapper() [2/2]

PlaybackRegionWrapper::PlaybackRegionWrapper	(	ARADocument &	d,
		AudioClipBase &	audioClip,
		const ARAFactory &	factory,
		const AudioModificationWrapper &	audioModification,
		int	loopIterationIndex
	)

Creates a playback region for one loop iteration of a looping clip.

The time ranges are recomputed from the current clip state whenever the properties are requested, so they stay correct as the clip is moved or resized.

References clip, CRASH_TRACER, ARADocument::dci, ARADocument::dcRef, doc, ARADocument::edit, getPlaybackRegionProperties(), ARADocument::musicalContext, playbackRegionRef, and ARADocument::willCreatePlaybackRegionOnTrack().

~PlaybackRegionWrapper()

PlaybackRegionWrapper::~PlaybackRegionWrapper

(

)

References CRASH_TRACER, ARADocument::dci, ARADocument::dcRef, doc, playbackRegionRef, trackID, and ARADocument::willDestroyPlaybackRegionOnTrack().

Member Function Documentation

updateRange()

void PlaybackRegionWrapper::updateRange

(

)

References CRASH_TRACER, ARADocument::dci, ARADocument::dcRef, doc, getPlaybackRegionProperties(), playbackRegionRef, ARADocument::regionSequences, and trackID.

getPlaybackRegionProperties()

SizedStruct< ARA_STRUCT_MEMBER(ARAPlaybackRegionProperties, color)> PlaybackRegionWrapper::getPlaybackRegionProperties

(

)

NB: This is where time-stretching is setup.

References clip, doc, ARADocument::musicalContext, ARADocument::regionSequences, and trackID.

Referenced by PlaybackRegionWrapper(), PlaybackRegionWrapper(), and updateRange().

Member Data Documentation

playbackRegionRef

ARAPlaybackRegionRef PlaybackRegionWrapper::playbackRegionRef = nullptr

Referenced by PlaybackRegionWrapper(), PlaybackRegionWrapper(), updateRange(), and ~PlaybackRegionWrapper().

doc

ARADocument& PlaybackRegionWrapper::doc

Referenced by getPlaybackRegionProperties(), PlaybackRegionWrapper(), PlaybackRegionWrapper(), updateRange(), and ~PlaybackRegionWrapper().

clip

AudioClipBase& PlaybackRegionWrapper::clip

Referenced by getPlaybackRegionProperties(), PlaybackRegionWrapper(), and PlaybackRegionWrapper().

trackID

EditItemID PlaybackRegionWrapper::trackID

Referenced by getPlaybackRegionProperties(), updateRange(), and ~PlaybackRegionWrapper().

---

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

• tracktion_ARAWrapperInterfaces.h