tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
tracktion::engine::PluginEffect Struct Reference
Inheritance diagram for tracktion::engine::PluginEffect:
tracktion::engine::ClipEffect tracktion::engine::AutomatableParameter::Listener juce::Timer tracktion::engine::ValueTreeAllEventListener juce::ValueTree::Listener

Public Member Functions

 PluginEffect (const juce::ValueTree &, ClipEffects &)
 
juce::ReferenceCountedObjectPtr< ClipEffectRenderJobcreateRenderJob (const AudioFile &, double sourceLength) override
 Subclasses should return a job that can render the source.
 
void initialise () override
 
void flushStateToValueTree () 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
 
void curveHasChanged (AutomatableParameter &) override
 Called when the automation curve has changed, point time, value or curve.
 
- 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
 
juce::UndoManagergetUndoManager ()
 
AudioClipBasegetClip ()
 
- Public Member Functions inherited from tracktion::engine::AutomatableParameter::Listener
virtual void currentValueChanged (AutomatableParameter &)
 Called when the current value of the parameter changed, either from setting the parameter, automation, a macro or modifier.
 
virtual void parameterChanged (AutomatableParameter &, float)
 Called when the parameter is changed by the plugin or host, not from automation.
 
virtual void parameterChangeGestureBegin (AutomatableParameter &)
 
virtual void parameterChangeGestureEnd (AutomatableParameter &)
 

Public Attributes

Plugin::Ptr plugin
 
std::unique_ptr< ClipEffects::RenderInhibitorinhibitor
 
std::unique_ptr< PluginUnloadInhibitorpluginUnloadInhibitor
 
juce::CachedValue< intcurrentCurve
 
juce::CachedValue< juce::int64lastHash
 
- Public Attributes inherited from tracktion::engine::ClipEffect
Editedit
 
juce::ValueTree state
 
ClipEffectsclipEffects
 

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 ClipEffectcreate (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 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
 

Detailed Description

Definition at line 495 of file tracktion_ClipEffects.h.

Constructor & Destructor Documentation

◆ PluginEffect()

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

Definition at line 1278 of file tracktion_ClipEffects.cpp.

Member Function Documentation

◆ createRenderJob()

juce::ReferenceCountedObjectPtr< ClipEffect::ClipEffectRenderJob > tracktion::engine::PluginEffect::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 1318 of file tracktion_ClipEffects.cpp.

◆ curveHasChanged()

void tracktion::engine::PluginEffect::curveHasChanged ( AutomatableParameter )
overridevirtual

Called when the automation curve has changed, point time, value or curve.

Implements tracktion::engine::AutomatableParameter::Listener.

Definition at line 1411 of file tracktion_ClipEffects.cpp.

◆ flushStateToValueTree()

void tracktion::engine::PluginEffect::flushStateToValueTree ( )
overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 1347 of file tracktion_ClipEffects.cpp.

◆ getIndividualHash()

HashCode tracktion::engine::PluginEffect::getIndividualHash ( ) const
overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 1368 of file tracktion_ClipEffects.cpp.

◆ hasProperties()

bool tracktion::engine::PluginEffect::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 1353 of file tracktion_ClipEffects.cpp.

◆ initialise()

void tracktion::engine::PluginEffect::initialise ( )
overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 503 of file tracktion_ClipEffects.h.

◆ propertiesButtonPressed()

void tracktion::engine::PluginEffect::propertiesButtonPressed ( SelectionManager sm)
overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 1358 of file tracktion_ClipEffects.cpp.

◆ timerCallback()

void tracktion::engine::PluginEffect::timerCallback ( )
overridevirtual

Implements juce::Timer.

Definition at line 1402 of file tracktion_ClipEffects.cpp.

◆ valueTreeChanged()

void tracktion::engine::PluginEffect::valueTreeChanged ( )
overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

Definition at line 1397 of file tracktion_ClipEffects.cpp.

◆ valueTreePropertyChanged()

void tracktion::engine::PluginEffect::valueTreePropertyChanged ( juce::ValueTree v,
const juce::Identifier i 
)
overridevirtual

Reimplemented from juce::ValueTree::Listener.

Definition at line 1383 of file tracktion_ClipEffects.cpp.

Member Data Documentation

◆ currentCurve

juce::CachedValue<int> tracktion::engine::PluginEffect::currentCurve

Definition at line 524 of file tracktion_ClipEffects.h.

◆ inhibitor

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

Definition at line 522 of file tracktion_ClipEffects.h.

◆ lastHash

juce::CachedValue<juce::int64> tracktion::engine::PluginEffect::lastHash
mutable

Definition at line 525 of file tracktion_ClipEffects.h.

◆ plugin

Plugin::Ptr tracktion::engine::PluginEffect::plugin

Definition at line 521 of file tracktion_ClipEffects.h.

◆ pluginUnloadInhibitor

std::unique_ptr<PluginUnloadInhibitor> tracktion::engine::PluginEffect::pluginUnloadInhibitor

Definition at line 523 of file tracktion_ClipEffects.h.


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