JUCE

https://docs.juce.com/master
Admin
JUCE is a comprehensive C++ framework for building audio and multimedia applications, offering...
Tokens:4,355,192
Snippets:42,723
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### JUCE ConsoleApplication main() example

Source: https://docs.juce.com/master/structjuce_1_1ConsoleApplication.html

Shows the typical setup for a JUCE console application: add help, version, and custom commands, then run the matching command with findAndRunCommand. The custom command uses a lambda to invoke doFoo with the parsed arguments.

```cpp
int main (int argc, char* argv[])
{
    ConsoleApplication app;
    app.addHelpCommand ("--help|-h", "Usage:", true);
    app.addVersionCommand ("--version|-v", "MyApp version 1.2.3");
    app.addCommand ({ "--foo",
                      "--foo filename",
                      "Performs a foo operation on the given file",
                      [] (const auto& args) { doFoo (args); }});
    return app.findAndRunCommand (argc, argv);
}
```

--------------------------------

### start()

Source: https://docs.juce.com/master/classjuce_1_1AudioIODevice.html

Starts the device actually playing.

```APIDOC
## start()

### Description
Starts the device actually playing.

### Method
Pure virtual member function

### Signature
`virtual void start(AudioIODeviceCallback* callback) = 0`

### Parameters
- **callback** (AudioIODeviceCallback*) - Required - The callback to receive audio data.

### Returns
None
```

--------------------------------

### start()

Source: https://docs.juce.com/master/classjuce_1_1AudioTransportSource.html

Starts playing (if a source has been selected).

```APIDOC
## start()

### Description
Starts playing (if a source has been selected).

### Method
void start()

### Parameters
None

### Returns
void
```

--------------------------------

### start(AudioIODeviceCallback *callback)

Source: https://docs.juce.com/master/classjuce_1_1AudioIODevice-members.html

Starts the audio device with the given callback. This is a pure virtual method.

```APIDOC
## start(AudioIODeviceCallback *callback)

### Description
Starts the audio device with the given callback. This is a pure virtual method.

### Method
start

### Parameters
- **callback** (AudioIODeviceCallback*) - Required - The callback to receive audio data.

### Return Type
bool

### Access
Pure virtual
```

--------------------------------

### MidiInput::start()

Source: https://docs.juce.com/master/classjuce_1_1MidiInput.html

Starts the device running.

```APIDOC
## MidiInput::start()

### Description
Starts the device running.

### Method
void start()

### Parameters
None

### Returns
None
```

--------------------------------

### start(bool inExclusiveMode)

Source: https://docs.juce.com/master/classjuce_1_1AppleRemoteDevice.html

Starts the Apple remote device and begins receiving events.

```APIDOC
## start(bool inExclusiveMode)

### Description
Starts the device running and responding to events. Returns true if it managed to open the device.

### Method
Member function

### Signature
`bool start(bool inExclusiveMode)`

### Parameters
- **inExclusiveMode** (bool) - Required - If true, the remote will be grabbed exclusively for this app, and will not be available to any other part of the system. If false, it will be shared with other apps.

### Returns
- **bool** - True if the device was successfully started, false otherwise.

### See Also
- `stop()`
```

--------------------------------

### startPlaying()

Source: https://docs.juce.com/master/classjuce_1_1StandalonePluginHolder.html

Method to start playback.

```APIDOC
## startPlaying()

### Description
Starts playback of the processor.

### Method
startPlaying

### Signature
void juce::StandalonePluginHolder::startPlaying()
```

--------------------------------

### startPlaying

Source: https://docs.juce.com/master/classjuce_1_1StandalonePluginHolder.html

Starts playing the audio processor.

```APIDOC
## startPlaying

### Description
Starts playing the audio processor.

### Method
void startPlaying()
```

--------------------------------

### juce::HashMap Basic Usage Example

Source: https://docs.juce.com/master/classjuce_1_1HashMap.html

Demonstrates creating a HashMap, setting key-value pairs, accessing values, and iterating over entries. The example uses int keys and String values with the default hash function.

```cpp
HashMap<int, String> hash;
hash.set (1, "item1");
hash.set (2, "item2");
DBG (hash [1]); // prints "item1"
DBG (hash [2]); // prints "item2"

// This iterates the map, printing all of its key -> value pairs.
for (HashMap<int, String>::Iterator i (hash); i.next();)
    DBG (i.getKey() << " -> " << i.getValue());
```

--------------------------------

### play()

Source: https://docs.juce.com/master/classjuce_1_1VideoComponent.html

Starts the video playing.

```APIDOC
## `void play()`

### Description
Starts the video playing.

### Method
`play`

### Signature
`void juce::VideoComponent::play()`

### Parameters
None.

### Returns
None.
```

--------------------------------

### getSelectionStart() const

Source: https://docs.juce.com/master/classjuce_1_1CodeEditorComponent-members.html

Returns the selection start.

```APIDOC
## getSelectionStart() const

### Description
Returns the start of the current selection.

### Method
inline

### Returns
- **int** - The selection start index.
```

--------------------------------

### getFrameCounter()

Source: https://docs.juce.com/master/classjuce_1_1AnimatedAppComponent.html

