|
| | RackInstance (PluginCreationInfo) |
| |
| | ~RackInstance () override |
| |
| juce::String | getName () const override |
| | The name of the type, e.g.
|
| |
| juce::String | getPluginType () override |
| | Returns a string identifying the plugin type (used as the XML tag name).
|
| |
| juce::String | getTooltip () override |
| | Returns a tooltip string for UI display.
|
| |
| void | initialise (const PluginInitialisationInfo &) override |
| | Gives the plugin a chance to set itself up before being played.
|
| |
| void | deinitialise () override |
| | Called after play stops to release resources.
|
| |
| bool | takesAudioInput () override |
| | Returns true if this plugin should be fed audio from upstream in the chain.
|
| |
| bool | takesMidiInput () override |
| |
| bool | producesAudioWhenNoAudioInput () override |
| | Returns true if the plugin can produce audio when its input is silent (e.g.
|
| |
| bool | isSynth () override |
| |
| bool | canBeAddedToRack () override |
| |
| int | getNumOutputChannelsGivenInputs (int numInputs) override |
| | Returns the number of output channels this plugin will produce for track routing.
|
| |
| BusLayout | getBusses () const override |
| | Returns the full input/output bus layout of this plugin.
|
| |
| double | getLatencySeconds () override |
| | Returns the plugin's processing latency in seconds.
|
| |
| bool | needsConstantBufferSize () override |
| | Returns true if this plugin requires a constant audio buffer size (no variable-size blocks).
|
| |
| void | prepareForNextBlock (TimePosition) override |
| | Called between successive rendering blocks.
|
| |
| void | applyToBuffer (const PluginRenderContext &) override |
| | Process the next block of data.
|
| |
| void | updateAutomatableParamPosition (TimePosition) override |
| | Updates all the auto params to their positions at this time.
|
| |
| juce::String | getSelectableDescription () override |
| | Subclasses must return a description of what they are.
|
| |
| void | replaceRackWithPluginSequence (SelectionManager *) |
| |
| juce::StringArray | getInputChoices (bool includeNumberPrefix) |
| | Returns the available rack input pin names (for UI dropdowns).
|
| |
| juce::StringArray | getOutputChoices (bool includeNumberPrefix) |
| | Returns the available rack output pin names (for UI dropdowns).
|
| |
| juce::String | getNoPinName () |
| |
| int | getNumInputChannels () const |
| |
| int | getNumOutputChannels () const |
| |
| void | setNumInputChannels (int) |
| |
| void | setNumOutputChannels (int) |
| |
| int | getNumChannelMappings () const |
| | Number of channel mappings (dynamically sized).
|
| |
| int | getInputMapping (int channelIndex) const |
| | Returns the 1-based rack input pin index for the given channel (-1 = none).
|
| |
| int | getOutputMapping (int channelIndex) const |
| | Returns the 1-based rack output pin index for the given channel (-1 = none).
|
| |
| void | setInputMapping (int channelIndex, int rackPinIndex) |
| | Sets the input mapping for a channel.
|
| |
| void | setOutputMapping (int channelIndex, int rackPinIndex) |
| | Sets the output mapping for a channel.
|
| |
| void | setInputMappingByName (int channelIndex, const juce::String &inputName) |
| | Sets the input mapping by name (from getInputChoices).
|
| |
| void | setOutputMappingByName (int channelIndex, const juce::String &outputName) |
| | Sets the output mapping by name (from getOutputChoices).
|
| |
| AutomatableParameter::Ptr | getInputGainParam (int channelIndex) const |
| | Returns the input/output gain parameter for a channel.
|
| |
| AutomatableParameter::Ptr | getOutputGainParam (int channelIndex) const |
| |
| juce::String | getInputMappingName (int channelIndex) |
| | Returns the display name for an input/output mapping.
|
| |
| juce::String | getOutputMappingName (int channelIndex) |
| |
| void | setInputLevel (int channelIndex, float value) |
| |
| void | setOutputLevel (int channelIndex, float value) |
| |
| void | addChannelMapping () |
| | Adds a new channel mapping (appended at end).
|
| |
| void | removeLastChannelMapping () |
| | Removes the last channel mapping.
|
| |
| | Plugin (PluginCreationInfo) |
| |
| | ~Plugin () override |
| |
| void | selectableAboutToBeDeleted () override |
| | Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
|
| |
| void | playStartedOrStopped () |
| | called by the system to let the plugin manage its automation stuff
|
| |
| virtual void | initialiseFully () |
| | Gives the plugin a chance to do extra initialisation when it's been added to an edit.
|
| |
| virtual void | flushPluginStateToValueTree () override |
| |
| virtual juce::String | getVendor () |
| | Returns the plugin vendor/manufacturer name.
|
| |
| virtual juce::String | getShortName (int) |
| | Returns an abbreviated name, ideally fitting within suggestedLength characters.
|
| |
| juce::String | getDisplayName () const |
| | Returns the custom name if set, otherwise the built-in getName().
|
| |
| juce::String | getCustomName () const |
| | Returns the raw custom name (may be empty).
|
| |
| void | setCustomName (const juce::String &) |
| | Sets a custom display name.
|
| |
| virtual juce::String | getIdentifierString () |
| | A unique string to identify a plugin independent of install location.
|
| |
| virtual void | setEnabled (bool) |
| | Enable/disable the plugin.
|
| |
| bool | isEnabled () const noexcept |
| |
| void | setFrozen (bool shouldBeFrozen) |
| | Freezing is stronger than disabling – a frozen plugin cannot be interacted with at all.
|
| |
| bool | isFrozen () const noexcept |
| |
| void | setProcessingEnabled (bool p) |
| | Enable/disable processing.
|
| |
| bool | isProcessingEnabled () const noexcept |
| |
| virtual void | initialiseWithoutStopping (const PluginInitialisationInfo &) |
| | Tells the plugin that the audio graph has changed but the plugin isn't being re-initialised - i.e.
|
| |
| virtual void | reset () |
| | Should reset synth voices, tails, clear delay buffers, etc.
|
| |
| virtual void | trackPropertiesChanged () |
| | Track name or colour has changed.
|
| |
| virtual void | midiPanic () |
| | Tells the plugin to turn off any playing notes, if applicable.
|
| |
| void | applyToBufferWithAutomation (const PluginRenderContext &) |
| |
| virtual bool | shouldMeasureCpuUsage () const noexcept |
| | Plugins can return false if they want to avoid the overhead of measuring the CPU usage.
|
| |
| double | getCpuUsage () const noexcept |
| | Returns the proportion of the current buffer size spent processing this plugin.
|
| |
| virtual bool | noTail () |
| | Returns true if the plugin has no tail (i.e.
|
| |
| virtual void | getChannelNames (juce::StringArray *ins, juce::StringArray *outs) |
| | Fills the provided StringArrays with the names of this plugin's input and/or output channels.
|
| |
| virtual double | getTailLength () const |
| | Returns the length of the plugin's tail in seconds (e.g.
|
| |
| virtual bool | canSidechain () |
| | Returns true if this plugin supports sidechain input.
|
| |
| AutomatableParameter * | addParam (const juce::String ¶mID, const juce::String &name, juce::NormalisableRange< float > valueRange) |
| | Registers a new automatable parameter owned by this plugin.
|
| |
| AutomatableParameter * | addParam (const juce::String ¶mID, const juce::String &name, juce::NormalisableRange< float > valueRange, std::function< juce::String(float)> valueToStringFunction, std::function< float(const juce::String &)> stringToValueFunction) |
| | Registers a new automatable parameter with custom string conversion functions.
|
| |
| juce::StringArray | getInputChannelNames () |
| | Returns the names of this plugin's input channels (convenience wrapper around getChannelNames).
|
| |
| juce::StringArray | getSidechainSourceNames (bool allowNone) |
| | Returns the names of available sidechain sources for this plugin.
|
| |
| void | setSidechainSourceByName (const juce::String &name) |
| | Sets the sidechain source by its display name.
|
| |
| juce::String | getSidechainSourceName () |
| | Returns the display name of the current sidechain source.
|
| |
| void | guessSidechainRouting () |
| | Attempts to automatically determine a sensible sidechain routing.
|
| |
| int | getNumWires () const |
| |
| Wire * | getWire (int index) const |
| |
| void | makeConnection (int srcChannel, int dstChannel, juce::UndoManager *) |
| |
| void | breakConnection (int srcChannel, int dstChannel) |
| |
| virtual bool | hasNameForMidiNoteNumber (int note, int midiChannel, juce::String &name) |
| | If it's a synth that names its notes, this can return the name it uses for this note 0-127.
|
| |
| virtual bool | hasNameForMidiProgram (int programNum, int bank, juce::String &name) |
| | Returns the name for a midi program, if there is one.
|
| |
| virtual bool | hasNameForMidiBank (int bank, juce::String &name) |
| |
| virtual bool | canBeAddedToClip () |
| |
| virtual bool | canBeAddedToFolderTrack () |
| |
| virtual bool | canBeAddedToMaster () |
| |
| virtual bool | canBeDisabled () |
| |
| virtual bool | canBeMoved () |
| |
| virtual bool | isMissing () |
| | Returns true if the plugin's backing file/DLL is missing (e.g.
|
| |
| virtual bool | isDisabled () |
| | Returns true if the plugin has been forcibly disabled (e.g.
|
| |
| bool | isInRack () const |
| | Returns true if this plugin lives inside a RackType.
|
| |
| juce::ReferenceCountedObjectPtr< RackType > | getOwnerRackType () const |
| |
| bool | isClipEffectPlugin () const |
| | Returns true if this plugin is being used as a clip effect.
|
| |
| virtual juce::AudioProcessor * | getWrappedAudioProcessor () const |
| | Returns the underlying juce::AudioProcessor, if this plugin wraps one.
|
| |
| AutomatableParameter::Ptr | getQuickControlParameter () const |
| |
| void | setQuickControlParameter (AutomatableParameter *) |
| |
| virtual void | deleteFromParent () |
| | Attempts to delete this plugin, whether it's a master plugin, track plugin, etc.
|
| |
| void | removeFromParent () |
| | Detaches the plugin from any parent it might be in.
|
| |
| Track * | getOwnerTrack () const |
| | Returns the track if it's a track or clip plugin.
|
| |
| Clip * | getOwnerClip () const |
| | Returns the clip if that's what it's in.
|
| |
| PluginList * | getOwnerList () const |
| | Returns the PluginList that contains this plugin.
|
| |
| Ptr | findPluginThatFeedsIntoThis () const |
| | Returns the previous plugin in the same PluginList, or nullptr.
|
| |
| Ptr | findPluginThatThisFeedsInto () const |
| | Returns the next plugin in the same PluginList, or nullptr.
|
| |
| void | changed () override |
| | Marks the plugin as changed and notifies the Edit.
|
| |
| juce::Array< ReferencedItem > | getReferencedItems () override |
| |
| void | reassignReferencedItem (const ReferencedItem &, ProjectItemRef newRef, double newStartTime) override |
| |
| virtual void | sourceMediaChanged () |
| | Called when ProjectItem sources are re-assigned so you can reload from the new source.
|
| |
| bool | setPluginToMirror (const Plugin::Ptr &) |
| | Sets a master plugin whose settings this one will mirror.
|
| |
| virtual void | updateFromMirroredPluginIfNeeded (Plugin &) |
| | Called to pull state from the mirrored master.
|
| |
| Plugin::Ptr | getMirroredPlugin () const |
| | Returns the plugin this one is mirroring, or nullptr.
|
| |
| bool | baseClassNeedsInitialising () const noexcept |
| | Returns true if baseClassInitialise() has not yet been called (or has been fully deinitialised).
|
| |
| void | baseClassInitialise (const PluginInitialisationInfo &) |
| | Prepares the plugin for playback.
|
| |
| void | baseClassDeinitialise () |
| | Tears down the plugin after playback.
|
| |
| void | setSidechainSourceID (EditItemID newID) |
| |
| EditItemID | getSidechainSourceID () const |
| |
| virtual std::unique_ptr< EditorComponent > | createEditor () |
| | Creates a custom editor component for this plugin, or nullptr if none.
|
| |
| void | showWindowExplicitly () |
| | Shows the plugin's editor window, creating it if necessary.
|
| |
| void | hideWindowForShutdown () |
| | Hides the plugin window during shutdown (avoids dangling references).
|
| |
| juce::UndoManager * | getUndoManager () const noexcept |
| |
| bool | isInitialising () const |
| |
| | Selectable () |
| |
| virtual | ~Selectable () |
| |
| virtual void | selectionStatusChanged (bool isNowSelected) |
| | Can be overridden to tell this object that it has just been selected or deselected.
|
| |
| void | addListener (SelectableListener *) |
| |
| void | removeListener (SelectableListener *) |
| |
| void | addSelectableListener (SelectableListener *) |
| |
| void | removeSelectableListener (SelectableListener *) |
| |
| void | cancelAnyPendingUpdates () |
| | If changed() has been called, this will cancel any pending async change notificaions.
|
| |
| void | deselect () |
| |
| void | propertiesChanged () |
| |
| void | notifyListenersOfDeletion () |
| |
| WeakRef | getWeakRef () |
| |
| virtual | ~Exportable ()=default |
| |
| | AutomatableEditItem (Edit &, const juce::ValueTree &) |
| |
| | ~AutomatableEditItem () override |
| |
| virtual void | restorePluginStateFromValueTree (const juce::ValueTree &) |
| |
| juce::Array< AutomatableParameter * > | getAutomatableParameters () const |
| |
| int | getNumAutomatableParameters () const |
| |
| AutomatableParameter::Ptr | getAutomatableParameter (int index) const |
| |
| AutomatableParameter::Ptr | getAutomatableParameterByID (const juce::String ¶mID) const |
| |
| void | visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) const |
| |
| void | deleteParameter (AutomatableParameter *) |
| |
| void | deleteAutomatableParameters () |
| |
| int | indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const |
| |
| AutomatableParameterTree & | getParameterTree () const |
| |
| juce::ReferenceCountedArray< AutomatableParameter > | getFlattenedParameterTree () const |
| |
| void | addParameterListChangeListener (ParameterListChangeListener *) |
| |
| void | removeParameterListChangeListener (ParameterListChangeListener *) |
| |
| bool | isAutomationNeeded () const noexcept |
| |
| void | setAutomatableParamPosition (TimePosition) |
| |
| bool | isBeingActivelyPlayed () const |
| |
| void | updateParameterStreams (TimePosition) |
| | Updates all the parameter streams to their positions at this time.
|
| |
| void | resetRecordingStatus () |
| | Marks the end of an automation recording stream.
|
| |
| void | updateStreamIterators () |
| |
| void | addActiveParameter (const AutomatableParameter &) |
| |
| void | removeActiveParameter (const AutomatableParameter &) |
| |
| bool | isActiveParameter (AutomatableParameter &) |
| |
| | EditItem (EditItemID, Edit &) |
| |
| | EditItem (Edit &, const juce::ValueTree &) |
| |
| virtual | ~EditItem ()=default |
| |
| | MacroParameterElement (Edit &, const juce::ValueTree &) |
| | Constructor.
|
| |
| virtual | ~MacroParameterElement ()=default |
| | Destructor.
|
| |
| MacroParameterList * | getMacroParameterList () |
| | If no parameters have been created, this may return nullptr.
|
| |
| MacroParameterList & | getMacroParameterListForWriting () |
| | This ensures that the list has been created.
|
| |
| juce::ReferenceCountedArray< MacroParameter > | getMacroParameters () const |
| |
Public Types inherited from engine::Plugin