JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::AudioProcessorListener::ChangeDetails Struct Reference

Provides details about aspects of an AudioProcessor which have changed. More...

#include <juce_AudioProcessorListener.h>

Collaboration diagram for juce::AudioProcessorListener::ChangeDetails:

Public Member Functions

JUCE_NODISCARD ChangeDetails withLatencyChanged (bool b) const noexcept
 Indicates that the AudioProcessor's latency has changed. More...
 
JUCE_NODISCARD ChangeDetails withNonParameterStateChanged (bool b) const noexcept
 Indicates that the plugin state has changed (but not its parameters!). More...
 
JUCE_NODISCARD ChangeDetails withParameterInfoChanged (bool b) const noexcept
 Indicates that some attributes of the AudioProcessor's parameters have changed. More...
 
JUCE_NODISCARD ChangeDetails withProgramChanged (bool b) const noexcept
 Indicates that the loaded program has changed. More...
 

Static Public Member Functions

static ChangeDetails getAllChanged ()
 
static ChangeDetails getDefaultFlags ()
 Returns the default set of flags that will be used when AudioProcessor::updateHostDisplay() is called with no arguments. More...
 

Public Attributes

bool latencyChanged = false
 
bool nonParameterStateChanged = false
 
bool parameterInfoChanged = false
 
bool programChanged = false
 

Private Member Functions

template<typename Member , typename Value >
ChangeDetails with (Member &&member, Value &&value) const noexcept
 

Detailed Description

Provides details about aspects of an AudioProcessor which have changed.

Member Function Documentation

◆ getAllChanged()

static ChangeDetails juce::AudioProcessorListener::ChangeDetails::getAllChanged ( )
inlinestatic

◆ getDefaultFlags()

static ChangeDetails juce::AudioProcessorListener::ChangeDetails::getDefaultFlags ( )
inlinestatic

Returns the default set of flags that will be used when AudioProcessor::updateHostDisplay() is called with no arguments.

References withLatencyChanged(), withParameterInfoChanged(), and withProgramChanged().

◆ with()

template<typename Member , typename Value >
ChangeDetails juce::AudioProcessorListener::ChangeDetails::with ( Member &&  member,
Value &&  value 
) const
inlineprivatenoexcept

◆ withLatencyChanged()

JUCE_NODISCARD ChangeDetails juce::AudioProcessorListener::ChangeDetails::withLatencyChanged ( bool  b) const
inlinenoexcept

Indicates that the AudioProcessor's latency has changed.

Most of the time, you won't need to use this function directly. AudioProcessor::setLatencySamples() will automatically call AudioProcessor::updateHostDisplay(), indicating that the latency has changed.

See also
latencyChanged

References juce::gl::b.

Referenced by getDefaultFlags().

◆ withNonParameterStateChanged()

JUCE_NODISCARD ChangeDetails juce::AudioProcessorListener::ChangeDetails::withNonParameterStateChanged ( bool  b) const
inlinenoexcept

Indicates that the plugin state has changed (but not its parameters!).

An AudioProcessor can call updateHostDisplay with this flag set to notify the host that its state has changed in a way that requires re-saving.

If a host receives a call to audioProcessorChanged with this flag set, it should offer to save the plugin state before taking any actions that might irrevocably destroy the current plugin state, such as closing the project.

See also
nonParameterStateChanged

References juce::gl::b.

◆ withParameterInfoChanged()

JUCE_NODISCARD ChangeDetails juce::AudioProcessorListener::ChangeDetails::withParameterInfoChanged ( bool  b) const
inlinenoexcept

Indicates that some attributes of the AudioProcessor's parameters have changed.

When this flag is set, the host should rescan the AudioProcessor's parameters, and update its controls to match. This is often used to update the names of a plugin's parameters in the host.

See also
parameterInfoChanged

References juce::gl::b.

Referenced by getDefaultFlags().

◆ withProgramChanged()

JUCE_NODISCARD ChangeDetails juce::AudioProcessorListener::ChangeDetails::withProgramChanged ( bool  b) const
inlinenoexcept

Indicates that the loaded program has changed.

When this flag is set, the host should call AudioProcessor::getCurrentProgram() and update any preset list views to display the program that is currently in use.

See also
programChanged

References juce::gl::b.

Referenced by getDefaultFlags().

Member Data Documentation

◆ latencyChanged

bool juce::AudioProcessorListener::ChangeDetails::latencyChanged = false

◆ nonParameterStateChanged

bool juce::AudioProcessorListener::ChangeDetails::nonParameterStateChanged = false

◆ parameterInfoChanged

bool juce::AudioProcessorListener::ChangeDetails::parameterInfoChanged = false

◆ programChanged

bool juce::AudioProcessorListener::ChangeDetails::programChanged = false

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