LMMS
Loading...
Searching...
No Matches
lmms::DummyEffect Class Reference

#include <DummyEffect.h>

Inheritance diagram for lmms::DummyEffect:
lmms::Effect lmms::Plugin lmms::Model lmms::JournallingObject lmms::SerializingObject

Public Member Functions

 DummyEffect (Model *_parent, const QDomElement &originalPluginData)
 ~DummyEffect () override=default
EffectControlscontrols () override
ProcessStatus processImpl (SampleFrame *, const f_cnt_t) override
const QDomElement & originalPluginData () const
Public Member Functions inherited from lmms::Effect
 Effect (const Plugin::Descriptor *_desc, Model *_parent, const Descriptor::SubPluginFeatures::Key *_key)
void saveSettings (QDomDocument &_doc, QDomElement &_parent) override
void loadSettings (const QDomElement &_this) override
QString nodeName () const override
bool processAudioBuffer (AudioBuffer &inOut)
 Returns true if audio was processed and should continue being processed.
bool isOkay () const
void setOkay (bool _state)
bool isAwake () const
 "Awake" means the effect has not been put to sleep by auto-quit
bool isEnabled () const
f_cnt_t timeout () const
float wetLevel () const
float dryLevel () const
bool dontRun () const
void setDontRun (bool _state)
bool isProcessingAudio () const
TempoSyncKnobModelautoQuitModel ()
bool autoQuitEnabled () const
EffectChaineffectChain () const
Public Member Functions inherited from lmms::Plugin
 Plugin (const Descriptor *descriptor, Model *parent, const Descriptor::SubPluginFeatures::Key *key=nullptr)
 ~Plugin () override=default
QString displayName () const override
 Return display-name out of sub plugin or descriptor.
const PixmapLoaderlogo () const
 Return logo out of sub plugin or descriptor.
Type type () const
 Return plugin type.
const Descriptordescriptor () const
 Return plugin Descriptor.
const Descriptor::SubPluginFeatures::Keykey () const
virtual void loadFile (const QString &file)
virtual AutomatableModelchildModel (const QString &modelName)
gui::PluginViewcreateView (QWidget *parent)
 Create a view for the model.
Public Member Functions inherited from lmms::Model
 Model (Model *parent, QString displayName=QString(), bool defaultConstructed=false)
 ~Model () override=default
bool isDefaultConstructed () const
ModelparentModel () const
virtual void setDisplayName (const QString &displayName)
virtual QString fullDisplayName () const
Public Member Functions inherited from lmms::JournallingObject
 JournallingObject ()
 ~JournallingObject () override
jo_id_t id () const
void saveJournallingState (const bool newState)
void restoreJournallingState ()
void addJournalCheckPoint ()
QDomElement saveState (QDomDocument &_doc, QDomElement &_parent) override
void restoreState (const QDomElement &_this) override
bool isJournalling () const
void setJournalling (const bool _sr)
bool testAndSetJournalling (const bool newState)
bool isJournallingStateStackEmpty () const
Public Member Functions inherited from lmms::SerializingObject
 SerializingObject ()
virtual ~SerializingObject ()
void setHook (SerializingObjectHook *_hook)
SerializingObjectHookhook ()

Private Member Functions

virtual void setName ()

Private Attributes

DummyEffectControls m_controls
const QDomElement m_originalPluginData

Additional Inherited Members

Public Types inherited from lmms::Plugin
enum class  Type {
  Instrument , Effect , ImportFilter , ExportFilter ,
  Tool , Library , Other , Undefined = 255
}
using DescriptorList = QList<Descriptor*>
Signals inherited from lmms::Model
void dataChanged ()
void dataUnchanged ()
void propertiesChanged ()
Static Public Member Functions inherited from lmms::Effect
static Effectinstantiate (const QString &_plugin_name, Model *_parent, Descriptor::SubPluginFeatures::Key *_key)
Static Public Member Functions inherited from lmms::Plugin
static PlugininstantiateWithKey (const QString &pluginName, Model *parent, const Descriptor::SubPluginFeatures::Key *key, bool keyFromDnd=false)
static Plugininstantiate (const QString &pluginName, Model *parent, void *data)
Protected Types inherited from lmms::Effect
enum class  ProcessStatus { Continue , ContinueIfNotQuiet , Sleep }
Protected Member Functions inherited from lmms::Effect
virtual void processBypassedImpl ()
gui::PluginViewinstantiateView (QWidget *) override
 Create a view for the model.
void goToSleep ()
void wakeUp ()
virtual void onEnabledChanged ()
Protected Member Functions inherited from lmms::Plugin
void collectErrorForUI (QString errMsg)
Protected Member Functions inherited from lmms::JournallingObject
void changeID (jo_id_t _id)

Constructor & Destructor Documentation

◆ DummyEffect()

lmms::DummyEffect::DummyEffect ( Model * _parent,
const QDomElement & originalPluginData )
inline

◆ ~DummyEffect()

lmms::DummyEffect::~DummyEffect ( )
overridedefault

Member Function Documentation

◆ controls()

EffectControls * lmms::DummyEffect::controls ( )
inlineoverridevirtual

Implements lmms::Effect.

◆ originalPluginData()

const QDomElement & lmms::DummyEffect::originalPluginData ( ) const
inline

◆ processImpl()

ProcessStatus lmms::DummyEffect::processImpl ( SampleFrame * buf,
const f_cnt_t frames )
inlineoverridevirtual

The main audio processing method that runs when plugin is awake and running

Implements lmms::Effect.

◆ setName()

virtual void lmms::DummyEffect::setName ( )
inlineprivatevirtual

Member Data Documentation

◆ m_controls

DummyEffectControls lmms::DummyEffect::m_controls
private

◆ m_originalPluginData

const QDomElement lmms::DummyEffect::m_originalPluginData
private

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