tracktion::engine::VolumeEffect Struct Reference

Inheritance diagram for tracktion::engine::VolumeEffect:

Public Member Functions
	VolumeEffect (const juce::ValueTree &, ClipEffects &)
juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >	createRenderJob (const AudioFile &sourceFile, double sourceLength) override
	Subclasses should return a job that can render the source.
void	initialise () override
bool	hasProperties () override
	Return true here to show a properties button in the editor and enable the propertiesButtonPressed callback.
void	propertiesButtonPressed (SelectionManager &) override
HashCode	getIndividualHash () const override
void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override
void	valueTreeChanged () override
void	timerCallback () override
Public Member Functions inherited from tracktion::engine::ClipEffect
	ClipEffect (const juce::ValueTree &, ClipEffects &)
EffectType	getType () const
virtual void	sourceChanged ()
	Callback to indicate the destination file has changed.
HashCode	getHash () const
	Returns the hash for this effect.
AudioFile	getSourceFile () const
AudioFile	getDestinationFile () const
bool	isUsingFile (const AudioFile &) const
virtual void	flushStateToValueTree ()
juce::UndoManager &	getUndoManager ()
AudioClipBase &	getClip ()

Public Attributes
VolumeAndPanPlugin::Ptr	plugin
std::unique_ptr< ClipEffects::RenderInhibitor >	inhibitor
Public Attributes inherited from tracktion::engine::ClipEffect
Edit &	edit
juce::ValueTree	state
ClipEffects &	clipEffects

Additional Inherited Members
Public Types inherited from tracktion::engine::ClipEffect
enum class	EffectType {   none , volume , fadeInOut , tapeStartStop ,   stepVolume , pitchShift , warpTime , normalise ,   makeMono , reverse , invert , filter ,   firstEffect , lastEffect }
Static Public Member Functions inherited from tracktion::engine::ClipEffect
static juce::ValueTree	create (EffectType)
static ClipEffect *	create (const juce::ValueTree &, ClipEffects &)
static void	createEffectAndAddToValueTree (Edit &, juce::ValueTree parent, ClipEffect::EffectType, int index)
static juce::String	getTypeDisplayName (EffectType)
static void	addEffectsToMenu (juce::PopupMenu &)
Protected Member Functions inherited from tracktion::engine::ValueTreeAllEventListener
void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &) override
void	valueTreeChildRemoved (juce::ValueTree &, juce::ValueTree &, int) override
void	valueTreeChildOrderChanged (juce::ValueTree &, int, int) override
void	valueTreeParentChanged (juce::ValueTree &) override
void	valueTreeRedirected (juce::ValueTree &) override

Detailed Description

Definition at line 343 of file tracktion_ClipEffects.h.

Constructor & Destructor Documentation

VolumeEffect()

tracktion::engine::VolumeEffect::VolumeEffect	(	const juce::ValueTree &	v,
		ClipEffects &	o
	)

Definition at line 674 of file tracktion_ClipEffects.cpp.

Member Function Documentation

createRenderJob()

juce::ReferenceCountedObjectPtr< ClipEffect::ClipEffectRenderJob > tracktion::engine::VolumeEffect::createRenderJob ( const AudioFile &  sourceFile, double  sourceLength  )

overridevirtual

Subclasses should return a job that can render the source.

N.B. because the sourceFile may not be valid at the time of job creation you should use the sourceLength parameter to determine how to build the render node.

Implements tracktion::engine::ClipEffect.

Definition at line 689 of file tracktion_ClipEffects.cpp.

getIndividualHash()

HashCode tracktion::engine::VolumeEffect::getIndividualHash ( ) const

overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 714 of file tracktion_ClipEffects.cpp.

hasProperties()

bool tracktion::engine::VolumeEffect::hasProperties ( )

overridevirtual

Return true here to show a properties button in the editor and enable the propertiesButtonPressed callback.

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 703 of file tracktion_ClipEffects.cpp.

initialise()

void tracktion::engine::VolumeEffect::initialise ( )

overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 349 of file tracktion_ClipEffects.h.

propertiesButtonPressed()

void tracktion::engine::VolumeEffect::propertiesButtonPressed ( SelectionManager &  sm )

overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 708 of file tracktion_ClipEffects.cpp.

timerCallback()

void tracktion::engine::VolumeEffect::timerCallback ( )

overridevirtual

Implements juce::Timer.

Definition at line 738 of file tracktion_ClipEffects.cpp.

valueTreeChanged()

void tracktion::engine::VolumeEffect::valueTreeChanged ( )

overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 730 of file tracktion_ClipEffects.cpp.

valueTreePropertyChanged()

void tracktion::engine::VolumeEffect::valueTreePropertyChanged ( juce::ValueTree &  v, const juce::Identifier &  i  )

overridevirtual

Reimplemented from tracktion::engine::ValueTreeAllEventListener.

Definition at line 719 of file tracktion_ClipEffects.cpp.

Member Data Documentation

inhibitor

std::unique_ptr<ClipEffects::RenderInhibitor> tracktion::engine::VolumeEffect::inhibitor

Definition at line 365 of file tracktion_ClipEffects.h.

plugin

VolumeAndPanPlugin::Ptr tracktion::engine::VolumeEffect::plugin

Definition at line 364 of file tracktion_ClipEffects.h.

---

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

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