Gets the number of update() calls since the component started.

```APIDOC
## getFrameCounter()

### Description
Returns the number of times update() has been called since the component started running.

### Syntax
```cpp
int juce::AnimatedAppComponent::getFrameCounter() const noexcept;
```

### Parameters
None.

### Returns
(int) The frame counter value.
```

--------------------------------

### productDownloadProgressUpdate()

Source: https://docs.juce.com/master/structjuce_1_1InAppPurchases_1_1Listener.html

iOS only: Called when a product download progress gets updated. This callback may be invoked after application start if the download was interrupted in a previous session.

```APIDOC
## productDownloadProgressUpdate()

### Description
iOS only: Called when a product download progress gets updated. If the download was interrupted in the last application session, this callback may be called after the application starts. If the download was in progress and the application was closed, the download may continue in the background by the OS. If the download finishes in the background before the app starts again, the productDownloadFinished callback will be received instead.

### Method
virtual void juce::InAppPurchases::Listener::productDownloadProgressUpdate(Download&, float, RelativeTime)

### Parameters
- **__** (Download&) - Required - The download object associated with the progress update.
- **__** (float) - Required - The progress value, typically between 0.0 and 1.0.
- **__** (RelativeTime) - Required - The estimated time remaining for the download.

### Return Value
void

### Notes
This is an inline virtual method. iOS only.
```

--------------------------------

### PositionInfo Accessors and Mutators

Source: https://docs.juce.com/master/classjuce_1_1AudioPlayHead_1_1PositionInfo.html

Methods to get and set playback position information such as loop points, bar count, bar start position, and frame rate.

```APIDOC
## getLoopPoints()

### Description
Returns host loop points, if available.

### Method
`Optional<LoopPoints> getLoopPoints() const`

### Parameters
None.

### Returns
`Optional<LoopPoints>` - The loop points if available, otherwise `nullopt`.
```

```APIDOC
## setLoopPoints()

### Description
Sets the loop points for the position info.

### Method
`void setLoopPoints(Optional<LoopPoints> _loopPointsIn_)`

### Parameters
- `_loopPointsIn_` (Optional<LoopPoints>) - The loop points to set.

### Returns
`void`
```

```APIDOC
## getBarCount()

### Description
Returns the number of bars since the beginning of the timeline. This value isn't available in all hosts or in all plugin formats.

### Method
`Optional<int64_t> getBarCount() const`

### Parameters
None.

### Returns
`Optional<int64_t>` - The bar count if available, otherwise `nullopt`.
```

```APIDOC
## setBarCount()

### Description
Sets the number of bars since the beginning of the timeline.

### Method
`void setBarCount(Optional<int64_t> _barCountIn_)`

### Parameters
- `_barCountIn_` (Optional<int64_t>) - The bar count to set.

### Returns
`void`
```

```APIDOC
## getPpqPositionOfLastBarStart()

### Description
Returns the position of the start of the last bar, in units of quarter-notes. This is the time from the start of the timeline to the start of the current bar, in ppq units. Note - this value may be unavailable on some hosts, e.g. Pro-Tools.

### Method
`Optional<double> getPpqPositionOfLastBarStart() const`

### Parameters
None.

### Returns
`Optional<double>` - The position in ppq if available, otherwise `nullopt`.
```

```APIDOC
## setPpqPositionOfLastBarStart()

### Description
Sets the position of the start of the last bar, in units of quarter-notes.

### Method
`void setPpqPositionOfLastBarStart(Optional<double> _positionIn_)`

### Parameters
- `_positionIn_` (Optional<double>) - The position in ppq to set.

### Returns
`void`
```

```APIDOC
## getFrameRate()

### Description
Returns the video frame rate, if available.

### Method
`Optional<FrameRate> getFrameRate() const`

### Parameters
None.

### Returns
`Optional<FrameRate>` - The frame rate if available, otherwise `nullopt`.
```

--------------------------------

### Use WeakReference to track object deletion

Source: https://docs.juce.com/master/classjuce_1_1WeakReference.html

Demonstrates using a WeakReference pointer: after the object is deleted, get() returns nullptr. The example assumes MyObject is weak-referenceable as shown in the previous snippet.

```cpp
auto* n = new MyObject();
WeakReference<MyObject> myObjectRef = n;
auto pointer1 = myObjectRef.get(); // returns a valid pointer to 'n'
delete n;
auto pointer2 = myObjectRef.get(); // now returns nullptr
```

--------------------------------

### audioDeviceAboutToStart(AudioIODevice *device)

Source: https://docs.juce.com/master/classjuce_1_1AudioIODeviceCallback-members.html

Pure virtual method called when the audio device is about to start.

```APIDOC
## audioDeviceAboutToStart(AudioIODevice *device)

### Description
Called when the audio device is about to start. Override this method to prepare your audio processing resources.

### Method
Pure virtual

### Signature
`virtual void audioDeviceAboutToStart(AudioIODevice *device) = 0;`

### Parameters
- **device** (AudioIODevice*) - Required - The audio device that is about to start.

### Returns
void

```

--------------------------------

### void startDownloads(const Array<Download *> &downloads)

