Inheritance diagram for tracktion::engine::ClipEffects:

Classes
struct	ClipPropertyWatcher

struct	Listener

struct	RenderInhibitor

Public Member Functions
	ClipEffects (const juce::ValueTree &, AudioClipBase &)

void	flushStateToValueTree ()

ClipEffect *	getClipEffect (const juce::ValueTree &v)

HashCode	getHash () const
	Returns the hash for this set of effects.

TimePosition	getEffectsStartTime () const
	Returns the start position in the file that the effect should apply to.

TimeDuration	getEffectsLength () const
	Returns the length of the effect.

TimeRange	getEffectsRange () const
	Returns the range of the file that the effect should apply to.

double	getSpeedRatioEstimate () const
	Returns the speed ratio of the clip or an estimate of this if the clip is auto tempo.

bool	isUsingFile (const AudioFile &af)

void	notifyListenersOfRenderCompletion ()

RenderManager::Job::Ptr	createRenderJob (const AudioFile &destFile, const AudioFile &sourceFile) const

bool	isSuitableType (const juce::ValueTree &v) const override

ClipEffect *	createNewObject (const juce::ValueTree &v) override

void	deleteObject (ClipEffect *ce) override

void	newObjectAdded (ClipEffect *) override

void	objectRemoved (ClipEffect *) override

void	objectOrderChanged () override

void	addListener (Listener *l)

void	removeListener (Listener *l)

Public Member Functions inherited from tracktion::engine::ValueTreeObjectList< ClipEffect >
	ValueTreeObjectList (const juce::ValueTree &parentTree)

int	size () const

bool	isEmpty () const noexcept

ClipEffect *	operator[] (int idx) const

ClipEffect *	at (int idx)

ClipEffect **	begin ()

ClipEffect const	begin () const

ClipEffect **	end ()

ClipEffect const	end () const

void	rebuildObjects ()

void	freeObjects ()

void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &tree) override

void	valueTreeChildRemoved (juce::ValueTree &exParent, juce::ValueTree &tree, int) override

void	valueTreeChildOrderChanged (juce::ValueTree &tree, int, int) override

void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override

void	valueTreeParentChanged (juce::ValueTree &) override

void	valueTreeRedirected (juce::ValueTree &) override

int	compareElements (ClipEffect first, ClipEffect second) const

	ValueTreeObjectList (const juce::ValueTree &parentTree)

int	size () const

bool	isEmpty () const noexcept

ClipEffect *	operator[] (int idx) const

ClipEffect *	at (int idx)

ClipEffect **	begin ()

ClipEffect const	begin () const

ClipEffect **	end ()

ClipEffect const	end () const

void	rebuildObjects ()

void	freeObjects ()

void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &tree) override

void	valueTreeChildRemoved (juce::ValueTree &exParent, juce::ValueTree &tree, int) override

void	valueTreeChildOrderChanged (juce::ValueTree &tree, int, int) override

void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override

void	valueTreeParentChanged (juce::ValueTree &) override

void	valueTreeRedirected (juce::ValueTree &) override

int	compareElements (ClipEffect first, ClipEffect second) const

Static Public Member Functions
static juce::ValueTree	create ()

Public Attributes
AudioClipBase &	clip

juce::ValueTree	state

Public Attributes inherited from tracktion::engine::ValueTreeObjectList< ClipEffect >
juce::Array< ClipEffect * >	objects

juce::DummyCriticalSection	arrayLock

juce::Array< ClipEffect * >	objects

juce::DummyCriticalSection	arrayLock

Friends
class	ClipEffect

Additional Inherited Members
Public Types inherited from tracktion::engine::ValueTreeObjectList< ClipEffect >
using	ScopedLockType = typename CriticalSectionType::ScopedLockType

using	ScopedLockType = typename CriticalSectionType::ScopedLockType

Protected Member Functions inherited from tracktion::engine::ValueTreeObjectList< ClipEffect >
void	deleteAllObjects ()

bool	isChildTree (juce::ValueTree &v) const

int	indexOf (const juce::ValueTree &v) const noexcept

void	sortArray ()

void	deleteAllObjects ()

bool	isChildTree (juce::ValueTree &v) const

int	indexOf (const juce::ValueTree &v) const noexcept

void	sortArray ()

Protected Attributes inherited from tracktion::engine::ValueTreeObjectList< ClipEffect >
juce::ValueTree	parent

juce::ValueTree	parent

Detailed Description

Definition at line 104 of file tracktion_ClipEffects.h.

Constructor & Destructor Documentation

◆ ClipEffects()

tracktion::engine::ClipEffects::ClipEffects	(	const juce::ValueTree &	v,
		AudioClipBase &	c
	)

Definition at line 114 of file tracktion_ClipEffects.cpp.

◆ ~ClipEffects()

tracktion::engine::ClipEffects::~ClipEffects ( )

override

Definition at line 121 of file tracktion_ClipEffects.cpp.

Member Function Documentation

◆ addListener()

void tracktion::engine::ClipEffects::addListener ( Listener * l )

Definition at line 238 of file tracktion_ClipEffects.h.

◆ create()

