openshot-audio  0.1.2
Public Member Functions | Protected Member Functions | List of all members
juce::AudioPluginInstance Class Referenceabstract

#include <juce_audio_processors.h>

Inheritance diagram for juce::AudioPluginInstance:
juce::AudioProcessor juce::AudioProcessorGraph::AudioGraphIOProcessor

Public Member Functions

virtual ~AudioPluginInstance ()
 
virtual void fillInPluginDescription (PluginDescription &description) const =0
 
PluginDescription getPluginDescription () const
 
virtual void * getPlatformSpecificData ()
 
virtual void refreshParameterList ()
 
- Public Member Functions inherited from juce::AudioProcessor
virtual ~AudioProcessor ()
 
virtual const String getName () const =0
 
virtual void prepareToPlay (double sampleRate, int estimatedSamplesPerBlock)=0
 
virtual void releaseResources ()=0
 
virtual void processBlock (AudioSampleBuffer &buffer, MidiBuffer &midiMessages)=0
 
virtual void processBlockBypassed (AudioSampleBuffer &buffer, MidiBuffer &midiMessages)
 
AudioPlayHeadgetPlayHead () const noexcept
 
double getSampleRate () const noexcept
 
int getBlockSize () const noexcept
 
int getNumInputChannels () const noexcept
 
int getNumOutputChannels () const noexcept
 
const StringgetInputSpeakerArrangement () const noexcept
 
const StringgetOutputSpeakerArrangement () const noexcept
 
virtual const String getInputChannelName (int channelIndex) const =0
 
virtual const String getOutputChannelName (int channelIndex) const =0
 
virtual bool isInputChannelStereoPair (int index) const =0
 
virtual bool isOutputChannelStereoPair (int index) const =0
 
int getLatencySamples () const noexcept
 
void setLatencySamples (int newLatency)
 
virtual bool silenceInProducesSilenceOut () const =0
 
virtual double getTailLengthSeconds () const =0
 
virtual bool acceptsMidi () const =0
 
virtual bool producesMidi () const =0
 
const CriticalSectiongetCallbackLock () const noexcept
 
void suspendProcessing (bool shouldBeSuspended)
 
bool isSuspended () const noexcept
 
virtual void reset ()
 
bool isNonRealtime () const noexcept
 
virtual void setNonRealtime (bool isNonRealtime) noexcept
 
virtual AudioProcessorEditorcreateEditor ()=0
 
virtual bool hasEditor () const =0
 
AudioProcessorEditorgetActiveEditor () const noexcept
 
AudioProcessorEditorcreateEditorIfNeeded ()
 
virtual int getNumParameters ()
 
virtual const String getParameterName (int parameterIndex)
 
virtual float getParameter (int parameterIndex)
 
virtual String getParameterName (int parameterIndex, int maximumStringLength)
 
virtual const String getParameterText (int parameterIndex)
 
virtual String getParameterText (int parameterIndex, int maximumStringLength)
 
virtual int getParameterNumSteps (int parameterIndex)
 
virtual float getParameterDefaultValue (int parameterIndex)
 
virtual String getParameterLabel (int index) const
 
virtual bool isParameterOrientationInverted (int index) const
 
virtual void setParameter (int parameterIndex, float newValue)
 
void setParameterNotifyingHost (int parameterIndex, float newValue)
 
virtual bool isParameterAutomatable (int parameterIndex) const
 
virtual bool isMetaParameter (int parameterIndex) const
 
void beginParameterChangeGesture (int parameterIndex)
 
void endParameterChangeGesture (int parameterIndex)
 
void updateHostDisplay ()
 
void addParameter (AudioProcessorParameter *)
 
const OwnedArray< AudioProcessorParameter > & getParameters () const noexcept
 
virtual int getNumPrograms ()=0
 
virtual int getCurrentProgram ()=0
 
virtual void setCurrentProgram (int index)=0
 
virtual const String getProgramName (int index)=0
 
virtual void changeProgramName (int index, const String &newName)=0
 
virtual void getStateInformation (juce::MemoryBlock &destData)=0
 
virtual void getCurrentProgramStateInformation (juce::MemoryBlock &destData)
 
virtual void setStateInformation (const void *data, int sizeInBytes)=0
 
virtual void setCurrentProgramStateInformation (const void *data, int sizeInBytes)
 
virtual void numChannelsChanged ()
 
virtual void addListener (AudioProcessorListener *newListener)
 
virtual void removeListener (AudioProcessorListener *listenerToRemove)
 
virtual void setPlayHead (AudioPlayHead *newPlayHead)
 
void setPlayConfigDetails (int numIns, int numOuts, double sampleRate, int blockSize) noexcept
 
void editorBeingDeleted (AudioProcessorEditor *) noexcept
 
void setSpeakerArrangement (const String &inputs, const String &outputs)
 

Protected Member Functions

 AudioPluginInstance ()
 
- Protected Member Functions inherited from juce::AudioProcessor
 AudioProcessor ()
 
void sendParamChangeMessageToListeners (int parameterIndex, float newValue)
 

Additional Inherited Members

- Public Types inherited from juce::AudioProcessor
enum  WrapperType {
  wrapperType_Undefined = 0, wrapperType_VST, wrapperType_VST3, wrapperType_AudioUnit,
  wrapperType_RTAS, wrapperType_AAX, wrapperType_Standalone
}
 
- Static Public Member Functions inherited from juce::AudioProcessor
static int getDefaultNumParameterSteps () noexcept
 
static void copyXmlToBinary (const XmlElement &xml, juce::MemoryBlock &destData)
 
static XmlElementgetXmlFromBinary (const void *data, int sizeInBytes)
 
static void JUCE_CALLTYPE setTypeOfNextNewPlugin (WrapperType)
 
- Public Attributes inherited from juce::AudioProcessor
WrapperType wrapperType
 
- Protected Attributes inherited from juce::AudioProcessor
AudioPlayHeadplayHead
 

Detailed Description

Base class for an active instance of a plugin.

This derives from the AudioProcessor class, and adds some extra functionality that helps when wrapping dynamically loaded plugins.

This class is not needed when writing plugins, and you should never need to derive your own sub-classes from it. The plugin hosting classes use it internally and will return AudioPluginInstance objects which wrap external plugins.

See also
AudioProcessor, AudioPluginFormat

Constructor & Destructor Documentation

◆ ~AudioPluginInstance()

virtual juce::AudioPluginInstance::~AudioPluginInstance ( )
inlinevirtual

Destructor.

Make sure that you delete any UI components that belong to this plugin before deleting the plugin.

◆ AudioPluginInstance()

juce::AudioPluginInstance::AudioPluginInstance ( )
inlineprotected

Member Function Documentation

◆ fillInPluginDescription()

virtual void juce::AudioPluginInstance::fillInPluginDescription ( PluginDescription description) const
pure virtual

Fills-in the appropriate parts of this plugin description object.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor.

◆ getPlatformSpecificData()

virtual void* juce::AudioPluginInstance::getPlatformSpecificData ( )
inlinevirtual

Returns a pointer to some kind of platform-specific data about the plugin. E.g. For a VST, this value can be cast to an AEffect*. For an AudioUnit, it can be cast to an AudioUnit handle.

◆ getPluginDescription()

PluginDescription juce::AudioPluginInstance::getPluginDescription ( ) const
inline

Returns a PluginDescription for this plugin. This is just a convenience method to avoid calling fillInPluginDescription.

◆ refreshParameterList()

virtual void juce::AudioPluginInstance::refreshParameterList ( )
inlinevirtual

For some formats (currently AudioUnit), this forces a reload of the list of available parameters.


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