Source: https://docs.juce.com/master/classjuce_1_1InAppPurchases.html

iOS only: Starts downloads of hosted content from the store.

```APIDOC
## void startDownloads(const Array<Download *> &downloads)

### Description
iOS only: Starts downloads of hosted content from the store.

### Method
startDownloads

### Parameters
- **downloads** (Array<Download *>) - Required - The downloads to start.

### Returns
None
```

--------------------------------

### setSavePoint()

Source: https://docs.juce.com/master/classjuce_1_1CodeDocument.html

Makes a note that the document's current state matches the one that is saved. After this has been called, hasChangedSinceSavePoint() will return false until the document has been altered, and then it'll start returning true. If the document is altered, but then undone until it gets back to this state, hasChangedSinceSavePoint() will again return false.

```APIDOC
## setSavePoint()

### Description
Makes a note that the document's current state matches the one that is saved. After this has been called, hasChangedSinceSavePoint() will return false until the document has been altered, and then it'll start returning true. If the document is altered, but then undone until it gets back to this state, hasChangedSinceSavePoint() will again return false.

### Method
setSavePoint

### Signature
`void juce::CodeDocument::setSavePoint() noexcept`

### Parameters
None.

### Returns
void

### See Also
- hasChangedSinceSavePoint
```

--------------------------------

### Configure PushNotifications::Settings with actions and categories

Source: https://docs.juce.com/master/structjuce_1_1PushNotifications_1_1Settings.html

Example setup for push notification settings on iOS and partially OSX. Defines actions and categories with unique identifiers, then assigns them to a PushNotifications::Settings object with allowAlert, allowBadge, allowSound, and categories. On OSX only the allow* flags are used and they control remote notifications only.

```cpp
using Action = PushNotifications::Settings::Action;
using Category = PushNotifications::Settings::Category;

Action okAction;
okAction.identifier = "okAction";
okAction.title = "OK!";
okAction.style = Action::button;
okAction.triggerInBackground = true;

Action cancelAction;
cancelAction.identifier = "cancelAction";
cancelAction.title = "Cancel";
cancelAction.style = Action::button;
cancelAction.triggerInBackground = true;
cancelAction.destructive = true;

Action textAction;
textAction.identifier = "textAction";
textAction.title = "Enter text";
textAction.style = Action::text;
textAction.triggerInBackground = true;
textAction.destructive = false;
textAction.textInputButtonText = "Ok";
textAction.textInputPlaceholder = "Enter text...";

Category okCategory;
okCategory.identifier = "okCategory";
okCategory.actions = { okAction };

Category okCancelCategory;
okCancelCategory.identifier = "okCancelCategory";
okCancelCategory.actions = { okAction, cancelAction };

Category textCategory;
textCategory.identifier = "textCategory";
textCategory.actions = { textAction };
textCategory.sendDismissAction = true;

PushNotifications::Settings settings;
settings.allowAlert = true;
settings.allowBadge = true;
settings.allowSound = true;
settings.categories = { okCategory, okCancelCategory, textCategory };
```

--------------------------------

### startDownloads(const Array< Download * > &downloads)

Source: https://docs.juce.com/master/classjuce_1_1InAppPurchases-members.html

Starts a set of downloads.

```APIDOC
## startDownloads(const Array< Download * > &downloads)

### Description
Starts a set of downloads.

### Method
startDownloads

### Parameters
- **downloads** (const Array< Download * > &) - Required - The downloads to start.

### Returns
void
```

--------------------------------

### PerformanceCounter usage example

Source: https://docs.juce.com/master/classjuce_1_1PerformanceCounter.html

Creates a PerformanceCounter with name "fish", runs per printout of 50, and a log file at "/temp/myfishlog.txt". In a loop, it starts timing, calls doSomethingFishy(), and stops timing. The time of each period is averaged over 50 runs and printed to the file every 50 iterations.

```cpp
PerformanceCounter pc ("fish", 50, "/temp/myfishlog.txt");
for (;;)
{
    pc.start();
    doSomethingFishy();
    pc.stop();
}
```

--------------------------------

### initialise

Source: https://docs.juce.com/master/classjuce_1_1JUCEApplicationBase.html

Pure virtual method called when the application starts. Override to set up the application's initial state, such as creating windows or loading resources.

```APIDOC
## initialise

### Description
Called when the application starts. Override this method to perform initialisation tasks.

### Method
virtual void initialise(const String &commandLineParameters) = 0

### Parameters
- **commandLineParameters** (const String&) - The command line parameters passed to the application.

### Returns
void
```

--------------------------------

### start()

Source: https://docs.juce.com/master/classjuce_1_1ScheduledEventThread-members.html

Starts the scheduled event thread.

```APIDOC
## start()

### Description
Starts the thread to begin processing scheduled events.

### Signature
`void start()`

### Remarks
This method is inline.
```

--------------------------------

### void audioDeviceAboutToStart(AudioIODevice* device) override

Source: https://docs.juce.com/master/classjuce_1_1AudioSourcePlayer.html

Implementation of the AudioIODeviceCallback method.

