synthclone  0.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
synthclone::Context Class Referenceabstract

Context objects allow Participant objects to interact with a synthclone session. More...

#include <synthclone/context.h>

Inheritance diagram for synthclone::Context:
Collaboration diagram for synthclone::Context:

Public Slots

virtual void abortCurrentSamplerJob ()=0
 Tells the Sampler to abort the current SamplerJob. More...
 
virtual void activateParticipant (const synthclone::Participant *participant)=0
 Activates a Participant. More...
 
virtual const RegistrationaddEffect (Effect *effect, int index=-1)=0
 Adds an Effect to the session. More...
 
virtual const EffectJobaddEffectJob (Zone *zone)=0
 Adds an EffectJob to the EffectJob queue. More...
 
virtual const RegistrationaddMenuAction (MenuAction *action, Menu menu, const QStringList &subMenus=QStringList())=0
 Adds a MenuAction to the application. More...
 
virtual const RegistrationaddMenuAction (MenuAction *action, const Effect *effect, const QStringList &subMenus=QStringList())=0
 Adds a MenuAction to the application. More...
 
virtual const RegistrationaddMenuAction (MenuAction *action, const Sampler *sampler, const QStringList &subMenus=QStringList())=0
 Adds a MenuAction to the application. More...
 
virtual const RegistrationaddMenuAction (MenuAction *action, const Target *target, const QStringList &subMenus=QStringList())=0
 Adds a MenuAction to the application. More...
 
virtual const RegistrationaddMenuSeparator (MenuSeparator *separator, Menu menu, const QStringList &subMenus=QStringList())=0
 Adds a MenuSeparator to the application. More...
 
virtual const RegistrationaddMenuSeparator (MenuSeparator *separator, const Effect *effect, const QStringList &subMenus=QStringList())=0
 Adds a MenuSeparator to the application. More...
 
virtual const RegistrationaddMenuSeparator (MenuSeparator *separator, const Sampler *sampler, const QStringList &subMenus=QStringList())=0
 Adds a MenuSeparator to the application. More...
 
virtual const RegistrationaddMenuSeparator (MenuSeparator *separator, const Target *target, const QStringList &subMenus=QStringList())=0
 Adds a MenuSeparator to the application. More...
 
virtual const RegistrationaddParticipant (Participant *participant, const QByteArray &subId)=0
 Adds a Participant to the session. More...
 
virtual const RegistrationaddSampler (Sampler *sampler)=0
 Adds a Sampler to the session, removing any Sampler that may already be registered with the session. More...
 
virtual const SamplerJobaddSamplerJob (SamplerJob::Type type, Zone *zone)=0
 Adds a SamplerJob object to the SamplerJob queue. More...
 
virtual const RegistrationaddTarget (Target *target, int index=-1)=0
 Adds a Target to the session. More...
 
virtual ZoneaddZone (int index=-1)=0
 Adds a new zone to the session. More...
 
virtual void buildTargets ()=0
 Attempts to build all registered targets. More...
 
virtual void createSession (const QDir &directory, SampleRate sampleRate, SampleChannelCount count)=0
 Writes an empty synthclone session to a directory. More...
 
virtual void deactivateParticipant (const Participant *participant)=0
 Deactivates a Participant. More...
 
virtual void loadSession (const QDir &directory)=0
 Loads a synthclone session. More...
 
virtual void moveEffect (int fromIndex, int toIndex)=0
 Moves an Effect. More...
 
virtual void moveEffectJob (int fromIndex, int toIndex)=0
 Moves an EffectJob. More...
 
virtual void moveSamplerJob (int fromIndex, int toIndex)=0
 Moves a SamplerJob. More...
 
virtual void moveTarget (int fromIndex, int toIndex)=0
 Moves a Target. More...
 
virtual void moveZone (int fromIndex, int toIndex)=0
 Moves a Zone. More...
 
virtual void quit ()=0
 Terminates synthclone. More...
 
virtual void removeEffect (const Effect *effect)=0
 Removes an Effect. More...
 
virtual void removeEffect (int index)=0
 Removes an Effect. More...
 
virtual void removeEffectJob (const EffectJob *job)=0
 Removes an EffectJob from the EffectJob queue. More...
 
virtual void removeEffectJob (int index)=0
 Removes an EffectJob from the EffectJob queue. More...
 
virtual void removeMenuAction (const MenuAction *action)=0
 Removes a MenuAction. More...
 
virtual void removeMenuSeparator (const MenuSeparator *separator)=0
 Removes a MenuSeparator. More...
 
virtual void removeParticipant (const Participant *participant)=0
 Removes a Participant from the session. More...
 
virtual void removeSampler ()=0
 Removes a Sampler registered with the session. More...
 
virtual void removeSamplerJob (const SamplerJob *job)=0
 Removes a SamplerJob from the SamplerJob queue. More...
 
virtual void removeSamplerJob (int index)=0
 Removes a sampler job from the SamplerJob queue. More...
 
virtual void removeTarget (const Target *target)=0
 Removes a Target from the Target list. More...
 
virtual void removeTarget (int index)=0
 Removes a Target from the Target list. More...
 
virtual void removeZone (Zone *zone)=0
 Removes a Zone from the Zone list. More...
 
virtual void removeZone (int index)=0
 Removes a Zone from the Zone list. More...
 
virtual void reportError (const QString &message)=0
 Reports a session error. More...
 
virtual void saveSession ()=0
 Saves the session in the current session directory. More...
 
virtual void saveSession (const QDir &directory)=0
 Saves the session, and changes the current session directory. More...
 
virtual void setAftertouchPropertyVisible (bool visible)=0
 Sets the visibility of the aftertouch property. More...
 
virtual void setChannelPressurePropertyVisible (bool visible)=0
 Sets the visibility of the channel pressure property. More...
 
virtual void setChannelPropertyVisible (bool visible)=0
 Sets the visibility of the channel property. More...
 
virtual void setControlPropertyVisible (MIDIData control, bool visible)=0
 Sets the visibility of a control property. More...
 
virtual void setDrySamplePropertyVisible (bool visible)=0
 Sets the visibility of the dry sample property. More...
 
virtual void setFocusedComponent (const Component *component)=0
 Sets the focused component. More...
 
virtual void setNotePropertyVisible (bool visible)=0
 Sets the visibility of the note property. More...
 
virtual void setReleaseTimePropertyVisible (bool visible)=0
 Sets the visibility of the release time property. More...
 
virtual void setSampleChannelCount (SampleChannelCount sampleChannelCount)=0
 Sets the SampleChannelCount for the session. More...
 
virtual void setSampleRate (SampleRate sampleRate)=0
 Sets the SampleRate for the session. More...
 
virtual void setSampleTimePropertyVisible (bool visible)=0
 Sets the visibility of the sample time property. More...
 
virtual void setSelectedEffect (const Effect *effect)=0
 Sets the selected Effect. More...
 
virtual void setSelectedEffect (int index)=0
 Sets the selected Effect. More...
 
virtual void setSelectedTarget (const Target *target)=0
 Sets the selected Target. More...
 
virtual void setSelectedTarget (int index)=0
 Sets the selected Target. More...
 
virtual void setSessionModified ()=0
 Changes the session state to SESSIONSTATE_MODIFIED if the session state is SESSIONSTATE_CURRENT. More...
 
virtual void setStatusPropertyVisible (bool visible)=0
 Sets the visibility of the status property. More...
 
virtual void setVelocityPropertyVisible (bool visible)=0
 Sets the visibility of the velocity property. More...
 
virtual void setWetSamplePropertyVisible (bool visible)=0
 Sets the visibility of the wet sample property. More...
 
virtual void setZoneSelected (const Zone *zone, bool selected)=0
 (De)selects a Zone. More...
 
virtual void setZoneSelected (int index, bool selected)=0
 (De)selects a Zone. More...
 
virtual void sortZones (const ZoneComparer &comparer, bool ascending=true)=0
 Sorts the Zone list. More...
 
virtual void unloadSession ()=0
 Unloads the current session. More...
 

Signals

