engine::PitchShiftEffect Struct Reference

#include <tracktion_ClipEffects.h>

Inheritance diagram for engine::PitchShiftEffect:

Public Member Functions
	PitchShiftEffect (const juce::ValueTree &, ClipEffects &)
void	initialise () override
juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >	createRenderJob (const AudioFile &sourceFile, TimeDuration sourceLength) override
	Subclasses should return a job that can render the source.
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 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
juce::ReferenceCountedObjectPtr< PitchShiftPlugin >	plugin
std::unique_ptr< ClipEffects::RenderInhibitor >	inhibitor
Public Attributes inherited from engine::ClipEffect
Edit &	edit
juce::ValueTree	state
ClipEffects &	clipEffects

Additional Inherited Members
Public Types inherited from engine::ClipEffect
enum class	EffectType {   none , volume , fadeInOut , tapeStartStop ,   stepVolume , pitchShift , warpTime , normalise ,   makeMono , reverse , invert , filter ,   firstEffect = volume , lastEffect = filter }
Static Public Member Functions inherited from 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 engine::ValueTreeAllEventListener
void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override
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

Constructor & Destructor Documentation

PitchShiftEffect()

engine::PitchShiftEffect::PitchShiftEffect	(	const juce::ValueTree &	,
		ClipEffects &
	)

Member Function Documentation

initialise()

void engine::PitchShiftEffect::initialise ( )

overridevirtual

Reimplemented from engine::ClipEffect.

createRenderJob()

juce::ReferenceCountedObjectPtr< ClipEffectRenderJob > engine::PitchShiftEffect::createRenderJob ( const AudioFile &  sourceFile, TimeDuration  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 engine::ClipEffect.

hasProperties()

bool engine::PitchShiftEffect::hasProperties ( )

overridevirtual

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

Reimplemented from engine::ClipEffect.

propertiesButtonPressed()

void engine::PitchShiftEffect::propertiesButtonPressed ( SelectionManager &  )

overridevirtual

Reimplemented from engine::ClipEffect.

getIndividualHash()

HashCode engine::PitchShiftEffect::getIndividualHash ( ) const

overridevirtual

Reimplemented from engine::ClipEffect.

valueTreePropertyChanged()

void engine::PitchShiftEffect::valueTreePropertyChanged ( juce::ValueTree &  , const juce::Identifier &    )

override

valueTreeChanged()

void engine::PitchShiftEffect::valueTreeChanged ( )

overridevirtual

Reimplemented from engine::ClipEffect.

timerCallback()

void engine::PitchShiftEffect::timerCallback ( )

override

Member Data Documentation

plugin

juce::ReferenceCountedObjectPtr<PitchShiftPlugin> engine::PitchShiftEffect::plugin

inhibitor

std::unique_ptr<ClipEffects::RenderInhibitor> engine::PitchShiftEffect::inhibitor

---

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

• tracktion_ClipEffects.h