```APIDOC
## void audioDeviceAboutToStart(AudioIODevice* device) override

### Description
Implementation of the AudioIODeviceCallback method.

### Method
audioDeviceAboutToStart

### Parameters
- **device** (AudioIODevice*) - Required - The audio device that is about to start.

### Returns
void
```

--------------------------------

### open()

Source: https://docs.juce.com/master/classjuce_1_1AudioIODevice.html

Tries to open the device ready to play with the specified input/output channels, sample rate, and buffer size.

```APIDOC
## open()

### Description
Tries to open the device ready to play.

### Method
virtual String juce::AudioIODevice::open(const BigInteger &inputChannels, const BigInteger &outputChannels, double sampleRate, int bufferSizeSamples)

### Parameters
- **inputChannels** (const BigInteger&) - Required - A BigInteger in which a set bit indicates that the corresponding input channel should be enabled.
- **outputChannels** (const BigInteger&) - Required - A BigInteger in which a set bit indicates that the corresponding output channel should be enabled.
- **sampleRate** (double) - Required - The sample rate to try to use - to find out which rates are available, see getAvailableSampleRates().
- **bufferSizeSamples** (int) - Required - The size of i/o buffer to use - to find out the available buffer sizes, see getAvailableBufferSizes().

### Returns
- **String** - An error description if there's a problem, or an empty string if it succeeds in opening the device.

### See Also
- close
```

--------------------------------

### audioDeviceAboutToStart(AudioIODevice *device) override

Source: https://docs.juce.com/master/classjuce_1_1AudioSourcePlayer-members.html

Called by the audio device when it is about to start. Prepares the audio source for playback.

```APIDOC
## audioDeviceAboutToStart(AudioIODevice *device) override

### Description
Called by the audio device when it is about to start. Prepares the audio source for playback.

### Method
Virtual override

### Signature
`void audioDeviceAboutToStart(AudioIODevice *device) override`

### Parameters
- **device** (AudioIODevice*) - Required - The audio device that is starting.

### Returns
Nothing.
```

--------------------------------

### get() const

Source: https://docs.juce.com/master/classjuce_1_1JSObject-members.html

Gets the underlying JavaScript object handle.

```APIDOC
## Method

### Description
Gets the underlying JavaScript object handle.

### Signature
```cpp
??? get() const;
```

### Returns
The underlying JavaScript object handle.

```

--------------------------------

### startNewSubPath(Point< float > start)

Source: https://docs.juce.com/master/classjuce_1_1Path-members.html

Starts a new subpath at the given point.

```APIDOC
## startNewSubPath(Point< float > start)

### Description
Starts a new subpath at the specified point.

### Method
Path construction

### Signature
`void startNewSubPath(Point< float > start)`

### Parameters
- **start** (Point<float>) - The starting point of the subpath.

### Returns
None

```

--------------------------------

### open()

Source: https://docs.juce.com/master/classjuce_1_1AudioIODevice.html

Tries to open the device ready to play.

```APIDOC
## open()

### Description
Tries to open the device ready to play.

### Method
Pure virtual member function

### Signature
`virtual String open(const BigInteger& inputChannels, const BigInteger& outputChannels, double sampleRate, int bufferSizeSamples) = 0`

### Parameters
- **inputChannels** (BigInteger) - Required - A mask of input channels to enable.
- **outputChannels** (BigInteger) - Required - A mask of output channels to enable.
- **sampleRate** (double) - Required - The sample rate to use.
- **bufferSizeSamples** (int) - Required - The buffer size in samples.

### Returns
- **String** - An error message if opening fails, or an empty string on success.
```

--------------------------------

### setEnd()

Source: https://docs.juce.com/master/classjuce_1_1Range.html

Changes the end position of the range, leaving the start unchanged. If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

```APIDOC
## setEnd()

### Description
Changes the end position of the range, leaving the start unchanged. If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

### Method
setEnd

### Signature
`void setEnd(const ValueType _newEnd_)`

### Parameters
- `_newEnd_` (ValueType) - Required - The new end position for the range.

### Return Value
None (void).
```

--------------------------------

### midiStart()

Source: https://docs.juce.com/master/classjuce_1_1MidiMessage.html

Creates a MIDI start event message.

```APIDOC
## midiStart()

### Description
Creates a midi start event.

### Method
static noexcept

### Signature
`static MidiMessage midiStart() noexcept`

### Returns
- **MidiMessage** - A new MidiMessage representing a MIDI start event.

### Notes
- This is a static factory method.
- It does not throw exceptions.
```

--------------------------------

### prepareToPlay()

Source: https://docs.juce.com/master/classjuce_1_1AudioSourcePlayer.html

An alternative method for initialising the source without an AudioIODevice.

```APIDOC
## prepareToPlay()

### Description
An alternative method for initialising the source without an AudioIODevice.

### Method
void prepareToPlay(double sampleRate, int blockSize)

### Parameters
- **sampleRate** (double) - The sample rate to prepare for.
- **blockSize** (int) - The block size to prepare for.

### Returns
void
```

--------------------------------

### withEnd()

Source: https://docs.juce.com/master/classjuce_1_1Range.html

Returns a range with the same start position but a different end, adjusting the start if necessary.