void activatingParticipant (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant is being activated. More...
 
void addingEffect (const synthclone::Effect *effect, int index)
 Emitted when an Effect is being added to the Effect list. More...
 
void addingEffectJob (const synthclone::EffectJob *job, int index)
 Emitted when an EffectJob is being added to the EffectJob queue. More...
 
void addingMenuAction (const synthclone::MenuAction *action, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuAction is being added to a root menu. More...
 
void addingMenuAction (const synthclone::MenuAction *action, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuAction is being added to an Effect menu. More...
 
void addingMenuAction (const synthclone::MenuAction *action, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuAction is being added to a Sampler menu. More...
 
void addingMenuAction (const synthclone::MenuAction *action, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuAction is being added to a Target menu. More...
 
void addingMenuSeparator (const synthclone::MenuSeparator *separator, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuSeparator is being added to a root menu. More...
 
void addingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuSeparator is being added to an Effect menu. More...
 
void addingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuSeparator is being added to a Sampler menu. More...
 
void addingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuSeparator is being added to a Target menu. More...
 
void addingParticipant (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant is being added. More...
 
void addingSampler (const synthclone::Sampler *sampler)
 Emitted when a Sampler is being added. More...
 
void addingSamplerJob (const synthclone::SamplerJob *job, int index)
 Emitted when a SamplerJob is being added to the SamplerJob queue. More...
 
void addingTarget (const synthclone::Target *target, int index)
 Emitted when a Target is being added to the Target list. More...
 
void addingZone (const synthclone::Zone *zone, int index)
 Emitted when a Zone is being added to the Zone list. More...
 
void aftertouchPropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the aftertouch property is changed. More...
 
void buildingTarget (const synthclone::Target *target)
 Emitted when a Target is being built. More...
 
void buildingTargets ()
 Emitted when a Target build operation is starting. More...
 
void channelPressurePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the channel pressure property is changed. More...
 
void channelPropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the channel property is changed. More...
 
void controlPropertyVisibilityChanged (synthclone::MIDIData control, bool visible)
 Emitted when the visibility of a control property is changed. More...
 
void currentEffectJobChanged (const synthclone::EffectJob *job)
 Emitted when the current effect job is changed. More...
 
void currentSamplerJobChanged (const synthclone::SamplerJob *job)
 Emitted when the current sampler job is changed. More...
 
void deactivatingParticipant (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant is being deactivated. More...
 
void drySamplePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the dry sample property is changed. More...
 
void effectAdded (const synthclone::Effect *effect, int index)
 Emitted when an Effect has been added to the Effect list. More...
 
void effectJobAdded (const synthclone::EffectJob *job, int index)
 Emitted when an EffectJob has been added to the EffectJob queue. More...
 
void effectJobMoved (const synthclone::EffectJob *job, int fromIndex, int toIndex)
 Emitted when an EffectJob is moved in the EffectJob queue. More...
 
void effectJobRemoved (const synthclone::EffectJob *job, int index)
 Emitted when an EffectJob has been removed from the EffectJob queue. More...
 
void effectMoved (const synthclone::Effect *effect, int fromIndex, int toIndex)
 Emitted when an Effect has been moved in the Effect list. More...
 
void effectRemoved (const synthclone::Effect *effect, int index)
 Emitted when an Effect has been removed from the Effect list. More...
 
void errorReported (const QString &message)
 Emitted when an error is reported. More...
 
void focusedComponentChanged (const synthclone::Component *component)
 Emitted when the focused component is changed. More...
 
void menuActionAdded (const synthclone::MenuAction *action, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuAction has been added to a root menu. More...
 
void menuActionAdded (const synthclone::MenuAction *action, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuAction has been added to an Effect menu. More...
 
void menuActionAdded (const synthclone::MenuAction *action, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuAction has been added to a Sampler menu. More...
 
void menuActionAdded (const synthclone::MenuAction *action, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuAction has been added to a Target menu. More...
 
void menuActionRemoved (const synthclone::MenuAction *action, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuAction has been removed from a root menu. More...
 
void menuActionRemoved (const synthclone::MenuAction *action, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuAction has been removed from an Effect menu. More...
 
void menuActionRemoved (const synthclone::MenuAction *action, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuAction has been removed from a Sampler menu. More...
 
void menuActionRemoved (const synthclone::MenuAction *action, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuAction has been removed from a Target menu. More...
 
void menuSeparatorAdded (const synthclone::MenuSeparator *separator, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuSeparator has been added to a root menu. More...
 
void menuSeparatorAdded (const synthclone::MenuSeparator *separator, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuSeparator has been added to an Effect menu. More...
 
void menuSeparatorAdded (const synthclone::MenuSeparator *separator, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuSeparator has been added to a Sampler menu. More...
 
void menuSeparatorAdded (const synthclone::MenuSeparator *separator, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuSeparator has been added to a Target menu. More...
 
void menuSeparatorRemoved (const synthclone::MenuSeparator *separator, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuSeparator has been removed from a root menu. More...
 
void menuSeparatorRemoved (const synthclone::MenuSeparator *separator, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuSeparator has been removed from an Effect menu. More...
 
void menuSeparatorRemoved (const synthclone::MenuSeparator *separator, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuSeparator has been removed from a Sampler menu. More...
 
void menuSeparatorRemoved (const synthclone::MenuSeparator *separator, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuSeparator has been removed from a Target menu. More...
 
void movingEffect (const synthclone::Effect *effect, int fromIndex, int toIndex)
 Emitted when an Effect is being moved. More...
 
void movingEffectJob (const synthclone::EffectJob *job, int fromIndex, int toIndex)
 Emitted when an EffectJob is being moved. More...
 
void movingSamplerJob (const synthclone::SamplerJob *job, int fromIndex, int toIndex)
 Emitted when a SamplerJob is being moved. More...
 
void movingTarget (const synthclone::Target *target, int fromIndex, int toIndex)
 Emitted when a Target is being moved. More...
 
void movingZone (const synthclone::Zone *zone, int fromIndex, int toIndex)
 Emitted when a Zone is being moved. More...
 
void notePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the note property is changed. More...
 
void participantActivated (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant has being activated. More...
 
void participantAdded (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant has being added. More...
 
void participantDeactivated (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant has being deactivated. More...
 
void participantRemoved (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant has being removed. More...
 
void releaseTimePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the release time property is changed. More...
 
void removingEffect (const synthclone::Effect *effect, int index)
 Emitted when an Effect is being removed from the Effect list. More...
 
void removingEffectJob (const synthclone::EffectJob *job, int index)
 Emitted when an EffectJob is being removed from the EffectJob queue. More...
 
void removingMenuAction (const synthclone::MenuAction *action, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuAction is being removed from a root menu. More...
 
void removingMenuAction (const synthclone::MenuAction *action, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuAction is being removed from an Effect menu. More...
 
void removingMenuAction (const synthclone::MenuAction *action, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuAction is being removed from a Sampler menu. More...
 
void removingMenuAction (const synthclone::MenuAction *action, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuAction is being removed from a Target menu. More...
 
void removingMenuSeparator (const synthclone::MenuSeparator *separator, synthclone::Menu menu, const QStringList &subMenus)
 Emitted when a MenuSeparator is being removed from a root menu. More...
 
void removingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Effect *effect, const QStringList &subMenus)
 Emitted when a MenuSeparator is being removed from an Effect menu. More...
 
void removingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Sampler *sampler, const QStringList &subMenus)
 Emitted when a MenuSeparator is being removed from a Sampler menu. More...
 
void removingMenuSeparator (const synthclone::MenuSeparator *separator, const synthclone::Target *target, const QStringList &subMenus)
 Emitted when a MenuSeparator is being removed from a Target menu. More...
 
void removingParticipant (const synthclone::Participant *participant, const synthclone::Participant *parent, const QByteArray &id)
 Emitted when a Participant is being removed. More...
 
void removingSampler (const synthclone::Sampler *sampler)
 Emitted when a Sampler is being removed. More...
 
void removingSamplerJob (const synthclone::SamplerJob *job, int index)
 Emitted when a SamplerJob is being removed from the SamplerJob queue. More...
 
void removingTarget (const synthclone::Target *target, int index)
 Emitted when a Target is being removed from the Target list. More...
 
void removingZone (const synthclone::Zone *zone, int index)
 Emitted when an Zone is being removed from the Zone list. More...
 
void sampleChannelCountChanged (synthclone::SampleChannelCount count)
 Emitted when the session's synthclone::SampleChannelCount is changed. More...
 
void samplerAdded (const synthclone::Sampler *sampler)
 Emitted when a Sampler has been added. More...
 
void sampleRateChanged (synthclone::SampleRate sampleRate)
 Emitted when the session's synthclone::SampleRate is changed. More...
 
void samplerJobAdded (const synthclone::SamplerJob *job, int index)
 Emitted when a SamplerJob has been added to the SamplerJob queue. More...
 
void samplerJobMoved (const synthclone::SamplerJob *job, int fromIndex, int toIndex)
 Emitted when a SamplerJob is moved in the SamplerJob queue. More...
 
void samplerJobRemoved (const synthclone::SamplerJob *job, int index)
 Emitted when a SamplerJob has been removed from the SamplerJob queue. More...
 
void samplerRemoved (const synthclone::Sampler *sampler)
 Emitted when a Sampler is removed. More...
 
void sampleTimePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the sample time property is changed. More...
 
void selectedEffectChanged (const synthclone::Effect *effect, int index)
 Emitted when the selected Effect is changed. More...
 
void selectedTargetChanged (const synthclone::Target *target, int index)
 Emitted when the selected Target is changed. More...
 
void sessionStateChanged (synthclone::SessionState state, const QDir *directory)
 Emitted when the synthclone::SessionState changes. More...
 
void statusPropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the status property is changed. More...
 
void targetAdded (const synthclone::Target *target, int index)
 Emitted when a Target has been added to the Target list. More...
 
void targetBuildError (const synthclone::Target *target, const QString &message)
 Emitted when an error occurs while attempting to build a Target. More...
 
void targetBuilt (const synthclone::Target *target)
 Emitted when a Target is successfully built. More...
 
void targetsBuilt ()
 Emitted when a Target build operation is completed. More...
 
void targetMoved (const synthclone::Target *target, int fromIndex, int toIndex)
 Emitted when a Target has been moved in the Target list. More...
 
void targetRemoved (const synthclone::Target *target, int index)
 Emitted when a Target has been removed from the Target list. More...
 
void velocityPropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the velocity property is changed. More...
 
void wetSamplePropertyVisibilityChanged (bool visible)
 Emitted when the visibility of the wet sample property is changed. More...
 
void zoneAdded (const synthclone::Zone *zone, int index)
 Emitted when a Zone has been added to the Zone list. More...
 
void zoneMoved (const synthclone::Zone *zone, int fromIndex, int toIndex)
 Emitted when a Zone has been moved in the Zone list. More...
 
void zoneRemoved (const synthclone::Zone *zone, int index)
 Emitted when a Zone has been removed from the Zone list. More...
 
void zoneSelectionChanged (const synthclone::Zone *zone, bool selected)
 Emitted when the selection of a Zone changes. More...
 

Public Member Functions

virtual const EffectJobgetCurrentEffectJob () const =0
 Gets the EffectJob currently being executed by the registered Effect objects. More...
 
virtual const SamplerJobgetCurrentSamplerJob () const =0
 Gets the SamplerJob currently being executed by the Sampler. More...
 
virtual const EffectgetEffect (int index) const =0
 Gets the effect. More...
 
virtual int getEffectCount () const =0
 Gets the count of registered effects. More...
 
virtual int getEffectIndex (const Effect *effect) const =0
 Gets the index of an effect. More...
 
virtual const EffectJobgetEffectJob (int index) const =0
 Gets an EffectJob from the EffectJob queue. More...
 
virtual int getEffectJobCount () const =0
 Gets the count of EffectJob objects in the EffectJob queue. More...
 
virtual int getEffectJobIndex (const synthclone::EffectJob *job) const =0
 Gets the index of an EffectJob in the EffectJob queue. More...
 
virtual const ComponentgetFocusedComponent () const =0
 Gets the component that currently has focus. More...
 
virtual int getMajorVersion () const =0
 Gets the major portion of the version of synthclone. More...
 
virtual int getMinorVersion () const =0
 Gets the minor portion of the version of synthclone. More...
 
virtual const ParticipantgetParticipant (const QByteArray &id) const =0
 Gets a Participant. More...
 
virtual const ParticipantgetParticipant (int index, const Participant *parent=0) const =0
 Gets a Participant. More...
 
virtual int getParticipantCount (const Participant *parent=0) const =0
 Gets the count of child Participants of a Participant, or the count of root Participant objects. More...
 
virtual QByteArray getParticipantId (const Participant *participant) const =0
 Gets the id of a Participant. More...
 
virtual const ParticipantgetParticipantParent (const Participant *participant) const =0
 Gets the parent Participant of a Participant. More...
 
virtual int getRevision () const =0
 Gets the revision portion of the version of synthclone. More...
 
virtual SampleChannelCount getSampleChannelCount () const =0
 Gets the current sample channel count. More...
 
virtual const SamplergetSampler () const =0
 Gets the Sampler registered with the session. More...
 
virtual const SamplerJobgetSamplerJob (int index) const =0
 Gets a SamplerJob from the SamplerJob queue. More...
 
virtual int getSamplerJobCount () const =0
 Gets the count of SamplerJob objects in the SamplerJob queue. More...
 
virtual int getSamplerJobIndex (const synthclone::SamplerJob *job) const =0
 Gets the index of a SamplerJob in the SamplerJob queue. More...
 
virtual SampleRate getSampleRate () const =0
 Gets the session sample rate. More...
 
virtual const EffectgetSelectedEffect () const =0
 Gets the currently selected Effect. More...
 
virtual const TargetgetSelectedTarget () const =0
 Gets the currently selected target. More...
 
virtual ZonegetSelectedZone (int index)=0
 Gets a Zone from the selected Zone list. More...
 
virtual int getSelectedZoneCount () const =0
 Gets the count of Zone objects in the selected Zone list. More...
 
virtual const QDir * getSessionDirectory () const =0
 Gets the current session directory. More...
 
virtual SessionState getSessionState () const =0
 Gets the state of the current session. More...
 
virtual const TargetgetTarget (int index) const =0
 Gets a Target from the Target list. More...
 
virtual int getTargetCount () const =0
 Gets the count of Target objects in the Target list. More...
 
virtual int getTargetIndex (const Target *target) const =0
 Gets the index of a Target in the Target list. More...
 
virtual ZonegetZone (int index)=0
 Gets a Zone. More...
 
virtual int getZoneCount () const =0
 Gets the count of Zones in the Zone list. More...
 
virtual int getZoneIndex (const Zone *zone) const =0
 Gets the index of a Zone in the Zone list. More...
 
virtual bool isAftertouchPropertyVisible () const =0
 Gets a boolean indicating whether or not the aftertouch property is visible. More...
 
virtual bool isChannelPressurePropertyVisible () const =0
 Gets a boolean indicating whether or not the channel pressure property is visible. More...
 
virtual bool isChannelPropertyVisible () const =0
 Gets a boolean indicating whether or not the channel property is visible. More...
 
virtual bool isControlPropertyVisible (MIDIData control) const =0
 Gets a boolean indicating whether or not a control property is visible. More...
 
virtual bool isDrySamplePropertyVisible () const =0
 Gets a boolean indicating whether or not the dry sample property is visible. More...
 
virtual bool isNotePropertyVisible () const =0
 Gets a boolean indicating whether or not the note property is visible. More...
 
virtual bool isParticipantActivated (const Participant *participant) const =0
 Gets a boolean indicating whether or not a Participant is activated. More...
 
virtual bool isReleaseTimePropertyVisible () const =0
 Gets a boolean indicating whether or not the release time property is visible. More...
 
virtual bool isSampleTimePropertyVisible () const =0
 Gets a boolean indicating whether or not the sample time property is visible. More...
 
virtual bool isSessionDirectory (const QDir &directory) const =0
 Gets a boolean indicating whether or not a directory contains a valid synthclone session. More...
 
virtual bool isStatusPropertyVisible () const =0
 Gets a boolean indicating whether or not the status property is visible. More...
 
virtual bool isVelocityPropertyVisible () const =0
 Gets a boolean indicating whether or not the velocity property is visible. More...
 
virtual bool isWetSamplePropertyVisible () const =0
 Gets a boolean indicating whether or not the wet sample property is visible. More...
 
virtual bool isZoneSelected (const Zone *zone) const =0
 Gets a boolean indicating whether or not a Zone is selected. More...
 
virtual bool isZoneSelected (int index) const =0
 Gets a boolean indicating whether or not a Zone is selected. More...
 

Protected Member Functions

 Context (QObject *parent=0)
 Constructs a new Context object. More...
 
virtual ~Context ()
 Destroys the Context object. More...
 

Detailed Description

Context objects allow Participant objects to interact with a synthclone session.

They allow Participant objects to do almost everything to a session that the application itself can do.

Constructor & Destructor Documentation

synthclone::Context::Context ( QObject *  parent = 0)
explicitprotected

Constructs a new Context object.

This constructor cannot be called directly. Context objects are provided to Participant objects when the Participant::activate() method is called.

Parameters
parentThe parent object of the new Context object.
virtual synthclone::Context::~Context ( )
protectedvirtual

Destroys the Context object.

The memory of Context objects is managed by the application.

Member Function Documentation

virtual void synthclone::Context::abortCurrentSamplerJob ( )
pure virtualslot

Tells the Sampler to abort the current SamplerJob.

virtual void synthclone::Context::activateParticipant ( const synthclone::Participant participant)
pure virtualslot

Activates a Participant.

This allows a Participant object to interact with the application.

Parameters
participantThe Participant object to activate.
void synthclone::Context::activatingParticipant ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant is being activated.

Parameters
participantThe Participant being activated.
parentThe parent Participant of the Participant being activated. If this argument is set to 0, then the Participant being activated is a root Participant.
idThe id of the Participant being activated.
virtual const Registration& synthclone::Context::addEffect ( Effect effect,
int  index = -1 
)
pure virtualslot

Adds an Effect to the session.

Parameters
effectThe Effect object to add.
indexThe index at which the Effect object should be added.
Returns
A Registration object corresponding to the added Effect.
virtual const EffectJob* synthclone::Context::addEffectJob ( Zone zone)
pure virtualslot

Adds an EffectJob to the EffectJob queue.

Parameters
zoneThe Zone containing the dry Sample that effects will be applied to.
Returns
The new EffectJob.
void synthclone::Context::addingEffect ( const synthclone::Effect effect,
int  index 
)
signal

Emitted when an Effect is being added to the Effect list.

Parameters
effectThe Effect being added.
indexThe index at which the Effect will be added.
void synthclone::Context::addingEffectJob ( const synthclone::EffectJob job,
int  index 
)
signal

Emitted when an EffectJob is being added to the EffectJob queue.

Parameters
jobThe EffectJob being added.
indexThe index at which the EffectJob will be added.
void synthclone::Context::addingMenuAction ( const synthclone::MenuAction action,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being added to a root menu.

Parameters
actionThe MenuAction being added.
menuThe root menu.
subMenusA list of sub-menus that will be created from the root menu. The MenuAction will be created at the deepest menu.
void synthclone::Context::addingMenuAction ( const synthclone::MenuAction action,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being added to an Effect menu.

Parameters
actionThe MenuAction being added.
effectThe Effect corresponding to the Effect menu to add this action to.
subMenusA list of sub-menus that will be created from the Effect menu. The MenuAction will be created at the deepest menu.
void synthclone::Context::addingMenuAction ( const synthclone::MenuAction action,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being added to a Sampler menu.

Parameters
actionThe MenuAction being added.
samplerThe Sampler corresponding to the Sampler menu to add this action to.
subMenusA list of sub-menus that will be created from the Sampler menu. The MenuAction will be created at the deepest menu.
void synthclone::Context::addingMenuAction ( const synthclone::MenuAction action,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being added to a Target menu.

Parameters
actionThe MenuAction being added.
targetThe Target corresponding to the Target menu to add this action to.
subMenusA list of sub-menus that will be created from the Target menu. The MenuAction will be created at the deepest menu.
void synthclone::Context::addingMenuSeparator ( const synthclone::MenuSeparator separator,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being added to a root menu.

Parameters
separatorThe MenuSeparator being added.
menuThe root menu.
subMenusA list of sub-menus that will be created from the root menu. The MenuSeparator will be created at the deepest menu.
void synthclone::Context::addingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being added to an Effect menu.

Parameters
separatorThe MenuSeparator being added.
effectThe Effect corresponding to the Effect menu to add this separator to.
subMenusA list of sub-menus that will be created from the Effect menu. The MenuSeparator will be created at the deepest menu.
void synthclone::Context::addingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being added to a Sampler menu.

Parameters
separatorThe MenuSeparator being added.
samplerThe Sampler corresponding to the Sampler menu to add this separator to.
subMenusA list of sub-menus that will be created from the Sampler menu. The MenuSeparator will be created at the deepest menu.
void synthclone::Context::addingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being added to a Target menu.

Parameters
separatorThe MenuSeparator being added.
targetThe Target corresponding to the Target menu to add this separator to.
subMenusA list of sub-menus that will be created from the Target menu. The MenuSeparator will be created at the deepest menu.
void synthclone::Context::addingParticipant ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant is being added.

Parameters
participantThe Participant being added.
parentThe parent Participant of the Participant being added. If this argument is set to 0, then the Participant being added is a root Participant.
idThe id of the Participant being added.
void synthclone::Context::addingSampler ( const synthclone::Sampler sampler)
signal

Emitted when a Sampler is being added.

Parameters
samplerThe Sampler being added.
void synthclone::Context::addingSamplerJob ( const synthclone::SamplerJob job,
int  index 
)
signal

Emitted when a SamplerJob is being added to the SamplerJob queue.

Parameters
jobThe SamplerJob being added.
indexThe index at which the SamplerJob will be added.
void synthclone::Context::addingTarget ( const synthclone::Target target,
int  index 
)
signal

Emitted when a Target is being added to the Target list.

Parameters
targetThe Target being added.
indexThe index at which the Target will be added.
void synthclone::Context::addingZone ( const synthclone::Zone zone,
int  index 
)
signal

Emitted when a Zone is being added to the Zone list.

Parameters
zoneThe Zone being added.
indexThe index at which the Zone will be added.
virtual const Registration& synthclone::Context::addMenuAction ( MenuAction action,
Menu  menu,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuAction to the application.

Parameters
actionThe MenuAction to add.
menuThe root synthclone menu to add the action to.
subMenusA list of sub-menus to create from the root menu. The MenuAction will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuAction.
virtual const Registration& synthclone::Context::addMenuAction ( MenuAction action,
const Effect effect,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuAction to the application.

Parameters
actionThe MenuAction to add.
effectThe Effect corresponding to the effect menu to add this action to.
subMenusA list of sub-menus to create from the effect menu. The MenuAction will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuAction.
virtual const Registration& synthclone::Context::addMenuAction ( MenuAction action,
const Sampler sampler,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuAction to the application.

Parameters
actionThe MenuAction to add.
samplerThe Sampler corresponding to the sampler menu to add this action to.
subMenusA list of sub-menus to create from the sampler menu. The MenuAction will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuAction.
virtual const Registration& synthclone::Context::addMenuAction ( MenuAction action,
const Target target,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuAction to the application.

Parameters
actionThe MenuAction to add.
targetThe Target corresponding to the target menu to add this action to.
subMenusA list of sub-menus to create from the target menu. The MenuAction will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuAction.
virtual const Registration& synthclone::Context::addMenuSeparator ( MenuSeparator separator,
Menu  menu,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuSeparator to the application.

Parameters
separatorThe MenuSeparator to add.
menuThe root synthclone menu to add the separator to.
subMenusA list of sub-menus to create from the root menu. The MenuSeparator will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuSeparator.
virtual const Registration& synthclone::Context::addMenuSeparator ( MenuSeparator separator,
const Effect effect,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuSeparator to the application.

Parameters
separatorThe MenuSeparator to add.
effectThe Effect corresponding to the effect menu to add this separator to.
subMenusA list of sub-menus to create from the effect menu. The MenuSeparator will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuSeparator.
virtual const Registration& synthclone::Context::addMenuSeparator ( MenuSeparator separator,
const Sampler sampler,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuSeparator to the application.

Parameters
separatorThe MenuSeparator to add.
samplerThe Sampler corresponding to the sampler menu to add this separator to.
subMenusA list of sub-menus to create from the sampler menu. The MenuSeparator will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuSeparator.
virtual const Registration& synthclone::Context::addMenuSeparator ( MenuSeparator separator,
const Target target,
const QStringList &  subMenus = QStringList() 
)
pure virtualslot

Adds a MenuSeparator to the application.

Parameters
separatorThe MenuSeparator to add.
targetThe Target corresponding to the target menu to add this separator to.
subMenusA list of sub-menus to create from the target menu. The MenuSeparator will be created at the deepest menu.
Returns
A Registration object corresponding to the added MenuSeparator.
virtual const Registration& synthclone::Context::addParticipant ( Participant participant,
const QByteArray &  subId 
)
pure virtualslot

Adds a Participant to the session.

At this point, the Participant is made available for activation, but it cannot interact with the application until its Participant::activate() method is called.

Parameters
participantThe Participant object to add.
subIdThe sub-id of the Participant. The sub-id will be used in conjunction with the parent Participant object's id to create this Participant object's full id, which will be in the form '[parentId].[subId]'. The sub-id must start and end with a number or letter, and contain only numbers, letters, and hyphens. See IPlugin::getId() for more information on ids.
Returns
A Registration object corresponding to the added Participant.
Note
The practical use case I have in mind for allowing a Participant object to add child Participant objects is to enable the creation of bindings to other programming languages, where a root Participant creates the resources necessary to use libsynthclone in another language, and then loads plugins as child Participant objects. There may be other practical uses.
virtual const Registration& synthclone::Context::addSampler ( Sampler sampler)
pure virtualslot

Adds a Sampler to the session, removing any Sampler that may already be registered with the session.

Parameters
samplerThe Sampler to add.
Returns
A Registration object corresponding to the added Sampler.
virtual const SamplerJob* synthclone::Context::addSamplerJob ( SamplerJob::Type  type,
Zone zone 
)
pure virtualslot

Adds a SamplerJob object to the SamplerJob queue.

Parameters
typeThe job type.
zoneThe Zone that the job will operate on.
Returns
The new SamplerJob object.
See Also
SamplerJob::Type
virtual const Registration& synthclone::Context::addTarget ( Target target,
int  index = -1 
)
pure virtualslot

Adds a Target to the session.

Parameters
targetThe Target object to add.
indexThe index at which the Target object should be added.
Returns
A Registration object corresponding to the added Target.
virtual Zone* synthclone::Context::addZone ( int  index = -1)
pure virtualslot

Adds a new zone to the session.

Parameters
indexThe index at which the new Zone should be added.
Returns
The new Zone object.
void synthclone::Context::aftertouchPropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the aftertouch property is changed.

Parameters
visibleThe visibility of the aftertouch property.
void synthclone::Context::buildingTarget ( const synthclone::Target target)
signal

Emitted when a Target is being built.

Parameters
targetThe Target being built.
void synthclone::Context::buildingTargets ( )
signal

Emitted when a Target build operation is starting.

virtual void synthclone::Context::buildTargets ( )
pure virtualslot

Attempts to build all registered targets.

void synthclone::Context::channelPressurePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the channel pressure property is changed.

Parameters
visibleThe visibility of the channel pressure property.
void synthclone::Context::channelPropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the channel property is changed.

Parameters
visibleThe visibility of the channel property.
void synthclone::Context::controlPropertyVisibilityChanged ( synthclone::MIDIData  control,
bool  visible 
)
signal

Emitted when the visibility of a control property is changed.

Parameters
controlThe control.
visibleThe visibility of the control property.
virtual void synthclone::Context::createSession ( const QDir &  directory,
SampleRate  sampleRate,
SampleChannelCount  count 
)
pure virtualslot

Writes an empty synthclone session to a directory.

Parameters
directoryThe directory to write the session to.
sampleRateThe sample rate for the session.
countThe sample channel count for the session.
void synthclone::Context::currentEffectJobChanged ( const synthclone::EffectJob job)
signal

Emitted when the current effect job is changed.

Parameters
jobThe current effect job.
void synthclone::Context::currentSamplerJobChanged ( const synthclone::SamplerJob job)
signal

Emitted when the current sampler job is changed.

Parameters
jobThe current sampler job.
virtual void synthclone::Context::deactivateParticipant ( const Participant participant)
pure virtualslot

Deactivates a Participant.

The Participant will cease interacting with the application.

Parameters
participantThe Participant to deactivate.
void synthclone::Context::deactivatingParticipant ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant is being deactivated.

Parameters
participantThe Participant being deactivated.
parentThe parent Participant of the Participant being deactivated. If this argument is set to 0, then the Participant being deactivated is a root Participant.
idThe id of the Participant being deactivated.
void synthclone::Context::drySamplePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the dry sample property is changed.

Parameters
visibleThe visibility of the dry sample property.
void synthclone::Context::effectAdded ( const synthclone::Effect effect,
int  index 
)
signal

Emitted when an Effect has been added to the Effect list.

Parameters
effectThe added Effect.
indexThe index of the Effect.
void synthclone::Context::effectJobAdded ( const synthclone::EffectJob job,
int  index 
)
signal

Emitted when an EffectJob has been added to the EffectJob queue.

Parameters
jobThe added EffectJob.
indexThe index of the EffectJob.
void synthclone::Context::effectJobMoved ( const synthclone::EffectJob job,
int  fromIndex,
int  toIndex 
)
signal

Emitted when an EffectJob is moved in the EffectJob queue.

Parameters
jobThe EffectJob.
fromIndexThe index the EffectJob was moved from.
toIndexThe current index of the EffectJob.
void synthclone::Context::effectJobRemoved ( const synthclone::EffectJob job,
int  index 
)
signal

Emitted when an EffectJob has been removed from the EffectJob queue.

Parameters
jobThe removed EffectJob.
indexThe index the EffectJob was removed from.
void synthclone::Context::effectMoved ( const synthclone::Effect effect,
int  fromIndex,
int  toIndex 
)
signal

Emitted when an Effect has been moved in the Effect list.

Parameters
effectThe moved Effect.
fromIndexThe index the Effect was moved from.
toIndexThe current index of the Effect.
void synthclone::Context::effectRemoved ( const synthclone::Effect effect,
int  index 
)
signal

Emitted when an Effect has been removed from the Effect list.

Parameters
effectThe removed Effect.
indexThe index at which the Effect was removed.
void synthclone::Context::errorReported ( const QString &  message)
signal

Emitted when an error is reported.

Parameters
messageThe error message.
void synthclone::Context::focusedComponentChanged ( const synthclone::Component component)
signal

Emitted when the focused component is changed.

Parameters
componentThe component that has gained focus. If this argument is set to 0, then there currently isn't a focused component.
virtual const EffectJob* synthclone::Context::getCurrentEffectJob ( ) const
pure virtual

Gets the EffectJob currently being executed by the registered Effect objects.

Returns
The EffectJob, or 0 if there isn't a current EffectJob.
virtual const SamplerJob* synthclone::Context::getCurrentSamplerJob ( ) const
pure virtual

Gets the SamplerJob currently being executed by the Sampler.

Returns
The SamplerJob, or 0 if there isn't a current SamplerJob.
virtual const Effect* synthclone::Context::getEffect ( int  index) const
pure virtual

Gets the effect.

Parameters
indexThe index of the effect.
Returns
The effect.
virtual int synthclone::Context::getEffectCount ( ) const
pure virtual

Gets the count of registered effects.

Returns
The count.
virtual int synthclone::Context::getEffectIndex ( const Effect effect) const
pure virtual

Gets the index of an effect.

Parameters
effectThe effect.
Returns
The effect index.
virtual const EffectJob* synthclone::Context::getEffectJob ( int  index) const
pure virtual

Gets an EffectJob from the EffectJob queue.

Parameters
indexThe index of the EffectJob to get.
Returns
The EffectJob object.
virtual int synthclone::Context::getEffectJobCount ( ) const
pure virtual

Gets the count of EffectJob objects in the EffectJob queue.

Returns
The count.
virtual int synthclone::Context::getEffectJobIndex ( const synthclone::EffectJob job) const
pure virtual

Gets the index of an EffectJob in the EffectJob queue.

Parameters
jobThe EffectJob object.
Returns
The index.
virtual const Component* synthclone::Context::getFocusedComponent ( ) const
pure virtual

Gets the component that currently has focus.

Returns
The focused component, or 0 if no component currently has focus.
virtual int synthclone::Context::getMajorVersion ( ) const
pure virtual

Gets the major portion of the version of synthclone.

Returns
The major version.
virtual int synthclone::Context::getMinorVersion ( ) const
pure virtual

Gets the minor portion of the version of synthclone.

Returns
The minor version.
virtual const Participant* synthclone::Context::getParticipant ( const QByteArray &  id) const
pure virtual

Gets a Participant.

Parameters
idThe id of the Participant.
Returns
The Participant with the given id.
virtual const Participant* synthclone::Context::getParticipant ( int  index,
const Participant parent = 0 
) const
pure virtual

Gets a Participant.

Parameters
indexThe index of the Participant to get in relation to the parent.
parentThe optional parent Participant. If no Participant is specified, then the root Participant list will be scanned.
Returns
The index-th Participant with the given parent.
virtual int synthclone::Context::getParticipantCount ( const Participant parent = 0) const
pure virtual

Gets the count of child Participants of a Participant, or the count of root Participant objects.

Parameters
parentThe parent Participant. If the parent isn't specified, then the root Participant list will be used.
Returns
The count.
virtual QByteArray synthclone::Context::getParticipantId ( const Participant participant) const
pure virtual

Gets the id of a Participant.

Parameters
participantThe Participant.
Returns
The Participant id.
virtual const Participant* synthclone::Context::getParticipantParent ( const Participant participant) const
pure virtual

Gets the parent Participant of a Participant.

Parameters
participantThe Participant.
Returns
The parent Participant, or 0 if the Participant is a root Participant.
virtual int synthclone::Context::getRevision ( ) const
pure virtual

Gets the revision portion of the version of synthclone.

Returns
The revision.
virtual SampleChannelCount synthclone::Context::getSampleChannelCount ( ) const
pure virtual

Gets the current sample channel count.

Returns
The sample channel count.
virtual const Sampler* synthclone::Context::getSampler ( ) const
pure virtual

Gets the Sampler registered with the session.

Returns
The register Sampler, or 0 if there isn't a Sampler registered with the session.
virtual SampleRate synthclone::Context::getSampleRate ( ) const
pure virtual

Gets the session sample rate.

Returns
The sample rate.
virtual const SamplerJob* synthclone::Context::getSamplerJob ( int  index) const
pure virtual

Gets a SamplerJob from the SamplerJob queue.

Parameters
indexThe index of the SamplerJob to get.
Returns
The SamplerJob object.
virtual int synthclone::Context::getSamplerJobCount ( ) const
pure virtual

Gets the count of SamplerJob objects in the SamplerJob queue.

Returns
The count.
virtual int synthclone::Context::getSamplerJobIndex ( const synthclone::SamplerJob job) const
pure virtual

Gets the index of a SamplerJob in the SamplerJob queue.

Parameters
jobThe SamplerJob object.
Returns
The index.
virtual const Effect* synthclone::Context::getSelectedEffect ( ) const
pure virtual

Gets the currently selected Effect.

Returns
The selected Effect, or 0 if there isn't an Effect selected.
virtual const Target* synthclone::Context::getSelectedTarget ( ) const
pure virtual

Gets the currently selected target.

Returns
The selected Target, or 0 if there isn't a Target selected.
virtual Zone* synthclone::Context::getSelectedZone ( int  index)
pure virtual

Gets a Zone from the selected Zone list.

Parameters
indexThe index of the Zone to get.
Returns
The Zone object.
virtual int synthclone::Context::getSelectedZoneCount ( ) const
pure virtual

Gets the count of Zone objects in the selected Zone list.

Returns
The count.
virtual const QDir* synthclone::Context::getSessionDirectory ( ) const
pure virtual

Gets the current session directory.

Returns
The current session directory, or 0 if there isn't an active session.
virtual SessionState synthclone::Context::getSessionState ( ) const
pure virtual

Gets the state of the current session.

Returns
The SessionState.
virtual const Target* synthclone::Context::getTarget ( int  index) const
pure virtual

Gets a Target from the Target list.

Parameters
indexThe index of the Target to get.
Returns
The Target object.
virtual int synthclone::Context::getTargetCount ( ) const
pure virtual

Gets the count of Target objects in the Target list.

Returns
The count.
virtual int synthclone::Context::getTargetIndex ( const Target target) const
pure virtual

Gets the index of a Target in the Target list.

Parameters
targetThe Target object.
Returns
The Target index.
virtual Zone* synthclone::Context::getZone ( int  index)
pure virtual

Gets a Zone.

Parameters
indexThe index of the Zone in the Zone list.
Returns
The Zone object.
virtual int synthclone::Context::getZoneCount ( ) const
pure virtual

Gets the count of Zones in the Zone list.

Returns
The count.
virtual int synthclone::Context::getZoneIndex ( const Zone zone) const
pure virtual

Gets the index of a Zone in the Zone list.

Parameters
zoneThe Zone object.
Returns
The index.
virtual bool synthclone::Context::isAftertouchPropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the aftertouch property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isChannelPressurePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the channel pressure property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isChannelPropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the channel property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isControlPropertyVisible ( MIDIData  control) const
pure virtual

Gets a boolean indicating whether or not a control property is visible.

Parameters
controlThe control index.
Returns
The boolean.
virtual bool synthclone::Context::isDrySamplePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the dry sample property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isNotePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the note property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isParticipantActivated ( const Participant participant) const
pure virtual

Gets a boolean indicating whether or not a Participant is activated.

Parameters
participantThe Participant object.
Returns
The boolean.
virtual bool synthclone::Context::isReleaseTimePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the release time property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isSampleTimePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the sample time property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isSessionDirectory ( const QDir &  directory) const
pure virtual

Gets a boolean indicating whether or not a directory contains a valid synthclone session.

Parameters
directoryThe directory to scan.
Returns
The boolean.
virtual bool synthclone::Context::isStatusPropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the status property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isVelocityPropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the velocity property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isWetSamplePropertyVisible ( ) const
pure virtual

Gets a boolean indicating whether or not the wet sample property is visible.

Returns
The boolean.
virtual bool synthclone::Context::isZoneSelected ( const Zone zone) const
pure virtual

Gets a boolean indicating whether or not a Zone is selected.

Parameters
zoneThe Zone to check.
Returns
The boolean.
virtual bool synthclone::Context::isZoneSelected ( int  index) const
pure virtual

Gets a boolean indicating whether or not a Zone is selected.

Parameters
indexThe index in the Zone list of the Zone to check.
Returns
The boolean.
virtual void synthclone::Context::loadSession ( const QDir &  directory)
pure virtualslot

Loads a synthclone session.

The currently loaded session will be unloaded first. This call will NOT prompt the user.

Parameters
directoryThe directory to load the session from.
See Also
unloadSession()
void synthclone::Context::menuActionAdded ( const synthclone::MenuAction action,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been added to a root menu.

Parameters
actionThe added MenuAction.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuAction is at the deepest menu.
void synthclone::Context::menuActionAdded ( const synthclone::MenuAction action,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been added to an Effect menu.

Parameters
actionThe added MenuAction.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuAction is at the deepest menu.
void synthclone::Context::menuActionAdded ( const synthclone::MenuAction action,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been added to a Sampler menu.

Parameters
actionThe added MenuAction.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuAction is at the deepest menu.
void synthclone::Context::menuActionAdded ( const synthclone::MenuAction action,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been added to a Target menu.

Parameters
actionThe added MenuAction.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuAction is at the deepest menu.
void synthclone::Context::menuActionRemoved ( const synthclone::MenuAction action,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been removed from a root menu.

Parameters
actionThe MenuAction.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuAction was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuActionRemoved ( const synthclone::MenuAction action,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been removed from an Effect menu.

Parameters
actionThe MenuAction.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuAction was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuActionRemoved ( const synthclone::MenuAction action,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been removed from a Sampler menu.

Parameters
actionThe MenuAction.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuAction was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuActionRemoved ( const synthclone::MenuAction action,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction has been removed from a Target menu.

Parameters
actionThe MenuAction.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuAction was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuSeparatorAdded ( const synthclone::MenuSeparator separator,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been added to a root menu.

Parameters
separatorThe added MenuSeparator.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuSeparator is at the deepest menu.
void synthclone::Context::menuSeparatorAdded ( const synthclone::MenuSeparator separator,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been added to an Effect menu.

Parameters
separatorThe added MenuSeparator.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuSeparator is at the deepest menu.
void synthclone::Context::menuSeparatorAdded ( const synthclone::MenuSeparator separator,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been added to a Sampler menu.

Parameters
separatorThe added MenuSeparator.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuSeparator is at the deepest menu.
void synthclone::Context::menuSeparatorAdded ( const synthclone::MenuSeparator separator,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been added to a Target menu.

Parameters
separatorThe added MenuSeparator.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuSeparator is at the deepest menu.
void synthclone::Context::menuSeparatorRemoved ( const synthclone::MenuSeparator separator,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been removed from a root menu.

Parameters
separatorThe MenuSeparator.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuSeparator was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuSeparatorRemoved ( const synthclone::MenuSeparator separator,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been removed from an Effect menu.

Parameters
separatorThe MenuSeparator.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuSeparator was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuSeparatorRemoved ( const synthclone::MenuSeparator separator,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been removed from a Sampler menu.

Parameters
separatorThe MenuSeparator.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuSeparator was at the deepest menu. Any empty sub-menus have been removed.
void synthclone::Context::menuSeparatorRemoved ( const synthclone::MenuSeparator separator,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator has been removed from a Target menu.

Parameters
separatorThe MenuSeparator.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuSeparator was at the deepest menu. Any empty sub-menus have been removed.
virtual void synthclone::Context::moveEffect ( int  fromIndex,
int  toIndex 
)
pure virtualslot

Moves an Effect.

Parameters
fromIndexThe index of the Effect to move.
toIndexThe index to move the Effect to.
virtual void synthclone::Context::moveEffectJob ( int  fromIndex,
int  toIndex 
)
pure virtualslot

Moves an EffectJob.

Parameters
fromIndexThe index of the EffectJob to move.
toIndexThe index to move the EffectJob to.
virtual void synthclone::Context::moveSamplerJob ( int  fromIndex,
int  toIndex 
)
pure virtualslot

Moves a SamplerJob.

Parameters
fromIndexThe index of the SamplerJob to move.
toIndexThe index to move the SamplerJob to.
virtual void synthclone::Context::moveTarget ( int  fromIndex,
int  toIndex 
)
pure virtualslot

Moves a Target.

Parameters
fromIndexThe index of the Target to move.
toIndexThe index to move the Target to.
virtual void synthclone::Context::moveZone ( int  fromIndex,
int  toIndex 
)
pure virtualslot

Moves a Zone.

Parameters
fromIndexThe index of the Zone to move.
toIndexThe index to move the Zone to.
void synthclone::Context::movingEffect ( const synthclone::Effect effect,
int  fromIndex,
int  toIndex 
)
signal

Emitted when an Effect is being moved.

Parameters
effectThe Effect being moved.
fromIndexThe Effect object's current index.
toIndexThe index the Effect will be moved to.
void synthclone::Context::movingEffectJob ( const synthclone::EffectJob job,
int  fromIndex,
int  toIndex 
)
signal

Emitted when an EffectJob is being moved.

Parameters
jobThe EffectJob being moved.
fromIndexThe EffectJob object's current index.
toIndexThe index the EffectJob will be moved to.
void synthclone::Context::movingSamplerJob ( const synthclone::SamplerJob job,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a SamplerJob is being moved.

Parameters
jobThe SamplerJob being moved.
fromIndexThe SamplerJob object's current index.
toIndexThe index the SamplerJob will be moved to.
void synthclone::Context::movingTarget ( const synthclone::Target target,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a Target is being moved.

Parameters
targetThe Target being moved.
fromIndexThe Target object's current index.
toIndexThe index the Target will be moved to.
void synthclone::Context::movingZone ( const synthclone::Zone zone,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a Zone is being moved.

Parameters
zoneThe Zone being moved.
fromIndexThe Zone object's current index.
toIndexThe index the Zone will be moved to.
void synthclone::Context::notePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the note property is changed.

Parameters
visibleThe visibility of the note property.
void synthclone::Context::participantActivated ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant has being activated.

Parameters
participantThe activated Participant.
parentThe parent Participant of the activated Participant. If this argument is set to 0, then the activated Participant is a root Participant.
idThe id of the activated Participant.
void synthclone::Context::participantAdded ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant has being added.

Parameters
participantThe added Participant.
parentThe parent Participant of the added Participant. If this argument is set to 0, then the added Participant is a root Participant.
idThe id of the added Participant.
void synthclone::Context::participantDeactivated ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant has being deactivated.

Parameters
participantThe deactivated Participant.
parentThe parent Participant of the deactivated Participant. If this argument is set to 0, then the deactivated Participant is a root Participant.
idThe id of the deactivated Participant.
void synthclone::Context::participantRemoved ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant has being removed.

Parameters
participantThe removed Participant.
parentThe parent Participant of the removed Participant. If this argument is set to 0, then the removed Participant is a root Participant.
idThe id of the removed Participant.
virtual void synthclone::Context::quit ( )
pure virtualslot

Terminates synthclone.

The current session will be unloaded, and the application will be terminated when the Participant returns control to the application.

See Also
unloadSession()
void synthclone::Context::releaseTimePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the release time property is changed.

Parameters
visibleThe visibility of the release time property.
virtual void synthclone::Context::removeEffect ( const Effect effect)
pure virtualslot

Removes an Effect.

Parameters
effectThe Effect to remove.
virtual void synthclone::Context::removeEffect ( int  index)
pure virtualslot

Removes an Effect.

Parameters
indexThe index of the Effect to remove.
virtual void synthclone::Context::removeEffectJob ( const EffectJob job)
pure virtualslot

Removes an EffectJob from the EffectJob queue.

Parameters
jobThe EffectJob to remove.
virtual void synthclone::Context::removeEffectJob ( int  index)
pure virtualslot

Removes an EffectJob from the EffectJob queue.

Parameters
indexThe index of the EffectJob to remove.
virtual void synthclone::Context::removeMenuAction ( const MenuAction action)
pure virtualslot

Removes a MenuAction.

Parameters
actionThe MenuAction to remove.
virtual void synthclone::Context::removeMenuSeparator ( const MenuSeparator separator)
pure virtualslot

Removes a MenuSeparator.

Parameters
separatorThe MenuSeparator to remove.
virtual void synthclone::Context::removeParticipant ( const Participant participant)
pure virtualslot

Removes a Participant from the session.

Parameters
participantThe Participant to remove.
virtual void synthclone::Context::removeSampler ( )
pure virtualslot

Removes a Sampler registered with the session.

virtual void synthclone::Context::removeSamplerJob ( const SamplerJob job)
pure virtualslot

Removes a SamplerJob from the SamplerJob queue.

Parameters
jobThe SamplerJob to remove.
virtual void synthclone::Context::removeSamplerJob ( int  index)
pure virtualslot

Removes a sampler job from the SamplerJob queue.

Parameters
indexThe index of the SamplerJob to remove.
virtual void synthclone::Context::removeTarget ( const Target target)
pure virtualslot

Removes a Target from the Target list.

Parameters
targetThe Target to remove.
virtual void synthclone::Context::removeTarget ( int  index)
pure virtualslot

Removes a Target from the Target list.

Parameters
indexThe index of the Target to remove.
virtual void synthclone::Context::removeZone ( Zone zone)
pure virtualslot

Removes a Zone from the Zone list.

Parameters
zoneThe Zone to remove.
virtual void synthclone::Context::removeZone ( int  index)
pure virtualslot

Removes a Zone from the Zone list.

Parameters
indexThe index of the Zone to remove.
void synthclone::Context::removingEffect ( const synthclone::Effect effect,
int  index 
)
signal

Emitted when an Effect is being removed from the Effect list.

Parameters
effectThe Effect being removed.
indexThe index of the Effect being removed.
void synthclone::Context::removingEffectJob ( const synthclone::EffectJob job,
int  index 
)
signal

Emitted when an EffectJob is being removed from the EffectJob queue.

Parameters
jobThe EffectJob being removed.
indexThe index of the EffectJob being removed.
void synthclone::Context::removingMenuAction ( const synthclone::MenuAction action,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being removed from a root menu.

Parameters
actionThe MenuAction being removed.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuAction is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuAction ( const synthclone::MenuAction action,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being removed from an Effect menu.

Parameters
actionThe MenuAction being removed.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuAction is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuAction ( const synthclone::MenuAction action,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being removed from a Sampler menu.

Parameters
actionThe MenuAction being removed.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuAction is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuAction ( const synthclone::MenuAction action,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuAction is being removed from a Target menu.

Parameters
actionThe MenuAction being removed.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuAction is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuSeparator ( const synthclone::MenuSeparator separator,
synthclone::Menu  menu,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being removed from a root menu.

Parameters
separatorThe MenuSeparator being removed.
menuThe root menu.
subMenusA list of sub-menus created from the root menu. The MenuSeparator is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Effect effect,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being removed from an Effect menu.

Parameters
separatorThe MenuSeparator being removed.
effectThe Effect corresponding to the Effect menu.
subMenusA list of sub-menus created from the Effect menu. The MenuSeparator is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Sampler sampler,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being removed from a Sampler menu.

Parameters
separatorThe MenuSeparator being removed.
samplerThe Sampler corresponding to the Sampler menu.
subMenusA list of sub-menus created from the Sampler menu. The MenuSeparator is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingMenuSeparator ( const synthclone::MenuSeparator separator,
const synthclone::Target target,
const QStringList &  subMenus 
)
signal

Emitted when a MenuSeparator is being removed from a Target menu.

Parameters
separatorThe MenuSeparator being removed.
targetThe Target corresponding to the Target menu.
subMenusA list of sub-menus created from the Target menu. The MenuSeparator is at the deepest menu. Any empty sub-menus will be removed.
void synthclone::Context::removingParticipant ( const synthclone::Participant participant,
const synthclone::Participant parent,
const QByteArray &  id 
)
signal

Emitted when a Participant is being removed.

Parameters
participantThe Participant being removed.
parentThe parent Participant of the Participant being removed. If this argument is set to 0, then the Participant being removed is a root Participant.
idThe id of the Participant being removed.
void synthclone::Context::removingSampler ( const synthclone::Sampler sampler)
signal

Emitted when a Sampler is being removed.

Parameters
samplerThe Sampler being removed.
void synthclone::Context::removingSamplerJob ( const synthclone::SamplerJob job,
int  index 
)
signal

Emitted when a SamplerJob is being removed from the SamplerJob queue.

Parameters
jobThe SamplerJob being removed.
indexThe index of the SamplerJob being removed.
void synthclone::Context::removingTarget ( const synthclone::Target target,
int  index 
)
signal

Emitted when a Target is being removed from the Target list.

Parameters
targetThe Target being removed.
indexThe index of the Target being removed.
void synthclone::Context::removingZone ( const synthclone::Zone zone,
int  index 
)
signal

Emitted when an Zone is being removed from the Zone list.

Parameters
zoneThe Zone being removed.
indexThe index of the Zone being removed.
virtual void synthclone::Context::reportError ( const QString &  message)
pure virtualslot

Reports a session error.

The application responds by showing an error dialog.

Parameters
messageAn error message describing the error that occurred.
void synthclone::Context::sampleChannelCountChanged ( synthclone::SampleChannelCount  count)
signal

Emitted when the session's synthclone::SampleChannelCount is changed.

Parameters
countThe synthclone::SampleChannelCount.
void synthclone::Context::samplerAdded ( const synthclone::Sampler sampler)
signal

Emitted when a Sampler has been added.

Parameters
samplerThe added Sampler.
void synthclone::Context::sampleRateChanged ( synthclone::SampleRate  sampleRate)
signal

Emitted when the session's synthclone::SampleRate is changed.

Parameters
sampleRateThe synthclone::SampleRate.
void synthclone::Context::samplerJobAdded ( const synthclone::SamplerJob job,
int  index 
)
signal

Emitted when a SamplerJob has been added to the SamplerJob queue.

Parameters
jobThe added SamplerJob.
indexThe index of the SamplerJob.
void synthclone::Context::samplerJobMoved ( const synthclone::SamplerJob job,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a SamplerJob is moved in the SamplerJob queue.

Parameters
jobThe SamplerJob.
fromIndexThe index the SamplerJob was moved from.
toIndexThe current index of the SamplerJob.
void synthclone::Context::samplerJobRemoved ( const synthclone::SamplerJob job,
int  index 
)
signal

Emitted when a SamplerJob has been removed from the SamplerJob queue.

Parameters
jobThe removed SamplerJob.
indexThe index the SamplerJob was removed from.
void synthclone::Context::samplerRemoved ( const synthclone::Sampler sampler)
signal

Emitted when a Sampler is removed.

Parameters
samplerThe removed Sampler.
void synthclone::Context::sampleTimePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the sample time property is changed.

Parameters
visibleThe visibility of the sample time property.
virtual void synthclone::Context::saveSession ( )
pure virtualslot

Saves the session in the current session directory.

Note that this method does NOT prompt the user.

virtual void synthclone::Context::saveSession ( const QDir &  directory)
pure virtualslot

Saves the session, and changes the current session directory.

Note that this method does NOT prompt the user.

Parameters
directoryThe directory to save the session in.
void synthclone::Context::selectedEffectChanged ( const synthclone::Effect effect,
int  index 
)
signal

Emitted when the selected Effect is changed.

Parameters
effectThe selected Effect.
indexThe index of the selected Effect.
void synthclone::Context::selectedTargetChanged ( const synthclone::Target target,
int  index 
)
signal

Emitted when the selected Target is changed.

Parameters
targetThe selected Target.
indexThe index of the selected Target.
void synthclone::Context::sessionStateChanged ( synthclone::SessionState  state,
const QDir *  directory 
)
signal

Emitted when the synthclone::SessionState changes.

Parameters
stateThe synthclone::SessionState.
directoryThe session directory. If this argument is 0, then a session isn't currently loaded.
virtual void synthclone::Context::setAftertouchPropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the aftertouch property.

Parameters
visibleWhether or not the aftertouch property should be visible.
virtual void synthclone::Context::setChannelPressurePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the channel pressure property.

Parameters
visibleWhether or not the channel pressure property should be visible.
virtual void synthclone::Context::setChannelPropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the channel property.

Parameters
visibleWhether or not the channel property should be visible.
virtual void synthclone::Context::setControlPropertyVisible ( MIDIData  control,
bool  visible 
)
pure virtualslot

Sets the visibility of a control property.

Parameters
controlThe control to change the visibility of.
visibleWhether or not the control property should be visible.
virtual void synthclone::Context::setDrySamplePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the dry sample property.

Parameters
visibleWhether or not the dry sample property should be visible.
virtual void synthclone::Context::setFocusedComponent ( const Component component)
pure virtualslot

Sets the focused component.

Parameters
componentThe component that should gain focus. If this argument is 0, then there will be no focused component.
virtual void synthclone::Context::setNotePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the note property.

Parameters
visibleWhether or not the note property should be visible.
virtual void synthclone::Context::setReleaseTimePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the release time property.

Parameters
visibleWhether or not the release time property should be visible.
virtual void synthclone::Context::setSampleChannelCount ( SampleChannelCount  sampleChannelCount)
pure virtualslot

Sets the SampleChannelCount for the session.

If there are Sample objects already registered with this session, then behavior varies:

  • If the Sample objects are mono samples, then they will be converted to samples with the updated SampleChannelCount.
  • If the incoming SampleChannelCount is 1, then the Sample objects will be converted to mono samples.
  • Otherwise, the Sample objects will be deleted.

All of this is done WITHOUT prompting the user. You have been warned.

Parameters
sampleChannelCountThe new SampleChannelCount.
virtual void synthclone::Context::setSampleRate ( SampleRate  sampleRate)
pure virtualslot

Sets the SampleRate for the session.

If there are Sample objects already registered with this session, then they will be converted to the new SampleRate WITHOUT prompting the user. You have been warned.

Parameters
sampleRateThe new SampleRate.
virtual void synthclone::Context::setSampleTimePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the sample time property.

Parameters
visibleWhether or not the sample time property should be visible.
virtual void synthclone::Context::setSelectedEffect ( const Effect effect)
pure virtualslot

Sets the selected Effect.

Parameters
effectThe Effect to select. If the argument is set to 0, then any currently selected Effect object will be deselected.
virtual void synthclone::Context::setSelectedEffect ( int  index)
pure virtualslot

Sets the selected Effect.

Parameters
indexThe index of the Effect to select. If the argument is set to -1, then any currently selected Effect object will be deselected.
virtual void synthclone::Context::setSelectedTarget ( const Target target)
pure virtualslot

Sets the selected Target.

Parameters
targetThe Target to select. If the argument is set to 0, then any currently selected Target object will be deselected.
virtual void synthclone::Context::setSelectedTarget ( int  index)
pure virtualslot

Sets the selected Target.

Parameters
indexThe index of the Target to select. If the argument is set to -1, then any currently selected Target object will be deselected.
virtual void synthclone::Context::setSessionModified ( )
pure virtualslot

Changes the session state to SESSIONSTATE_MODIFIED if the session state is SESSIONSTATE_CURRENT.

See Also
synthclone::SessionState
virtual void synthclone::Context::setStatusPropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the status property.

Parameters
visibleWhether or not the status property should be visible.
virtual void synthclone::Context::setVelocityPropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the velocity property.

Parameters
visibleWhether or not the velocity property should be visible.
virtual void synthclone::Context::setWetSamplePropertyVisible ( bool  visible)
pure virtualslot

Sets the visibility of the wet sample property.

Parameters
visibleWhether or not the wet sample property should be visible.
virtual void synthclone::Context::setZoneSelected ( const Zone zone,
bool  selected 
)
pure virtualslot

(De)selects a Zone.

Parameters
zoneThe Zone to (de)select.
selectedWhether or not the Zone should be selected.
virtual void synthclone::Context::setZoneSelected ( int  index,
bool  selected 
)
pure virtualslot

(De)selects a Zone.

Parameters
indexThe index of the Zone to (de)select.
selectedWhether or not the Zone should be selected.
virtual void synthclone::Context::sortZones ( const ZoneComparer comparer,
bool  ascending = true 
)
pure virtualslot

Sorts the Zone list.

Parameters
comparerThe ZoneComparer used to sort the Zone list.
ascendingWhether or not to sort the Zone objects in ascending order.
void synthclone::Context::statusPropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the status property is changed.

Parameters
visibleThe visibility of the status property.
void synthclone::Context::targetAdded ( const synthclone::Target target,
int  index 
)
signal

Emitted when a Target has been added to the Target list.

Parameters
targetThe added Target.
indexThe index of the Target.
void synthclone::Context::targetBuildError ( const synthclone::Target target,
const QString &  message 
)
signal

Emitted when an error occurs while attempting to build a Target.

Parameters
targetThe Target that was being built.
messageThe error message.
void synthclone::Context::targetBuilt ( const synthclone::Target target)
signal

Emitted when a Target is successfully built.

Parameters
targetThe Target that was successfully built.
void synthclone::Context::targetMoved ( const synthclone::Target target,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a Target has been moved in the Target list.

Parameters
targetThe moved Target.
fromIndexThe index the Target was moved from.
toIndexThe current index of the Target.
void synthclone::Context::targetRemoved ( const synthclone::Target target,
int  index 
)
signal

Emitted when a Target has been removed from the Target list.

Parameters
targetThe removed Target.
indexThe index the Target was removed from.
void synthclone::Context::targetsBuilt ( )
signal

Emitted when a Target build operation is completed.

virtual void synthclone::Context::unloadSession ( )
pure virtualslot

Unloads the current session.

The user will NOT be prompted.

Note
The Participant unloading the session will be deactivated before this method returns, and this Context object will be deleted at some point after the Participant returns control to the application. Use this method responsibly.
void synthclone::Context::velocityPropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the velocity property is changed.

Parameters
visibleThe visibility of the velocity property.
void synthclone::Context::wetSamplePropertyVisibilityChanged ( bool  visible)
signal

Emitted when the visibility of the wet sample property is changed.

Parameters
visibleThe visibility of the wet sample property.
void synthclone::Context::zoneAdded ( const synthclone::Zone zone,
int  index 
)
signal

Emitted when a Zone has been added to the Zone list.

Parameters
zoneThe added Zone.
indexThe index of the Zone.
void synthclone::Context::zoneMoved ( const synthclone::Zone zone,
int  fromIndex,
int  toIndex 
)
signal

Emitted when a Zone has been moved in the Zone list.

Parameters
zoneThe moved Zone.
fromIndexThe index the Zone was moved from.
toIndexThe current index of the Zone.
void synthclone::Context::zoneRemoved ( const synthclone::Zone zone,
int  index 
)
signal

Emitted when a Zone has been removed from the Zone list.

Parameters
zoneThe removed Zone.
indexThe index the Zone was removed from.
void synthclone::Context::zoneSelectionChanged ( const synthclone::Zone zone,
bool  selected 
)
signal

Emitted when the selection of a Zone changes.

Parameters
zoneThe Zone being (de)selected.
selectedWhether or not the Zone is now selected.

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