mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Add documentation tags

Browse source
This commit is contained in:
ed 2018-03-15 10:47:05 +00:00
parent e982c70438
commit cdbc28c18b
534 changed files with 1531 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/juce_analytics/analytics/juce_Analytics.h
View file

@ -36,6 +36,8 @@ namespace juce
@see AnalyticsDestination, ThreadedAnalyticsDestination,
AnalyticsDestination::AnalyticsEvent
@tags{Analytics}
*/
class JUCE_API Analytics : public DeletedAtShutdown
{

2
modules/juce_analytics/analytics/juce_ButtonTracker.h
View file

@ -33,6 +33,8 @@ namespace juce
when a button is clicked.
@see Analytics, AnalyticsDestination::AnalyticsEvent
@tags{Analytics}
*/
class JUCE_API ButtonTracker : private Button::Listener
{

2
modules/juce_analytics/destinations/juce_AnalyticsDestination.h
View file

@ -39,6 +39,8 @@ namespace juce
with web servers and other time consuming destinations.
@see Analytics, ThreadedAnalyticsDestination
@tags{Analytics}
*/
struct JUCE_API AnalyticsDestination
{

2
modules/juce_analytics/destinations/juce_ThreadedAnalyticsDestination.h
View file

@ -47,6 +47,8 @@ namespace juce
you should use to terminate the currently running logBatchedEvents call.
@see Analytics, AnalyticsDestination, AnalyticsDestination::AnalyticsEvent
@tags{Analytics}
*/
class JUCE_API ThreadedAnalyticsDestination : public AnalyticsDestination
{

2
modules/juce_audio_basics/audio_play_head/juce_AudioPlayHead.h
View file

@ -32,6 +32,8 @@ namespace juce
out about the position of the audio that it is rendering.
@see AudioProcessor::setPlayHead, AudioProcessor::getPlayHead
@tags{Audio}
*/
class JUCE_API AudioPlayHead
{

2
modules/juce_audio_basics/buffers/juce_AudioChannelSet.h
View file

@ -40,6 +40,8 @@ namespace juce
as an indication to the actual layout of the speakers.
@see Bus
@tags{Audio}
*/
class JUCE_API AudioChannelSet
{

4
modules/juce_audio_basics/buffers/juce_AudioDataConverters.h
View file

@ -29,6 +29,8 @@ namespace juce
audio sample format class.
@see AudioData::Pointer.
@tags{Audio}
*/
class JUCE_API AudioData
{
@ -648,6 +650,8 @@ public:
Note that these functions are deprecated - the AudioData class provides a much more
flexible set of conversion classes now.
@tags{Audio}
*/
class JUCE_API AudioDataConverters
{

2
modules/juce_audio_basics/buffers/juce_AudioSampleBuffer.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
A multi-channel buffer containing floating point audio samples.
@tags{Audio}
*/
template <typename Type>
class AudioBuffer

4
modules/juce_audio_basics/buffers/juce_FloatVectorOperations.h
View file

@ -36,6 +36,8 @@ class ScopedNoDenormals;
/**
A collection of simple vector operations on arrays of floats, accelerated with
SIMD instructions where possible.
@tags{Audio}
*/
class JUCE_API FloatVectorOperations
{
@ -237,6 +239,8 @@ private:
/**
Helper class providing an RAII-based mechanism for temporarily disabling
denormals on your CPU.
@tags{Audio}
*/
class ScopedNoDenormals
{

2
modules/juce_audio_basics/effects/juce_CatmullRomInterpolator.h
View file

@ -33,6 +33,8 @@ namespace juce
object.
@see LagrangeInterpolator
@tags{Audio}
*/
class JUCE_API CatmullRomInterpolator
{

2
modules/juce_audio_basics/effects/juce_Decibels.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
This class contains some helpful static methods for dealing with decibel values.
@tags{Audio}
*/
class Decibels
{

4
modules/juce_audio_basics/effects/juce_IIRFilter.h
View file

@ -30,6 +30,8 @@ class IIRFilter;
A set of coefficients for use in an IIRFilter object.
@see IIRFilter
@tags{Audio}
*/
class JUCE_API IIRCoefficients
{
@ -148,6 +150,8 @@ public:
audio signal.
@see IIRCoefficient, IIRFilterAudioSource
@tags{Audio}
*/
class JUCE_API IIRFilter
{

2
modules/juce_audio_basics/effects/juce_LagrangeInterpolator.h
View file

@ -33,6 +33,8 @@ namespace juce
object.
@see CatmullRomInterpolator
@tags{Audio}
*/
class JUCE_API LagrangeInterpolator
{

4
modules/juce_audio_basics/effects/juce_LinearSmoothedValue.h
View file

@ -27,9 +27,9 @@ namespace juce
/**
Utility class for linearly smoothed values like volume etc. that should
not change abruptly but as a linear ramp, to avoid audio glitches.
*/
//==============================================================================
@tags{Audio}
*/
template <typename FloatType>
class LinearSmoothedValue
{

2
modules/juce_audio_basics/effects/juce_Reverb.h
View file

@ -32,6 +32,8 @@ namespace juce
apply the reverb to your audio data.
@see ReverbAudioSource
@tags{Audio}
*/
class Reverb
{

2
modules/juce_audio_basics/midi/juce_MidiBuffer.h
View file

@ -36,6 +36,8 @@ namespace juce
midi data.
@see MidiMessage
@tags{Audio}
*/
class JUCE_API MidiBuffer
{

2
modules/juce_audio_basics/midi/juce_MidiFile.h
View file

@ -35,6 +35,8 @@ namespace juce
it out.
@see MidiMessageSequence
@tags{Audio}
*/
class JUCE_API MidiFile
{

4
modules/juce_audio_basics/midi/juce_MidiKeyboardState.h
View file

@ -31,6 +31,8 @@ class MidiKeyboardState;
Receives events from a MidiKeyboardState object.
@see MidiKeyboardState
@tags{Audio}
*/
class JUCE_API MidiKeyboardStateListener
{
@ -78,6 +80,8 @@ public:
It also allows key up/down events to be triggered with its noteOn() and noteOff()
methods, and midi messages for these events will be merged into the
midi stream that gets processed by processNextMidiBuffer().
@tags{Audio}
*/
class JUCE_API MidiKeyboardState
{

2
modules/juce_audio_basics/midi/juce_MidiMessage.h
View file

@ -28,6 +28,8 @@ namespace juce
Encapsulates a MIDI message.
@see MidiMessageSequence, MidiOutput, MidiInput
@tags{Audio}
*/
class JUCE_API MidiMessage
{

2
modules/juce_audio_basics/midi/juce_MidiMessageSequence.h
View file

@ -31,6 +31,8 @@ namespace juce
written to a standard midi file.
@see MidiMessage, MidiFile
@tags{Audio}
*/
class JUCE_API MidiMessageSequence
{

6
modules/juce_audio_basics/midi/juce_MidiRPN.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/** Represents a MIDI RPN (registered parameter number) or NRPN (non-registered
parameter number) message.
@tags{Audio}
*/
struct MidiRPNMessage
{
@ -59,6 +61,8 @@ struct MidiRPNMessage
LSB/MSB can be sent/received in either order and must both come before the
parameter value; for the parameter value, LSB always has to be sent/received
before the value MSB, otherwise it will be treated as 7-bit (MSB only).
@tags{Audio}
*/
class JUCE_API MidiRPNDetector
{
@ -113,6 +117,8 @@ private:
or NRPN message.
This sequence (as a MidiBuffer) can then be directly sent to a MidiOutput.
@tags{Audio}
*/
class JUCE_API MidiRPNGenerator
{

2
modules/juce_audio_basics/mpe/juce_MPEInstrument.h
View file

@ -49,6 +49,8 @@ namespace juce
the ability to render audio and to manage voices.
@see MPENote, MPEZoneLayout, MPESynthesiser
@tags{Audio}
*/
class JUCE_API MPEInstrument
{

2
modules/juce_audio_basics/mpe/juce_MPEMessages.h
View file

@ -42,6 +42,8 @@ namespace juce
MIDI zone layout of your C++ code and of the MPE device are kept in sync.
@see MidiMessage, MPEZoneLayout
@tags{Audio}
*/
class JUCE_API MPEMessages
{

2
modules/juce_audio_basics/mpe/juce_MPENote.h
View file

@ -33,6 +33,8 @@ namespace juce
MPEValue objects.
@see MPEValue
@tags{Audio}
*/
struct JUCE_API MPENote
{

2
modules/juce_audio_basics/mpe/juce_MPESynthesiser.h
View file

@ -48,6 +48,8 @@ namespace juce
they can pitch their output correctly.
@see MPESynthesiserBase, MPESynthesiserVoice, MPENote, MPEInstrument
@tags{Audio}
*/
class JUCE_API MPESynthesiser : public MPESynthesiserBase
{

2
modules/juce_audio_basics/mpe/juce_MPESynthesiserBase.h
View file

@ -40,6 +40,8 @@ namespace juce
a voice stealing algorithm, and much more.
@see MPESynthesiser, MPEInstrument
@tags{Audio}
*/
struct JUCE_API MPESynthesiserBase : public MPEInstrument::Listener
{

4
modules/juce_audio_basics/mpe/juce_MPESynthesiserVoice.h
View file

@ -31,7 +31,9 @@ namespace juce
voices so that it can play polyphonically.
@see MPESynthesiser, MPENote
*/
@tags{Audio}
*/
class JUCE_API MPESynthesiserVoice
{
public:

4
modules/juce_audio_basics/mpe/juce_MPEUtils.h
View file

@ -31,6 +31,8 @@ namespace juce
To use it, create an instance passing in the MPE zone that it should operate on
and then call use the findMidiChannelForNewNote() method for all note-on messages
and the noteOff() method for all note-off messages.
@tags{Audio}
*/
class MPEChannelAssigner
{
@ -91,6 +93,8 @@ private:
/**
This class handles the logic for remapping MIDI note messages from multiple MPE
sources onto a specified MPE zone.
@tags{Audio}
*/
class MPEChannelRemapper
{

2
modules/juce_audio_basics/mpe/juce_MPEValue.h
View file

@ -30,6 +30,8 @@ namespace juce
(corresponding to 1 or 2 MIDI bytes, respectively). It also offers helper
functions to query the value in a variety of representations that can be
useful in an audio or MIDI context.
@tags{Audio}
*/
class JUCE_API MPEValue
{

2
modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h
View file

@ -38,6 +38,8 @@ namespace juce
MIDI device to set its zone layout, add zones etc.
@see MPEInstrument
@tags{Audio}
*/
class JUCE_API MPEZoneLayout
{

2
modules/juce_audio_basics/native/juce_mac_CoreAudioLayouts.h
View file

@ -23,7 +23,7 @@
namespace juce
{
#if JUCE_MAC || JUCE_IOS
#if JUCE_MAC || JUCE_IOS && ! DOXYGEN
struct CoreAudioLayouts
{

4
modules/juce_audio_basics/sources/juce_AudioSource.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
Used by AudioSource::getNextAudioBlock().
@tags{Audio}
*/
struct JUCE_API AudioSourceChannelInfo
{
@ -103,6 +105,8 @@ struct JUCE_API AudioSourceChannelInfo
back into an 'unprepared' state.
@see AudioFormatReaderSource, ResamplingAudioSource
@tags{Audio}
*/
class JUCE_API AudioSource
{

2
modules/juce_audio_basics/sources/juce_BufferingAudioSource.h
View file

@ -32,6 +32,8 @@ namespace juce
directly, or use it indirectly using an AudioTransportSource.
@see PositionableAudioSource, AudioTransportSource
@tags{Audio}
*/
class JUCE_API BufferingAudioSource : public PositionableAudioSource,
private TimeSliceClient

2
modules/juce_audio_basics/sources/juce_ChannelRemappingAudioSource.h
View file

@ -37,6 +37,8 @@ namespace juce
it'll produce silence.
@see AudioSource
@tags{Audio}
*/
class ChannelRemappingAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_IIRFilterAudioSource.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
An AudioSource that performs an IIR filter on another source.
@tags{Audio}
*/
class JUCE_API IIRFilterAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_MemoryAudioSource.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
An AudioSource which takes some float audio data as an input.
@tags{Audio}
*/
class JUCE_API MemoryAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_MixerAudioSource.h
View file

@ -30,6 +30,8 @@ namespace juce
Input sources can be added and removed while the mixer is running as long as their
prepareToPlay() and releaseResources() methods are called before and after adding
them to the mixer.
@tags{Audio}
*/
class JUCE_API MixerAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_PositionableAudioSource.h
View file

@ -32,6 +32,8 @@ namespace juce
that has a current read position.
@see AudioSource, AudioTransportSource
@tags{Audio}
*/
class JUCE_API PositionableAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_ResamplingAudioSource.h
View file

@ -28,6 +28,8 @@ namespace juce
A type of AudioSource that takes an input source and changes its sample rate.
@see AudioSource, LagrangeInterpolator, CatmullRomInterpolator
@tags{Audio}
*/
class JUCE_API ResamplingAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_ReverbAudioSource.h
View file

@ -28,6 +28,8 @@ namespace juce
An AudioSource that uses the Reverb class to apply a reverb to another AudioSource.
@see Reverb
@tags{Audio}
*/
class JUCE_API ReverbAudioSource : public AudioSource
{

2
modules/juce_audio_basics/sources/juce_ToneGeneratorAudioSource.h
View file

@ -27,6 +27,8 @@ namespace juce
/**
A simple AudioSource that generates a sine wave.
@tags{Audio}
*/
class JUCE_API ToneGeneratorAudioSource : public AudioSource
{

6
modules/juce_audio_basics/synthesisers/juce_Synthesiser.h
View file

@ -35,6 +35,8 @@ namespace juce
more than one SynthesiserVoice to play the same sound at the same time.
@see Synthesiser, SynthesiserVoice
@tags{Audio}
*/
class JUCE_API SynthesiserSound : public ReferenceCountedObject
{
@ -79,6 +81,8 @@ private:
voices so that it can play polyphonically.
@see Synthesiser, SynthesiserSound
@tags{Audio}
*/
class JUCE_API SynthesiserVoice
{
@ -302,6 +306,8 @@ private:
Before rendering, be sure to call the setCurrentPlaybackSampleRate() to tell it
what the target playback rate is. This value is passed on to the voices so that
they can pitch their output correctly.
@tags{Audio}
*/
class JUCE_API Synthesiser
{

2
modules/juce_audio_devices/audio_io/juce_AudioDeviceManager.h
View file

@ -60,6 +60,8 @@ namespace juce
listeners whenever one of its settings is changed.
@see AudioDeviceSelectorComponent, AudioIODevice, AudioIODeviceType
@tags{Audio}
*/
class JUCE_API AudioDeviceManager : public ChangeBroadcaster
{

4
modules/juce_audio_devices/audio_io/juce_AudioIODevice.h
View file

@ -36,6 +36,8 @@ class AudioIODevice;
the next block of data.
@see AudioIODevice, AudioDeviceManager
@tags{Audio}
*/
class JUCE_API AudioIODeviceCallback
{
@ -128,6 +130,8 @@ public:
AudioDeviceManager class.
@see AudioIODeviceType, AudioDeviceManager
@tags{Audio}
*/
class JUCE_API AudioIODevice
{

2
modules/juce_audio_devices/audio_io/juce_AudioIODeviceType.h
View file

@ -55,6 +55,8 @@ namespace juce
AudioDeviceManager class.
@see AudioIODevice, AudioDeviceManager
@tags{Audio}
*/
class JUCE_API AudioIODeviceType
{

2
modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h
View file

@ -26,6 +26,8 @@ namespace juce
//==============================================================================
/**
Contains functions to control the system's master volume.
@tags{Audio}
*/
class JUCE_API SystemAudioVolume
{

4
modules/juce_audio_devices/midi_io/juce_MidiInput.h
View file

@ -34,6 +34,8 @@ class MidiInput;
class for more details.
@see MidiInput
@tags{Audio}
*/
class JUCE_API MidiInputCallback
{
@ -84,6 +86,8 @@ public:
available, and then use the openDevice() method to try to open one.
@see MidiOutput
@tags{Audio}
*/
class JUCE_API MidiInput
{

2
modules/juce_audio_devices/midi_io/juce_MidiMessageCollector.h
View file

@ -32,6 +32,8 @@ namespace juce
so it can easily use a midi input or keyboard component as its source.
@see MidiMessage, MidiInput
@tags{Audio}
*/
class JUCE_API MidiMessageCollector : public MidiKeyboardStateListener,
public MidiInputCallback

2
modules/juce_audio_devices/midi_io/juce_MidiOutput.h
View file

@ -31,6 +31,8 @@ namespace juce
available output devices, then use the openDevice() method to try to open one.
@see MidiInput
@tags{Audio}
*/
class JUCE_API MidiOutput : private Thread
{

2
modules/juce_audio_devices/native/juce_MidiDataConcatenator.h
View file

@ -27,6 +27,8 @@ namespace juce
/**
Helper class that takes chunks of incoming midi bytes, packages them into
messages, and dispatches them to a midi callback.
@tags{Audio}
*/
class MidiDataConcatenator
{

2
modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h
View file

@ -30,6 +30,8 @@ namespace juce
This object acts as an AudioIODeviceCallback, so can be attached to an
output device, and will stream audio from an AudioSource.
@tags{Audio}
*/
class JUCE_API AudioSourcePlayer : public AudioIODeviceCallback
{

2
modules/juce_audio_devices/sources/juce_AudioTransportSource.h
View file

@ -35,6 +35,8 @@ namespace juce
to control playback of an audio file.
@see AudioSource, AudioSourcePlayer
@tags{Audio}
*/
class JUCE_API AudioTransportSource : public PositionableAudioSource,
public ChangeBroadcaster

2
modules/juce_audio_formats/codecs/juce_AiffAudioFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
Reads and Writes AIFF format audio files.
@see AudioFormat
@tags{Audio}
*/
class JUCE_API AiffAudioFormat : public AudioFormat
{

4
modules/juce_audio_formats/codecs/juce_CoreAudioFormat.h
View file

@ -37,7 +37,9 @@ namespace juce
This should be able to understand formats such as mp3, m4a, etc.
@see AudioFormat
*/
@tags{Audio}
*/
class JUCE_API CoreAudioFormat : public AudioFormat
{
public:

2
modules/juce_audio_formats/codecs/juce_FlacAudioFormat.h
View file

@ -36,6 +36,8 @@ namespace juce
To compile this, you'll need to set the JUCE_USE_FLAC flag.
@see AudioFormat
@tags{Audio}
*/
class JUCE_API FlacAudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/codecs/juce_LAMEEncoderAudioFormat.h
View file

@ -42,6 +42,8 @@ namespace juce
the writer.
@see AudioFormat
@tags{Audio}
*/
class JUCE_API LAMEEncoderAudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/codecs/juce_MP3AudioFormat.h
View file

@ -42,6 +42,8 @@ namespace juce
intellectual property. If you wish to use it, please seek your own independent advice about the
legality of doing so. If you are not willing to accept full responsibility for the consequences
of using this code, then do not enable the JUCE_USE_MP3AUDIOFORMAT setting.
@tags{Audio}
*/
class MP3AudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/codecs/juce_OggVorbisAudioFormat.h
View file

@ -36,6 +36,8 @@ namespace juce
To compile this, you'll need to set the JUCE_USE_OGGVORBIS flag.
@see AudioFormat,
@tags{Audio}
*/
class JUCE_API OggVorbisAudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/codecs/juce_WavAudioFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
Reads and Writes WAV format audio files.
@see AudioFormat
@tags{Audio}
*/
class JUCE_API WavAudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/codecs/juce_WindowsMediaAudioFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
//==============================================================================
/**
Audio format which uses the Windows Media codecs (Windows only).
@tags{Audio}
*/
class WindowsMediaAudioFormat : public AudioFormat
{

2
modules/juce_audio_formats/format/juce_AudioFormat.h
View file

@ -33,6 +33,8 @@ namespace juce
file formats.
@see AudioFormatReader, AudioFormatWriter, WavAudioFormat, AiffAudioFormat
@tags{Audio}
*/
class JUCE_API AudioFormat
{

2
modules/juce_audio_formats/format/juce_AudioFormatManager.h
View file

@ -36,6 +36,8 @@ namespace juce
or registerBasicFormats() to give it a list of format types that it can use.
@see AudioFormat
@tags{Audio}
*/
class JUCE_API AudioFormatManager
{

2
modules/juce_audio_formats/format/juce_AudioFormatReader.h
View file

@ -38,6 +38,8 @@ class AudioFormat;
an AudioFormat object.
@see AudioFormat, AudioFormatWriter
@tags{Audio}
*/
class JUCE_API AudioFormatReader
{

2
modules/juce_audio_formats/format/juce_AudioFormatReaderSource.h
View file

@ -32,6 +32,8 @@ namespace juce
A type of AudioSource that will read from an AudioFormatReader.
@see PositionableAudioSource, AudioTransportSource, BufferingAudioSource
@tags{Audio}
*/
class JUCE_API AudioFormatReaderSource : public PositionableAudioSource
{

7
modules/juce_audio_formats/format/juce_AudioFormatWriter.h
View file

@ -38,6 +38,8 @@ namespace juce
you can call its write() method to store the samples, and then delete it.
@see AudioFormat, AudioFormatReader
@tags{Audio}
*/
class JUCE_API AudioFormatWriter
{
@ -210,6 +212,7 @@ public:
*/
bool write (const float* const* data, int numSamples);
/** Receiver for incoming data. */
class JUCE_API IncomingDataReceiver
{
public:
@ -223,8 +226,8 @@ public:
/** Allows you to specify a callback that this writer should update with the
incoming data.
The receiver will be cleared and will the writer will begin adding data to
it as the data arrives. Pass a null pointer to remove the current receiver.
The receiver will be cleared and the writer will begin adding data to it
as the data arrives. Pass a null pointer to remove the current receiver.
The object passed-in must not be deleted while this writer is still using it.
*/

2
modules/juce_audio_formats/format/juce_AudioSubsectionReader.h
View file

@ -39,6 +39,8 @@ namespace juce
be at a non-zero position.
@see AudioFormatReader
@tags{Audio}
*/
class JUCE_API AudioSubsectionReader : public AudioFormatReader
{

2
modules/juce_audio_formats/format/juce_BufferingAudioFormatReader.h
View file

@ -33,6 +33,8 @@ namespace juce
another reader.
@see AudioFormatReader
@tags{Audio}
*/
class JUCE_API BufferingAudioReader : public AudioFormatReader,
private TimeSliceClient

2
modules/juce_audio_formats/format/juce_MemoryMappedAudioFormatReader.h
View file

@ -41,6 +41,8 @@ namespace juce
read has been mapped.
@see AudioFormat::createMemoryMappedReader, AudioFormatReader
@tags{Audio}
*/
class JUCE_API MemoryMappedAudioFormatReader : public AudioFormatReader
{

4
modules/juce_audio_formats/sampler/juce_Sampler.h
View file

@ -38,6 +38,8 @@ namespace juce
give it some SampledSound objects to play.
@see SamplerVoice, Synthesiser, SynthesiserSound
@tags{Audio}
*/
class JUCE_API SamplerSound : public SynthesiserSound
{
@ -110,6 +112,8 @@ private:
give it some SampledSound objects to play.
@see SamplerSound, Synthesiser, SynthesiserVoice
@tags{Audio}
*/
class JUCE_API SamplerVoice : public SynthesiserVoice
{

4
modules/juce_audio_plugin_client/AAX/juce_AAX_Modifier_Injector.h
View file

@ -27,6 +27,8 @@
namespace juce
{
#ifndef DOXYGEN
struct ModifierKeyProvider
{
virtual ~ModifierKeyProvider() {}
@ -40,4 +42,6 @@ struct ModifierKeyReceiver
virtual void removeModifierKeyProvider() = 0;
};
#endif
} // namespace juce

5
modules/juce_audio_plugin_client/Standalone/juce_StandaloneFilterWindow.h
View file

@ -38,12 +38,15 @@ namespace juce
The object will create your processor using the same createPluginFilter()
function that the other plugin wrappers use, and will run it through the
computer's audio/MIDI devices using AudioDeviceManager and AudioProcessorPlayer.
@tags{Audio}
*/
class StandalonePluginHolder : private AudioIODeviceCallback,
private Timer
{
public:
//==============================================================================
/** Structure used for the number of inputs and outputs. */
struct PluginInOuts { short numIns, numOuts; };
//==============================================================================
@ -558,6 +561,8 @@ private:
Just create one of these objects in your JUCEApplicationBase::initialise() method, and
let it do its work. It will create your filter object using the same createPluginFilter() function
that the other plugin wrappers use.
@tags{Audio}
*/
class StandaloneFilterWindow : public DocumentWindow,
public Button::Listener

2
modules/juce_audio_plugin_client/VST/juce_VSTCallbackHandler.h
View file

@ -29,6 +29,8 @@ namespace juce
/** An interface to allow an AudioProcessor to receive VST specific calls from
the host.
@tags{Audio}
*/
struct VSTCallbackHandler
{

4
modules/juce_audio_plugin_client/utility/juce_FakeMouseMoveGenerator.h
View file

@ -27,6 +27,8 @@
namespace juce
{
#ifndef DOXYGEN
#if JUCE_MAC
//==============================================================================
@ -90,4 +92,6 @@ private:
struct FakeMouseMoveGenerator {};
#endif
#endif
} // namespace juce

2
modules/juce_audio_plugin_client/utility/juce_PluginHostType.h
View file

@ -33,6 +33,8 @@ namespace juce
loaded.
Declare a PluginHostType object in your class to use it.
@tags{Audio}
*/
class PluginHostType
{

3
modules/juce_audio_processors/format/juce_AudioPluginFormat.h
View file

@ -32,11 +32,14 @@ namespace juce
The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc.
@see AudioPluginFormatManager
@tags{Audio}
*/
class JUCE_API AudioPluginFormat
{
public:
//==============================================================================
/** Structure used for callbacks when instantiation is completed. */
struct JUCE_API InstantiationCompletionCallback
{
virtual ~InstantiationCompletionCallback() {}

2
modules/juce_audio_processors/format/juce_AudioPluginFormatManager.h
View file

@ -32,6 +32,8 @@ namespace juce
This maintains a list of known AudioPluginFormats.
@see AudioPluginFormat
@tags{Audio}
*/
class JUCE_API AudioPluginFormatManager
{

4
modules/juce_audio_processors/format_types/juce_AU_Shared.h
View file

@ -32,6 +32,8 @@
namespace juce
{
#ifndef DOXYGEN
struct AudioUnitHelpers
{
class ChannelRemapper
@ -530,4 +532,6 @@ struct AudioUnitHelpers
}
};
#endif // ! DOXYGEN
} // namespace juce

2
modules/juce_audio_processors/format_types/juce_AudioUnitPluginFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
//==============================================================================
/**
Implements a plugin format manager for AudioUnits.
@tags{Audio}
*/
class JUCE_API AudioUnitPluginFormat : public AudioPluginFormat
{

2
modules/juce_audio_processors/format_types/juce_LADSPAPluginFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
//==============================================================================
/**
Implements a plugin format manager for LADSPA plugins.
@tags{Audio}
*/
class JUCE_API LADSPAPluginFormat : public AudioPluginFormat
{

2
modules/juce_audio_processors/format_types/juce_VST3PluginFormat.h
View file

@ -31,6 +31,8 @@ namespace juce
/**
Implements a plugin format for VST3s.
@tags{Audio}
*/
class JUCE_API VST3PluginFormat : public AudioPluginFormat
{

6
modules/juce_audio_processors/format_types/juce_VSTCommon.h
View file

@ -28,8 +28,13 @@ namespace juce
{
//==============================================================================
/** Structure for VST speaker mappings
@tags{Audio}
*/
struct SpeakerMappings : private AudioChannelSet // (inheritance only to give easier access to items in the namespace)
{
/** Structure describing a mapping */
struct Mapping
{
int32 vst2;
@ -125,6 +130,7 @@ struct SpeakerMappings : private AudioChannelSet // (inheritance only to give e
return vstSpeakerConfigTypeUser;
}
/** Class to hold a speaker configuration */
class VstSpeakerConfigurationHolder
{
public:

44
modules/juce_audio_processors/format_types/juce_VSTInterface.h
View file

@ -48,6 +48,10 @@ const int32 juceVstInterfaceVersion = 2400;
const int32 juceVstInterfaceIdentifier = 0x56737450; // The "magic" identifier in the SDK is 'VstP'.
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstEffectInterface
{
int32 interfaceIdentifier;
@ -221,6 +225,10 @@ enum VstPlugInCategory
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstEditorBounds
{
int16 upper;
@ -241,6 +249,10 @@ enum VstMaxStringLengths
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstPinInfo
{
char text[vstMaxParameterOrPinLabelLength];
@ -258,6 +270,10 @@ enum VstPinInfoFlags
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstEvent
{
int32 type;
@ -273,6 +289,10 @@ enum VstEventTypes
vstSysExEventType = 6
};
/** Structure used for VSTs
@tags{Audio}
*/
struct VstEventBlock
{
int32 numberOfEvents;
@ -280,6 +300,10 @@ struct VstEventBlock
VstEvent* events[2];
};
/** Structure used for VSTs
@tags{Audio}
*/
struct VstMidiEvent
{
int32 type;
@ -300,6 +324,10 @@ enum VstMidiEventFlags
vstMidiEventIsRealtime = 1
};
/** Structure used for VSTs
@tags{Audio}
*/
struct VstSysExEvent
{
int32 type;
@ -313,6 +341,10 @@ struct VstSysExEvent
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstTimingInformation
{
double samplePosition;
@ -369,6 +401,10 @@ enum VstSmpteRates
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct VstIndividualSpeakerInfo
{
float azimuthalAngle;
@ -406,6 +442,10 @@ enum VstIndividualSpeakerType
vstIndividualSpeakerTypeLFE2
};
/** Structure used for VSTs
@tags{Audio}
*/
struct VstSpeakerConfiguration
{
int32 type;
@ -461,6 +501,10 @@ enum PresonusExtensionConstants
};
//==============================================================================
/** Structure used for VSTs
@tags{Audio}
*/
struct vst2FxBank
{
int32 magic1;

2
modules/juce_audio_processors/format_types/juce_VSTMidiEventList.h
View file

@ -35,6 +35,8 @@ namespace juce
events to the list.
This is used by both the VST hosting code and the plugin wrapper.
@tags{Audio}
*/
class VSTMidiEventList
{

2
modules/juce_audio_processors/format_types/juce_VSTPluginFormat.h
View file

@ -32,6 +32,8 @@ namespace juce
//==============================================================================
/**
Implements a plugin format manager for VSTs.
@tags{Audio}
*/
class JUCE_API VSTPluginFormat : public AudioPluginFormat
{

3
modules/juce_audio_processors/processors/juce_AudioPluginInstance.h
View file

@ -39,6 +39,8 @@ namespace juce
return AudioPluginInstance objects which wrap external plugins.
@see AudioProcessor, AudioPluginFormat
@tags{Audio}
*/
class JUCE_API AudioPluginInstance : public AudioProcessor
{
@ -96,6 +98,7 @@ public:
protected:
//==============================================================================
/** Structure used to describe plugin parameters */
struct Parameter : public AudioProcessorParameter
{
Parameter();

3
modules/juce_audio_processors/processors/juce_AudioProcessor.h
View file

@ -40,6 +40,8 @@ namespace juce
You should derive your own class from this base class, and if you're building a
plugin, you should implement a global function called createPluginFilter() which
creates and returns a new instance of your subclass.
@tags{Audio}
*/
class JUCE_API AudioProcessor
{
@ -1480,6 +1482,7 @@ protected:
bool isActivatedByDefault;
};
/** Structure used for AudioProcessor Callbacks */
struct BusesProperties
{
/** The layouts of the input buses */

2
modules/juce_audio_processors/processors/juce_AudioProcessorEditor.h
View file

@ -38,6 +38,8 @@ class AudioProcessorEditorListener;
by overriding the AudioProcessor::createEditor() method.
@see AudioProcessor, GenericAudioProcessorEditor
@tags{Audio}
*/
class JUCE_API AudioProcessorEditor : public Component
{

2
modules/juce_audio_processors/processors/juce_AudioProcessorGraph.h
View file

@ -40,6 +40,8 @@ namespace juce
To play back a graph through an audio device, you might want to use an
AudioProcessorPlayer object.
@tags{Audio}
*/
class JUCE_API AudioProcessorGraph : public AudioProcessor,
public ChangeBroadcaster,

2
modules/juce_audio_processors/processors/juce_AudioProcessorListener.h
View file

@ -34,6 +34,8 @@ namespace juce
Use AudioProcessor::addListener() to register your listener with an AudioProcessor.
@see AudioProcessor
@tags{Audio}
*/
class JUCE_API AudioProcessorListener
{

2
modules/juce_audio_processors/processors/juce_AudioProcessorParameter.h
View file

@ -32,6 +32,8 @@ namespace juce
AudioProcessor.
@see AudioProcessor::addParameter
@tags{Audio}
*/
class JUCE_API AudioProcessorParameter
{

2
modules/juce_audio_processors/processors/juce_GenericAudioProcessorEditor.h
View file

@ -36,6 +36,8 @@ namespace juce
its own custom editor.
@see AudioProcessor
@tags{Audio}
*/
class JUCE_API GenericAudioProcessorEditor : public AudioProcessorEditor
{

2
modules/juce_audio_processors/processors/juce_PluginDescription.h
View file

@ -37,6 +37,8 @@ namespace juce
A KnownPluginList contains a list of PluginDescription objects.
@see KnownPluginList
@tags{Audio}
*/
class JUCE_API PluginDescription
{

3
modules/juce_audio_processors/scanning/juce_KnownPluginList.h
View file

@ -35,6 +35,8 @@ namespace juce
the plugin types in it.
@see PluginListComponent
@tags{Audio}
*/
class JUCE_API KnownPluginList : public ChangeBroadcaster
{
@ -185,6 +187,7 @@ public:
PluginTree* createTree (const SortMethod sortMethod) const;
//==============================================================================
/** Class to define a custom plugin scanner */
class CustomScanner
{
public:

2
modules/juce_audio_processors/scanning/juce_PluginDirectoryScanner.h
View file

@ -33,6 +33,8 @@ namespace juce
To use one of these, create it and call scanNextFile() repeatedly, until
it returns false.
@tags{Audio}
*/
class JUCE_API PluginDirectoryScanner
{

2
modules/juce_audio_processors/scanning/juce_PluginListComponent.h
View file

@ -31,6 +31,8 @@ namespace juce
/**
A component displaying a list of plugins, with options to scan for them,
add, remove and sort them.
@tags{Audio}
*/
class JUCE_API PluginListComponent : public Component,
public FileDragAndDropTarget,

2
modules/juce_audio_processors/utilities/juce_AudioParameterBool.h
View file

@ -31,6 +31,8 @@ namespace juce
Provides a class of AudioProcessorParameter that can be used as a boolean value.
@see AudioParameterFloat, AudioParameterInt, AudioParameterChoice
@tags{Audio}
*/
class JUCE_API AudioParameterBool : public AudioProcessorParameterWithID
{

2
modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h
View file

@ -32,6 +32,8 @@ namespace juce
an indexed, named choice from a list.
@see AudioParameterFloat, AudioParameterInt, AudioParameterBool
@tags{Audio}
*/
class JUCE_API AudioParameterChoice : public AudioProcessorParameterWithID
{

2
modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h
View file

@ -32,6 +32,8 @@ namespace juce
parameter which maps onto a given NormalisableRange.
@see AudioParameterInt, AudioParameterBool, AudioParameterChoice
@tags{Audio}
*/
class JUCE_API AudioParameterFloat : public AudioProcessorParameterWithID
{

2
modules/juce_audio_processors/utilities/juce_AudioParameterInt.h
View file

@ -32,6 +32,8 @@ namespace juce
integer value with a given range.
@see AudioParameterFloat, AudioParameterBool, AudioParameterChoice
@tags{Audio}
*/
class JUCE_API AudioParameterInt : public AudioProcessorParameterWithID
{

2
modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h
View file

@ -31,6 +31,8 @@ namespace juce
This abstract base class is used by some AudioProcessorParameter helper classes.
@see AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice
@tags{Audio}
*/
class JUCE_API AudioProcessorParameterWithID : public AudioProcessorParameter
{

Some files were not shown because too many files have changed in this diff Show more