```APIDOC
## withEnd()

### Description
Returns a range with the same start position as this one, but a different end. If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

### Method
withEnd

### Signature
`Range<ValueType> withEnd(const ValueType _newEnd_) const`

### Parameters
- `_newEnd_` (ValueType) - The new end position for the range.

### Returns
A new Range object with the same start and the specified end.

### Notes
- Inline, nodiscard, constexpr, noexcept.
- References `juce::jmin()` and `Range()`.
```

--------------------------------

### prepare()

Source: https://docs.juce.com/master/classjuce_1_1dsp_1_1Panner.html

Initialises the Panner processor with a processing specification.

```APIDOC
## prepare()

### Description
Initialises the processor with the given processing specification.

### Method
prepare

### Signature
`void juce::dsp::Panner<SampleType>::prepare(const ProcessSpec &spec)`

### Parameters
- **spec** (const ProcessSpec&) - Required - The processing specification.

```

--------------------------------

### Span deduction guides

Source: https://docs.juce.com/master/namespacejuce.html

Deduction guides for constructing Span objects from various sources.

```APIDOC
## Span deduction guides

### Description
Deduction guides for the Span class template.

### Method
Deduction Guide

### Signatures
- `template<typename T, typename End> Span(T, End) -> Span<std::remove_pointer_t<decltype(detail::toAddress(std::declval<T>()))>>`
- `template<typename T, size_t N> Span(T(&)[N]) -> Span<T, N>`
- `template<typename T, size_t N> Span(std::array<T, N>&) -> Span<T, N>`
- `template<typename T, size_t N> Span(const std::array<T, N>&) -> Span<const T, N>`
- `template<typename Range> Span(Range&& r) -> Span<std::remove_pointer_t<decltype(std::data(r))>>`
```

--------------------------------

### startAsProcess()

Source: https://docs.juce.com/master/classjuce_1_1File.html

Launches the file as a process, running executables, opening documents with default viewers, or opening folders in the OS file manager.

```APIDOC
## startAsProcess()

### Description
Launches the file as a process. If the file is executable, it will run it; if it's a document, it will launch it with its default viewer; if it's a folder, it will be opened in Explorer, Finder, or equivalent.

### Method
startAsProcess

### Signature
`bool juce::File::startAsProcess(const String& parameters = String()) const`

### Parameters
- **parameters** (String) - Optional - Command-line parameters to pass to the process.

### Returns
- **bool** - True if the launch was successful.

### See Also
- revealToUser
```

--------------------------------

### start()

Source: https://docs.juce.com/master/classjuce_1_1Animator.html

Marks the Animator ready for starting. Must be called to allow the Animator to move out of the idle state. After calling, the on start callback will be executed at the next update followed by the first call to its update function.

```APIDOC
## void start() const

### Description
Marks the Animator ready for starting. You must call this function to allow the Animator to move out of the idle state. After calling this function the Animator's on start callback will be executed at the next update immediately followed by the first call to its update function. You can call this function before or after adding the Animator to an AnimatorUpdater. Until start() is called the Animator will just sit idly in the updater's queue.

### Method
start

### Signature
`void juce::Animator::start() const`

### Parameters
None.

### Returns
- **void** - No return value.
```

--------------------------------

### midiStart() noexcept

Source: https://docs.juce.com/master/classjuce_1_1MidiMessage-members.html

Creates a MIDI start message.

```APIDOC
## midiStart() noexcept

### Description
Creates a MIDI start message.

### Method
midiStart

### Parameters
None

### Returns
MidiMessage - The created MIDI start message.
```

--------------------------------

### startDownloads(const Array<Download*>&)

Source: https://docs.juce.com/master/classjuce_1_1InAppPurchases.html

iOS only: Starts downloads of hosted content from the store.

```APIDOC
## startDownloads(const Array<Download*>&)

### Description
iOS only: Starts downloads of hosted content from the store.

### Method
startDownloads

### Parameters
- **const Array<Download*>&** - Required - The downloads to start.

```

--------------------------------

### Define a JUCE application subclass and launch it with START_JUCE_APPLICATION

Source: https://docs.juce.com/master/classjuce_1_1JUCEApplicationBase.html

Shows a complete minimal JUCE application class deriving from JUCEApplication, implementing the required virtual methods, and using the START_JUCE_APPLICATION macro to generate boilerplate. The initialise method creates and shows a main window, while shutdown releases it. Use this pattern when creating a standalone JUCE app.

```cpp
class MyJUCEApp : public JUCEApplication
{
public:
    MyJUCEApp() {}
    ~MyJUCEApp() {}

    void initialise (const String& commandLine) override
    {
        myMainWindow.reset (new MyApplicationWindow());
        myMainWindow->setBounds (100, 100, 400, 500);
        myMainWindow->setVisible (true);
    }

    void shutdown() override
    {
        myMainWindow = nullptr;
    }

    const String getApplicationName() override
    {
        return "Super JUCE-o-matic";
    }

    const String getApplicationVersion() override
    {
        return "1.0";
    }

private:
    std::unique_ptr<MyApplicationWindow> myMainWindow;
};

// this generates boilerplate code to launch our app class:
START_JUCE_APPLICATION (MyJUCEApp)
```

--------------------------------

