Public Member Functions | Static Public Member Functions | List of all members
FrontendHandler Class Reference

This class handles the file resources for compiled plugins. More...

Inheritance diagram for FrontendHandler:
FileHandlerBase ControlledObject

Public Member Functions

File getRootFolder () const override
 returns the app data folder. More...
 
- Public Member Functions inherited from FileHandlerBase
void createLinkFile (SubDirectories dir, const File &relocation)
 Creates a platform dependant file in the subdirectory that redirects to another location. More...
 
String getFilePath (const String &pathToFile, SubDirectories subDir) const
 creates a absolute path from the pathToFile and the specified sub directory. More...
 
const String getFileReference (const String &absoluteFileName, SubDirectories dir) const
 Creates a reference string that can be used to obtain the file in the project directory. More...
 
- Public Member Functions inherited from ControlledObject
 ControlledObject (MainController *m)
 Creates a new ControlledObject. More...
 
const MainControllergetMainController () const noexcept
 Provides read-only access to the main controller. More...
 
MainControllergetMainController () noexcept
 Provides write access to the main controller. More...
 

Static Public Member Functions

static File getAdditionalAudioFilesDirectory ()
 There is a folder in the app data directory of your plugin that can be used to store audio files loaded into your plugin with a relative path to be compatible across systems. More...
 
static File getAppDataDirectory ()
 This returns the app data directory, which must be created by the installer of your product. More...
 
static File getResourcesFolder ()
 on IOS this returns the folder where all the resources (samples, images, etc) are found. More...
 
static File getSampleLocationForCompiledPlugin ()
 Returns the directory where the samples are located. More...
 
static File getUserPresetDirectory ()
 Returns the location for the user presets. More...
 
static void setSampleLocation (const File &newLocation)
 Changes the sample location. More...
 
- Static Public Member Functions inherited from FileHandlerBase
static bool isAbsolutePathCrossPlatform (const String &pathName)
 checks if this is a absolute path (including absolute win paths on OSX and absolute OSX paths on windows);
 

Additional Inherited Members

- Public Types inherited from FileHandlerBase
enum  SubDirectories {
  AudioFiles, Images, SampleMaps, UserPresets,
  Samples, Scripts , Presets, XMLPresetBackups,
  AdditionalSourceCode
}
 The sub folders of each project folder. More...
 

Detailed Description

This class handles the file resources for compiled plugins.

Member Function Documentation

File getAdditionalAudioFilesDirectory ( )
static

There is a folder in the app data directory of your plugin that can be used to store audio files loaded into your plugin with a relative path to be compatible across systems.

juce::File getAppDataDirectory ( )
static

This returns the app data directory, which must be created by the installer of your product.

On OSX this will be ("Users/Library/Application Support/Company/Product/") and on Windows ("Users/AppData/Local/Company/Product").

This directory will be used for:

  • sample location folder (using a LinkOS file)
  • user presets (in the UserPresets subfolder)
  • license key file
File getResourcesFolder ( )
static

on IOS this returns the folder where all the resources (samples, images, etc) are found.

It uses a shared folder for both the AUv3 and Standalone version in order to avoid duplicating the data.

juce::File getRootFolder ( ) const
overridevirtual

returns the app data folder.

Implements FileHandlerBase.

File getSampleLocationForCompiledPlugin ( )
static

Returns the directory where the samples are located.

File getUserPresetDirectory ( )
static

Returns the location for the user presets.

void setSampleLocation ( const File &  newLocation)
static

Changes the sample location.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.