hise::raw Namespace Reference

a higher-level API for HISE. More...

Namespaces
	IDs
	This namespace duplicates some HISE enumerations.

Classes
class	Builder
	The builder is a low overhead helper class that provides functions to add modules. More...
struct	Data
	The base class for all data connections used in the raw namespace. More...
class	GenericStorage
	The base class for storing data as user preset. More...
class	PluginParameter
	A connection to processor attributes as plugin parameter. More...
class	Pool
	A object that handles the embedded resources (audio files, images and samplemaps). More...
class	Positioner
	A helper class for transferring the position data of a scripted interface to C++. More...
class	Reference
	A lightweight wrapper around a Processor in the HISE signal path. More...
class	Storage
	An object that automatically handles the loading / saving in a ValueTree. More...
class	TaskAfterSuspension
	A wrapper around a task that is supposed to take a while and is not allowed to be executed simultaneously to the audio rendering. More...
class	UIConnection
	This class offers a bidirectional connection between Data and its UI representation. More...

Typedefs
using	AttributeCollection = std::vector< AttributeItem >
	a collection of attribute key/value pairs. More...

Detailed Description

a higher-level API for HISE.

This namespace acts as entry point to the HISE code base and provides helper classes and convenient functions to tuck away the complexity of the full code base. The goal of this namespace is to provide access to the HISE code base for the majority of use cases that are required by people using HISE for their projects. The full API class list of all HISE classes can be overwhelming, so this is supposed to be a starting point for people diving into the C++ side of HISE.

Also, all classes in this API are guaranteed to meet stricter API standards regarding documentation and backwards compatibility. Important: until further notice, this is a very WIP namespace so you can expect it to change radically until the dust has settled.

In this namespace you get:

• a convenient place to look for magic numbers: the IDs namespace
• a class that helps building / changing the module architecture of HISE: the Builder
• a wrapper around a module that gets notified when a parameter changes: the Reference
• a class that loads embedded data: the Pool
• a class that handles the (asynchronous) and lockfree execution of larger tasks: the TaskAfterSuspension.

Typedef Documentation

using AttributeCollection = std::vector<AttributeItem>

a collection of attribute key/value pairs.