### Static utility functions

Source: https://docs.juce.com/master/classjuce_1_1LegacyAudioParameter.html

Static functions for checking legacy status, getting parameter index, and getting parameter ID.

```APIDOC
## Static Public Member Functions

### isLegacy()

#### Description
Checks if a given AudioProcessorParameter is a legacy parameter.

#### Method
`static bool isLegacy(AudioProcessorParameter *param) noexcept`

#### Parameters
- `param` (AudioProcessorParameter*) - Required - The parameter to check.

#### Returns
- `bool` - True if the parameter is legacy, false otherwise.

### getParamIndex()

#### Description
Gets the index of a parameter within an audio processor.

#### Method
`static int getParamIndex(AudioProcessor &proc, AudioProcessorParameter *param) noexcept`

#### Parameters
- `proc` (AudioProcessor&) - Required - The audio processor.
- `param` (AudioProcessorParameter*) - Required - The parameter to find.

#### Returns
- `int` - The index of the parameter, or -1 if not found.

### getParamID()

#### Description
Gets the parameter ID as a string, optionally forcing legacy parameter IDs.

#### Method
`static String getParamID(const AudioProcessorParameter *param, bool forceLegacyParamIDs) noexcept`

#### Parameters
- `param` (const AudioProcessorParameter*) - Required - The parameter.
- `forceLegacyParamIDs` (bool) - Required - If true, forces legacy parameter ID generation.

#### Returns
- `String` - The parameter ID.
```

--------------------------------

### fromStartAndAngle()

Source: https://docs.juce.com/master/classjuce_1_1Line.html

Creates a line from a start point, length, and angle. The angle is in radians clockwise from the 12 o'clock direction, with the start point as the centre.

```APIDOC
## fromStartAndAngle()

### Description
Creates a line from a start point, length, and angle. The angle is the number of radians clockwise from the 12 o'clock direction, where the line's start point is considered to be at the centre.

### Method
`static Line fromStartAndAngle(Point<ValueType> startPoint, ValueType length, ValueType angle)`

### Parameters
- **startPoint** (Point<ValueType>) - Required - The start point of the line.
- **length** (ValueType) - Required - The length of the line.
- **angle** (ValueType) - Required - The angle in radians.

### Returns
- **Line** - The newly created line.

```

--------------------------------

### init()

Source: https://docs.juce.com/master/classjuce_1_1StandalonePluginHolder.html

Initializes the standalone plugin holder with audio input and a preferred default device name.

```APIDOC
## init()

### Description
Initializes the standalone plugin holder with audio input and a preferred default device name. Starts the timer and optionally opens MIDI devices.

### Method
init

### Signature
`void init(bool _enableAudioInput_, const String& _preferredDefaultDeviceName_)`

### Parameters
- `_enableAudioInput_` (bool) - Required - Whether to enable audio input.
- `_preferredDefaultDeviceName_` (const String&) - Required - The preferred default device name.

### Returns
None.

### Notes
- References `autoOpenMidiDevices`, `options`, `reloadPluginState()`, `startPlaying()`, and `juce::Timer::startTimer()`.
```

--------------------------------

### findTokenContaining(const Position &pos, Position &start, Position &end) const noexcept

Source: https://docs.juce.com/master/classjuce_1_1CodeDocument-members.html

Finds the start and end positions of the token containing the given position.

```APIDOC
## findTokenContaining(const Position &pos, Position &start, Position &end) const noexcept

### Description
Finds the start and end positions of the token containing the given position.

### Method
Member function

### Signature
`void findTokenContaining(const Position &pos, Position &start, Position &end) const noexcept`

### Parameters
- **pos** (const Position&) - Required - The position to search for.
- **start** (Position&) - Required - Output parameter for the start of the token.
- **end** (Position&) - Required - Output parameter for the end of the token.

### Returns
None.
```

--------------------------------

### init

Source: https://docs.juce.com/master/classjuce_1_1StandalonePluginHolder.html

Initializes the standalone plugin holder with audio input and device preferences.

```APIDOC
## init

### Description
Initializes the standalone plugin holder.

### Method
void init(bool enableAudioInput, const String &preferredDefaultDeviceName)

### Parameters
- **enableAudioInput** (bool) - Required - Whether to enable audio input.
- **preferredDefaultDeviceName** (const String&) - Required - The preferred default device name.
```

--------------------------------

### findLineContaining(const Position &pos, Position &start, Position &end) const noexcept

Source: https://docs.juce.com/master/classjuce_1_1CodeDocument-members.html

Finds the start and end positions of the line containing the given position.

```APIDOC
## findLineContaining(const Position &pos, Position &start, Position &end) const noexcept

### Description
Finds the start and end positions of the line containing the given position.

### Method
Member function

### Signature
`void findLineContaining(const Position &pos, Position &start, Position &end) const noexcept`

### Parameters
- **pos** (const Position&) - Required - The position to search for.
- **start** (Position&) - Required - Output parameter for the start of the line.
- **end** (Position&) - Required - Output parameter for the end of the line.

### Returns
None.
```

--------------------------------

### void prepareToPlay(double, int) override

Source: https://docs.juce.com/master/classjuce_1_1AudioProcessorGraph.html

