Docs

Expansion

The Expansion Pack system in HISE allows you to add more content to your plugin. This API class will

Class methods

getAudioFileList

Returns a list of all available audio files in the expansion.

Expansion.getAudioFileList()


This returns a list of all audio files that are included in the given Expansion. Also it will load all audio files into the pool so they are available in the list.

getImageList

Returns a list of all available images in the expansion.

Expansion.getImageList()



getProperties

Returns an object containing all properties of the expansion.

Expansion.getProperties()


This returns a JSON object with the properties of the Expansion pack. Be aware that this might be subject to change, but the current properties are:

Protip: You might not want to display the blowfish key somewhere on your interface...


getRootFolder

Returns the root folder for this expansion.

Expansion.getRootFolder()



getSampleMapList

Returns a list of all available sample maps in the expansion.

Expansion.getSampleMapList()



loadDataFile

Attempts to parse a JSON file in the AdditionalSourceCode directory of the expansion.

Expansion.loadDataFile(var relativePath)


The AdditionalSourceCode directory in the project folder of a HISE project is reserved for C++ files which will be compiled on plugin export.
In an expansion pack, this directory can be used for any arbtitrary kind of text content, however the most useful recommended format to use for this is JSON.

This method (and it's friend Expansion.writeDataFile() can be used to fetch (and write) data to this directory.

writeDataFile

Writes the given data into the file in the AdditionalSourceCode directory of the expansion.

Expansion.writeDataFile(var relativePath, var dataToWrite)