static juce::ValueTree tracktion::engine::ClipEffects::create ( )

static

Definition at line 108 of file tracktion_ClipEffects.h.

◆ createNewObject()

ClipEffect * tracktion::engine::ClipEffects::createNewObject ( const juce::ValueTree & v )

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 196 of file tracktion_ClipEffects.h.

◆ createRenderJob()

RenderManager::Job::Ptr tracktion::engine::ClipEffects::createRenderJob	(	const AudioFile &	destFile,
		const AudioFile &	sourceFile
	)		const

Definition at line 1785 of file tracktion_ClipEffects.cpp.

◆ deleteObject()

void tracktion::engine::ClipEffects::deleteObject ( ClipEffect * ce )

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 204 of file tracktion_ClipEffects.h.

◆ flushStateToValueTree()

void tracktion::engine::ClipEffects::flushStateToValueTree ( )

Definition at line 117 of file tracktion_ClipEffects.h.

◆ getClipEffect()

ClipEffect * tracktion::engine::ClipEffects::getClipEffect ( const juce::ValueTree & v )

Definition at line 123 of file tracktion_ClipEffects.h.

◆ getEffectsLength()

TimeDuration tracktion::engine::ClipEffects::getEffectsLength ( ) const

Returns the length of the effect.

This will be the effective length of the source file i.e. taking into account loop length and speed ratio.

Definition at line 153 of file tracktion_ClipEffects.h.

◆ getEffectsRange()

TimeRange tracktion::engine::ClipEffects::getEffectsRange ( ) const

Returns the range of the file that the effect should apply to.

In practice this is the loop start point and loop length.

Definition at line 161 of file tracktion_ClipEffects.h.

◆ getEffectsStartTime()

TimePosition tracktion::engine::ClipEffects::getEffectsStartTime ( ) const

Returns the start position in the file that the effect should apply to.

In practice this is the loop start point.

Definition at line 145 of file tracktion_ClipEffects.h.

◆ getHash()

HashCode tracktion::engine::ClipEffects::getHash ( ) const

Returns the hash for this set of effects.

Definition at line 133 of file tracktion_ClipEffects.h.

◆ getSpeedRatioEstimate()

double tracktion::engine::ClipEffects::getSpeedRatioEstimate ( ) const

Returns the speed ratio of the clip or an estimate of this if the clip is auto tempo.

Note that because Edits can have multiple tempo changes this will only be an estimate based on the tempo at the start of the clip.

Definition at line 170 of file tracktion_ClipEffects.h.

◆ isSuitableType()

bool tracktion::engine::ClipEffects::isSuitableType ( const juce::ValueTree & v ) const

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 191 of file tracktion_ClipEffects.h.

◆ isUsingFile()

bool tracktion::engine::ClipEffects::isUsingFile ( const AudioFile & af )

Definition at line 175 of file tracktion_ClipEffects.h.

◆ newObjectAdded()

void tracktion::engine::ClipEffects::newObjectAdded ( ClipEffect * )

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 211 of file tracktion_ClipEffects.h.

◆ notifyListenersOfRenderCompletion()

void tracktion::engine::ClipEffects::notifyListenersOfRenderCompletion ( )

Definition at line 184 of file tracktion_ClipEffects.h.

◆ objectOrderChanged()

void tracktion::engine::ClipEffects::objectOrderChanged ( )

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 221 of file tracktion_ClipEffects.h.

◆ objectRemoved()

void tracktion::engine::ClipEffects::objectRemoved ( ClipEffect * )

overridevirtual

Implements tracktion::engine::ValueTreeObjectList< ClipEffect >.

Definition at line 216 of file tracktion_ClipEffects.h.

◆ removeListener()

void tracktion::engine::ClipEffects::removeListener ( Listener * l )

Definition at line 239 of file tracktion_ClipEffects.h.

Friends And Related Symbol Documentation

◆ ClipEffect

friend class ClipEffect

friend

Definition at line 283 of file tracktion_ClipEffects.h.

Member Data Documentation

◆ clip

AudioClipBase& tracktion::engine::ClipEffects::clip

Definition at line 251 of file tracktion_ClipEffects.h.

◆ state

juce::ValueTree tracktion::engine::ClipEffects::state

Definition at line 252 of file tracktion_ClipEffects.h.

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

tracktion_engine/model/clips/tracktion_ClipEffects.h
tracktion_engine/model/clips/tracktion_ClipEffects.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClipEffects()

◆ ~ClipEffects()

Member Function Documentation

◆ addListener()

◆ create()

◆ createNewObject()

◆ createRenderJob()

◆ deleteObject()

◆ flushStateToValueTree()

◆ getClipEffect()

◆ getEffectsLength()

◆ getEffectsRange()

◆ getEffectsStartTime()

◆ getHash()

◆ getSpeedRatioEstimate()

◆ isSuitableType()

◆ isUsingFile()

◆ newObjectAdded()

◆ notifyListenersOfRenderCompletion()

◆ objectOrderChanged()

◆ objectRemoved()

◆ removeListener()

Friends And Related Symbol Documentation

◆ ClipEffect

Member Data Documentation

◆ clip

◆ state