Called before playback starts, to let the processor prepare itself.

```APIDOC
## void prepareToPlay(double, int) override

### Description
Called before playback starts, to let the processor prepare itself.

### Method
prepareToPlay

### Parameters
- **double** (double) - Required - The sample rate.
- **int** (int) - Required - The expected number of samples per block.

### Returns
void
```

--------------------------------

### MidiInput::start()

Source: https://docs.juce.com/master/classjuce_1_1MidiInput.html

Starts the MIDI input device so it begins sending messages to the callback.

```APIDOC
## void MidiInput::start()

### Description
Starts the device running. After calling this, the device will start sending MIDI messages to the MidiInputCallback object that was specified when the openDevice() method was called.

### Method
start

### Parameters
None.

### Returns
void

### See Also
- stop
```

--------------------------------

### juce::ScopeGuard deduction guide

Source: https://docs.juce.com/master/juce__ScopeGuard_8h.html

A deduction guide that allows the template parameter Fn to be deduced from the constructor argument, enabling the use of class template argument deduction (CTAD).

```APIDOC
## juce::ScopeGuard deduction guide

### Description
A deduction guide that allows the template parameter Fn to be deduced from the constructor argument, enabling the use of class template argument deduction (CTAD).

### Usage
When constructing a ScopeGuard, the template parameter Fn is automatically deduced from the type of the callable passed to the constructor.

### Example
```cpp
void example() {
    auto guard = juce::ScopeGuard([] { cleanup(); }); // Fn deduced as lambda type
}
```
```

--------------------------------

### MultiTimer::startTimer(int timerID, int intervalInMilliseconds)

Source: https://docs.juce.com/master/classjuce_1_1MultiTimer.html

Starts a timer with a given ID and interval. If the timer is already started, it resets the interval. The interval is rounded up to at least 1 millisecond.

```APIDOC
## MultiTimer::startTimer(int timerID, int intervalInMilliseconds)

### Description
Starts a timer and sets the length of interval required. If the timer is already started, this will reset it, so the time between calling this method and the next timer callback will not be less than the interval length passed in.

### Method
void startTimer(int timerID, int intervalInMilliseconds) noexcept

### Parameters
- **timerID** (int) - Required - A unique Id number that identifies the timer to start. This is the id that will be passed back to the timerCallback() method when this timer is triggered.
- **intervalInMilliseconds** (int) - Required - The interval to use (any values less than 1 will be rounded up to 1).

### Returns
void
```

--------------------------------

### initialise()

Source: https://docs.juce.com/master/classjuce_1_1OpenGLAppComponent.html

Pure virtual method to set up GL objects for rendering. Called when the GL context is active.

```APIDOC
## initialise()

### Description
Implement this method to set up any GL objects that you need for rendering. The GL context will be active when this method is called. Note that because the GL context could be destroyed and re-created ad-hoc by the underlying platform, the shutdown() and initialise() calls could be called multiple times while your app is running. So don't make your code assume that this will only be called once!

### Method
Pure virtual member function

### Signature
`virtual void juce::OpenGLAppComponent::initialise() = 0`

```

--------------------------------

### noteAdded(MPENote)

Source: https://docs.juce.com/master/classjuce_1_1MPESynthesiser.html

Attempts to start playing a new note. The default method finds a free voice and uses it to start playing the sound. Called automatically during renderNextBlock(); do not call directly.

```APIDOC
## noteAdded(MPENote)

### Description
Attempts to start playing a new note. The default method here will find a free voice that is appropriate for playing the given MPENote, and use that voice to start playing the sound. If isNoteStealingEnabled returns true (set this by calling setNoteStealingEnabled), the synthesiser will use the voice stealing algorithm to find a free voice for the note (if no voices are free otherwise). This method will be called automatically according to the midi data passed into renderNextBlock(). Do not call it yourself, otherwise the internal MPE note state will become inconsistent.

### Method
void noteAdded(MPENote _newNote_)

### Parameters
- **_newNote_** (MPENote) - Required - The note to start playing.

### Notes
- This is an override of juce::MPEInstrument::Listener::noteAdded.
- It is protected virtual; called automatically.
```

--------------------------------

### audioDeviceAboutToStart(AudioIODevice* device)

Source: https://docs.juce.com/master/classjuce_1_1AudioIODeviceCallback.html

Called to indicate that the device is about to start calling back. This is invoked just before audio callbacks begin, either when the callback is added to an audio device or after a sample-rate or block-size change. Use this to query the device's sample rate and buffer size.

```APIDOC
## audioDeviceAboutToStart(AudioIODevice* device)

### Description
Called to indicate that the device is about to start calling back. This will be called just before the audio callbacks begin, either when this callback has just been added to an audio device, or after the device has been restarted because of a sample-rate or block-size change. You can use this opportunity to find out the sample rate and block size that the device is going to use by calling the AudioIODevice::getCurrentSampleRate() and AudioIODevice::getCurrentBufferSizeSamples() on the supplied pointer.

### Method
virtual void audioDeviceAboutToStart(AudioIODevice* device) - pure virtual

### Parameters
- **device** (AudioIODevice*) - The audio IO device that will be used to drive the callback. Note that if you're going to store this pointer, it is only valid until the next time that audioDeviceStopped is called.

### Implemented In
- juce::AudioProcessorPlayer
- juce::AudioSourcePlayer
- juce::SoundPlayer
```

