JUCE
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
StandalonePluginHolder Class Reference

An object that creates and plays a standalone instance of an AudioProcessor. More...

+ Inheritance diagram for StandalonePluginHolder:

Public Member Functions

 StandalonePluginHolder (PropertySet *settingsToUse, bool takeOwnershipOfSettings=true, const String &preferredDefaultDeviceName=String(), const AudioDeviceManager::AudioDeviceSetup *preferredSetupOptions=nullptr)
 Creates an instance of the default plugin. More...
 
virtual ~StandalonePluginHolder ()
 
virtual void createPlugin ()
 
virtual void deletePlugin ()
 
File getLastFile () const
 
void setLastFile (const FileChooser &fc)
 
void askUserToSaveState (const String &fileSuffix=String())
 Pops up a dialog letting the user save the processor's state to a file. More...
 
void askUserToLoadState (const String &fileSuffix=String())
 Pops up a dialog letting the user re-load the processor's state from a file. More...
 
void startPlaying ()
 
void stopPlaying ()
 
void showAudioSettingsDialog ()
 Shows an audio properties dialog box modally. More...
 
void saveAudioDeviceState ()
 
void reloadAudioDeviceState (const String &preferredDefaultDeviceName, const AudioDeviceManager::AudioDeviceSetup *preferredSetupOptions)
 
void savePluginState ()
 
void reloadPluginState ()
 

Static Public Member Functions

static String getFilePatterns (const String &fileSuffix)
 

Public Attributes

OptionalScopedPointer< PropertySetsettings
 
ScopedPointer< AudioProcessorprocessor
 
AudioDeviceManager deviceManager
 
AudioProcessorPlayer player
 
StringArray lastMidiDevices
 

Detailed Description

An object that creates and plays a standalone instance of an AudioProcessor.

The object will create your processor using the same createPluginFilter() function that the other plugin wrappers use, and will run it through the computer's audio/MIDI devices using AudioDeviceManager and AudioProcessorPlayer.

Constructor & Destructor Documentation

§ StandalonePluginHolder()

StandalonePluginHolder::StandalonePluginHolder ( PropertySet settingsToUse,
bool  takeOwnershipOfSettings = true,
const String preferredDefaultDeviceName = String(),
const AudioDeviceManager::AudioDeviceSetup preferredSetupOptions = nullptr 
)

Creates an instance of the default plugin.

The settings object can be a PropertySet that the class should use to store its settings - the takeOwnershipOfSettings indicates whether this object will delete the settings automatically when no longer needed. The settings can also be nullptr.

A default device name can be passed in.

Preferably a complete setup options object can be used, which takes precedence over the preferredDefaultDeviceName and allows you to select the input & output device names, sample rate, buffer size etc.

In all instances, the settingsToUse will take precedence over the "preferred" options if not null.

References createPlugin(), reloadPluginState(), startPlaying(), and Timer::startTimer().

Referenced by StandaloneFilterWindow::StandaloneFilterWindow().

§ ~StandalonePluginHolder()

virtual StandalonePluginHolder::~StandalonePluginHolder ( )
virtual

Member Function Documentation

§ createPlugin()

virtual void StandalonePluginHolder::createPlugin ( )
virtual

§ deletePlugin()

virtual void StandalonePluginHolder::deletePlugin ( )
virtual

References processor, and stopPlaying().

Referenced by ~StandalonePluginHolder().

§ getFilePatterns()

static String StandalonePluginHolder::getFilePatterns ( const String fileSuffix)
static

§ getLastFile()

File StandalonePluginHolder::getLastFile ( ) const

§ setLastFile()

void StandalonePluginHolder::setLastFile ( const FileChooser fc)

§ askUserToSaveState()

void StandalonePluginHolder::askUserToSaveState ( const String fileSuffix = String())

§ askUserToLoadState()

void StandalonePluginHolder::askUserToLoadState ( const String fileSuffix = String())

§ startPlaying()

void StandalonePluginHolder::startPlaying ( )

§ stopPlaying()

void StandalonePluginHolder::stopPlaying ( )

§ showAudioSettingsDialog()

void StandalonePluginHolder::showAudioSettingsDialog ( )

§ saveAudioDeviceState()

void StandalonePluginHolder::saveAudioDeviceState ( )

§ reloadAudioDeviceState()

void StandalonePluginHolder::reloadAudioDeviceState ( const String preferredDefaultDeviceName,
const AudioDeviceManager::AudioDeviceSetup preferredSetupOptions 
)

§ savePluginState()

void StandalonePluginHolder::savePluginState ( )

§ reloadPluginState()

void StandalonePluginHolder::reloadPluginState ( )

Member Data Documentation

§ settings

OptionalScopedPointer<PropertySet> StandalonePluginHolder::settings

§ processor

ScopedPointer<AudioProcessor> StandalonePluginHolder::processor

§ deviceManager

AudioDeviceManager StandalonePluginHolder::deviceManager

§ player

AudioProcessorPlayer StandalonePluginHolder::player

Referenced by startPlaying(), and stopPlaying().

§ lastMidiDevices

StringArray StandalonePluginHolder::lastMidiDevices

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