--------------------------------

### startHostManagedResize()

Source: https://docs.juce.com/master/classjuce_1_1ComponentPeer.html

Asks the window-manager to begin resizing this window, on platforms where this is useful (currently just Linux/X11).

```APIDOC
## startHostManagedResize()

### Description
Asks the window-manager to begin resizing this window, on platforms where this is useful (currently just Linux/X11).

### Method
`virtual void startHostManagedResize(Point<int> mouseDownPosition, ResizableBorderComponent::Zone zone)`

### Parameters
- **mouseDownPosition** (Point<int>) - The position of the mouse event that started the resize in unscaled peer coordinates.
- **zone** (ResizableBorderComponent::Zone) - The edges of the window that may be moved during the resize.

```

--------------------------------

### Share an image with ContentSharer::shareImages

Source: https://docs.juce.com/master/classjuce_1_1ContentSharer.html

Example from the documentation showing how to create an image, add it to an array, and share it using ContentSharer::shareImages. The example uses Graphics to draw on the image and Array<Image> to hold it.

```cpp
Graphics g (myImage);
g.setColour (Colours::green);
g.fillEllipse (20, 20, 300, 200);
Array<Image> images;
images.add (myImage);
ContentSharer::getInstance()->shareImages (images, myCallback);
```

--------------------------------

### virtual void initialise() = 0

Source: https://docs.juce.com/master/classjuce_1_1OpenGLAppComponent.html

Pure virtual method to set up any GL objects needed for rendering.

```APIDOC
## virtual void initialise() = 0

### Description
Implement this method to set up any GL objects that you need for rendering.

### Method
Pure virtual member function

### Syntax
`virtual void initialise() = 0`

```

--------------------------------

### isTimerRunning()

Source: https://docs.juce.com/master/classjuce_1_1HighResolutionTimer.html

Checks if the timer has been started.

```APIDOC
## isTimerRunning()

### Description
Checks if the timer has been started.

### Method
Query timer state

### Signature
`bool isTimerRunning() const noexcept`

### Parameters
None.

### Returns
- **bool** - True if the timer is running, false otherwise.
```

--------------------------------

### begin()

Source: https://docs.juce.com/master/classjuce_1_1GlyphArrangement.html

Returns a pointer to the first glyph in the arrangement, for iteration.

```APIDOC
## begin()

### Description
Returns a pointer to the first glyph in the arrangement, for iteration.

### Method
begin()

### Signature
`const PositionedGlyph* begin() const`

### Parameters
None.

### Returns
(const PositionedGlyph*) A pointer to the first glyph.
```

--------------------------------

### glGetFenceivNV

Source: https://docs.juce.com/master/juce__gl_8h.html

Gets fence parameters.

```APIDOC
## glGetFenceivNV

### Description
Gets fence parameters.

### Parameters
- **fence** (GLuint) - Fence name.
- **pname** (GLenum) - Parameter name.
- **params** (GLint*) - Buffer to receive values.

### Returns
void
```

--------------------------------

### virtual void UnitTest::initialise()

Source: https://docs.juce.com/master/classjuce_1_1UnitTest.html

You can optionally implement this method to set up your test.

```APIDOC
## virtual void UnitTest::initialise()

### Description
You can optionally implement this method to set up your test. This is called before runTest().
```

--------------------------------

### glGetMultisamplefvNV

Source: https://docs.juce.com/master/juce__gl_8h.html

Gets multisample parameters.

```APIDOC
## glGetMultisamplefvNV

### Description
Gets multisample parameters.

### Parameters
- **pname** (GLenum) - Parameter name.
- **index** (GLuint) - Sample index.
- **val** (GLfloat*) - Buffer to receive values.

### Returns
void
```

--------------------------------

### getTargetComponent()

Source: https://docs.juce.com/master/classjuce_1_1PopupMenu_1_1Options.html

Gets the target component.

```APIDOC
## getTargetComponent()

### Description
Gets the target component. This may be nullptr if the Component has been deleted.

### Method
getTargetComponent()

### Signature
`Component* juce::PopupMenu::Options::getTargetComponent() const noexcept`

### Parameters
None.

### Returns
The target component, or nullptr if the Component has been deleted.

### See Also
- withTargetComponent
```

--------------------------------

### startVoice(MPESynthesiserVoice* voice, MPENote noteToStart)

Source: https://docs.juce.com/master/classjuce_1_1MPESynthesiser-members.html

Starts a voice with the given note.

```APIDOC
## startVoice(MPESynthesiserVoice* voice, MPENote noteToStart)

### Description
Starts a voice with the given note.

### Method
Protected member function

### Signature
`void startVoice(MPESynthesiserVoice* voice, MPENote noteToStart)`

### Parameters
- **voice** (MPESynthesiserVoice*) - Required - The voice to start.
- **noteToStart** (MPENote) - Required - The note to start.

### Returns
void
```
Tokens:
Raw