| @@ -36,6 +36,8 @@ namespace juce | |||||
| @see AnalyticsDestination, ThreadedAnalyticsDestination, | @see AnalyticsDestination, ThreadedAnalyticsDestination, | ||||
| AnalyticsDestination::AnalyticsEvent | AnalyticsDestination::AnalyticsEvent | ||||
| @tags{Analytics} | |||||
| */ | */ | ||||
| class JUCE_API Analytics : public DeletedAtShutdown | class JUCE_API Analytics : public DeletedAtShutdown | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| when a button is clicked. | when a button is clicked. | ||||
| @see Analytics, AnalyticsDestination::AnalyticsEvent | @see Analytics, AnalyticsDestination::AnalyticsEvent | ||||
| @tags{Analytics} | |||||
| */ | */ | ||||
| class JUCE_API ButtonTracker : private Button::Listener | class JUCE_API ButtonTracker : private Button::Listener | ||||
| { | { | ||||
| @@ -39,6 +39,8 @@ namespace juce | |||||
| with web servers and other time consuming destinations. | with web servers and other time consuming destinations. | ||||
| @see Analytics, ThreadedAnalyticsDestination | @see Analytics, ThreadedAnalyticsDestination | ||||
| @tags{Analytics} | |||||
| */ | */ | ||||
| struct JUCE_API AnalyticsDestination | struct JUCE_API AnalyticsDestination | ||||
| { | { | ||||
| @@ -47,6 +47,8 @@ namespace juce | |||||
| you should use to terminate the currently running logBatchedEvents call. | you should use to terminate the currently running logBatchedEvents call. | ||||
| @see Analytics, AnalyticsDestination, AnalyticsDestination::AnalyticsEvent | @see Analytics, AnalyticsDestination, AnalyticsDestination::AnalyticsEvent | ||||
| @tags{Analytics} | |||||
| */ | */ | ||||
| class JUCE_API ThreadedAnalyticsDestination : public AnalyticsDestination | class JUCE_API ThreadedAnalyticsDestination : public AnalyticsDestination | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| out about the position of the audio that it is rendering. | out about the position of the audio that it is rendering. | ||||
| @see AudioProcessor::setPlayHead, AudioProcessor::getPlayHead | @see AudioProcessor::setPlayHead, AudioProcessor::getPlayHead | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioPlayHead | class JUCE_API AudioPlayHead | ||||
| { | { | ||||
| @@ -40,6 +40,8 @@ namespace juce | |||||
| as an indication to the actual layout of the speakers. | as an indication to the actual layout of the speakers. | ||||
| @see Bus | @see Bus | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioChannelSet | class JUCE_API AudioChannelSet | ||||
| { | { | ||||
| @@ -29,6 +29,8 @@ namespace juce | |||||
| audio sample format class. | audio sample format class. | ||||
| @see AudioData::Pointer. | @see AudioData::Pointer. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioData | class JUCE_API AudioData | ||||
| { | { | ||||
| @@ -648,6 +650,8 @@ public: | |||||
| Note that these functions are deprecated - the AudioData class provides a much more | Note that these functions are deprecated - the AudioData class provides a much more | ||||
| flexible set of conversion classes now. | flexible set of conversion classes now. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioDataConverters | class JUCE_API AudioDataConverters | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| A multi-channel buffer containing floating point audio samples. | A multi-channel buffer containing floating point audio samples. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| template <typename Type> | template <typename Type> | ||||
| class AudioBuffer | class AudioBuffer | ||||
| @@ -36,6 +36,8 @@ class ScopedNoDenormals; | |||||
| /** | /** | ||||
| A collection of simple vector operations on arrays of floats, accelerated with | A collection of simple vector operations on arrays of floats, accelerated with | ||||
| SIMD instructions where possible. | SIMD instructions where possible. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API FloatVectorOperations | class JUCE_API FloatVectorOperations | ||||
| { | { | ||||
| @@ -237,6 +239,8 @@ private: | |||||
| /** | /** | ||||
| Helper class providing an RAII-based mechanism for temporarily disabling | Helper class providing an RAII-based mechanism for temporarily disabling | ||||
| denormals on your CPU. | denormals on your CPU. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class ScopedNoDenormals | class ScopedNoDenormals | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| object. | object. | ||||
| @see LagrangeInterpolator | @see LagrangeInterpolator | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API CatmullRomInterpolator | class JUCE_API CatmullRomInterpolator | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| This class contains some helpful static methods for dealing with decibel values. | This class contains some helpful static methods for dealing with decibel values. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class Decibels | class Decibels | ||||
| { | { | ||||
| @@ -30,6 +30,8 @@ class IIRFilter; | |||||
| A set of coefficients for use in an IIRFilter object. | A set of coefficients for use in an IIRFilter object. | ||||
| @see IIRFilter | @see IIRFilter | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API IIRCoefficients | class JUCE_API IIRCoefficients | ||||
| { | { | ||||
| @@ -148,6 +150,8 @@ public: | |||||
| audio signal. | audio signal. | ||||
| @see IIRCoefficient, IIRFilterAudioSource | @see IIRCoefficient, IIRFilterAudioSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API IIRFilter | class JUCE_API IIRFilter | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| object. | object. | ||||
| @see CatmullRomInterpolator | @see CatmullRomInterpolator | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API LagrangeInterpolator | class JUCE_API LagrangeInterpolator | ||||
| { | { | ||||
| @@ -27,9 +27,9 @@ namespace juce | |||||
| /** | /** | ||||
| Utility class for linearly smoothed values like volume etc. that should | Utility class for linearly smoothed values like volume etc. that should | ||||
| not change abruptly but as a linear ramp, to avoid audio glitches. | not change abruptly but as a linear ramp, to avoid audio glitches. | ||||
| */ | |||||
| //============================================================================== | |||||
| @tags{Audio} | |||||
| */ | |||||
| template <typename FloatType> | template <typename FloatType> | ||||
| class LinearSmoothedValue | class LinearSmoothedValue | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| apply the reverb to your audio data. | apply the reverb to your audio data. | ||||
| @see ReverbAudioSource | @see ReverbAudioSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class Reverb | class Reverb | ||||
| { | { | ||||
| @@ -36,6 +36,8 @@ namespace juce | |||||
| midi data. | midi data. | ||||
| @see MidiMessage | @see MidiMessage | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiBuffer | class JUCE_API MidiBuffer | ||||
| { | { | ||||
| @@ -35,6 +35,8 @@ namespace juce | |||||
| it out. | it out. | ||||
| @see MidiMessageSequence | @see MidiMessageSequence | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiFile | class JUCE_API MidiFile | ||||
| { | { | ||||
| @@ -31,6 +31,8 @@ class MidiKeyboardState; | |||||
| Receives events from a MidiKeyboardState object. | Receives events from a MidiKeyboardState object. | ||||
| @see MidiKeyboardState | @see MidiKeyboardState | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiKeyboardStateListener | class JUCE_API MidiKeyboardStateListener | ||||
| { | { | ||||
| @@ -78,6 +80,8 @@ public: | |||||
| It also allows key up/down events to be triggered with its noteOn() and noteOff() | 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 | methods, and midi messages for these events will be merged into the | ||||
| midi stream that gets processed by processNextMidiBuffer(). | midi stream that gets processed by processNextMidiBuffer(). | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiKeyboardState | class JUCE_API MidiKeyboardState | ||||
| { | { | ||||
| @@ -28,6 +28,8 @@ namespace juce | |||||
| Encapsulates a MIDI message. | Encapsulates a MIDI message. | ||||
| @see MidiMessageSequence, MidiOutput, MidiInput | @see MidiMessageSequence, MidiOutput, MidiInput | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiMessage | class JUCE_API MidiMessage | ||||
| { | { | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| written to a standard midi file. | written to a standard midi file. | ||||
| @see MidiMessage, MidiFile | @see MidiMessage, MidiFile | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiMessageSequence | class JUCE_API MidiMessageSequence | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** Represents a MIDI RPN (registered parameter number) or NRPN (non-registered | /** Represents a MIDI RPN (registered parameter number) or NRPN (non-registered | ||||
| parameter number) message. | parameter number) message. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| struct MidiRPNMessage | struct MidiRPNMessage | ||||
| { | { | ||||
| @@ -59,6 +61,8 @@ struct MidiRPNMessage | |||||
| LSB/MSB can be sent/received in either order and must both come before the | 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 | 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). | before the value MSB, otherwise it will be treated as 7-bit (MSB only). | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiRPNDetector | class JUCE_API MidiRPNDetector | ||||
| { | { | ||||
| @@ -113,6 +117,8 @@ private: | |||||
| or NRPN message. | or NRPN message. | ||||
| This sequence (as a MidiBuffer) can then be directly sent to a MidiOutput. | This sequence (as a MidiBuffer) can then be directly sent to a MidiOutput. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiRPNGenerator | class JUCE_API MidiRPNGenerator | ||||
| { | { | ||||
| @@ -49,6 +49,8 @@ namespace juce | |||||
| the ability to render audio and to manage voices. | the ability to render audio and to manage voices. | ||||
| @see MPENote, MPEZoneLayout, MPESynthesiser | @see MPENote, MPEZoneLayout, MPESynthesiser | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MPEInstrument | class JUCE_API MPEInstrument | ||||
| { | { | ||||
| @@ -42,6 +42,8 @@ namespace juce | |||||
| MIDI zone layout of your C++ code and of the MPE device are kept in sync. | MIDI zone layout of your C++ code and of the MPE device are kept in sync. | ||||
| @see MidiMessage, MPEZoneLayout | @see MidiMessage, MPEZoneLayout | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MPEMessages | class JUCE_API MPEMessages | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| MPEValue objects. | MPEValue objects. | ||||
| @see MPEValue | @see MPEValue | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| struct JUCE_API MPENote | struct JUCE_API MPENote | ||||
| { | { | ||||
| @@ -48,6 +48,8 @@ namespace juce | |||||
| they can pitch their output correctly. | they can pitch their output correctly. | ||||
| @see MPESynthesiserBase, MPESynthesiserVoice, MPENote, MPEInstrument | @see MPESynthesiserBase, MPESynthesiserVoice, MPENote, MPEInstrument | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MPESynthesiser : public MPESynthesiserBase | class JUCE_API MPESynthesiser : public MPESynthesiserBase | ||||
| { | { | ||||
| @@ -40,6 +40,8 @@ namespace juce | |||||
| a voice stealing algorithm, and much more. | a voice stealing algorithm, and much more. | ||||
| @see MPESynthesiser, MPEInstrument | @see MPESynthesiser, MPEInstrument | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| struct JUCE_API MPESynthesiserBase : public MPEInstrument::Listener | struct JUCE_API MPESynthesiserBase : public MPEInstrument::Listener | ||||
| { | { | ||||
| @@ -31,7 +31,9 @@ namespace juce | |||||
| voices so that it can play polyphonically. | voices so that it can play polyphonically. | ||||
| @see MPESynthesiser, MPENote | @see MPESynthesiser, MPENote | ||||
| */ | |||||
| @tags{Audio} | |||||
| */ | |||||
| class JUCE_API MPESynthesiserVoice | class JUCE_API MPESynthesiserVoice | ||||
| { | { | ||||
| public: | public: | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| To use it, create an instance passing in the MPE zone that it should operate on | 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 then call use the findMidiChannelForNewNote() method for all note-on messages | ||||
| and the noteOff() method for all note-off messages. | and the noteOff() method for all note-off messages. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class MPEChannelAssigner | class MPEChannelAssigner | ||||
| { | { | ||||
| @@ -91,6 +93,8 @@ private: | |||||
| /** | /** | ||||
| This class handles the logic for remapping MIDI note messages from multiple MPE | This class handles the logic for remapping MIDI note messages from multiple MPE | ||||
| sources onto a specified MPE zone. | sources onto a specified MPE zone. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class MPEChannelRemapper | class MPEChannelRemapper | ||||
| { | { | ||||
| @@ -30,6 +30,8 @@ namespace juce | |||||
| (corresponding to 1 or 2 MIDI bytes, respectively). It also offers helper | (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 | functions to query the value in a variety of representations that can be | ||||
| useful in an audio or MIDI context. | useful in an audio or MIDI context. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MPEValue | class JUCE_API MPEValue | ||||
| { | { | ||||
| @@ -38,6 +38,8 @@ namespace juce | |||||
| MIDI device to set its zone layout, add zones etc. | MIDI device to set its zone layout, add zones etc. | ||||
| @see MPEInstrument | @see MPEInstrument | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MPEZoneLayout | class JUCE_API MPEZoneLayout | ||||
| { | { | ||||
| @@ -23,7 +23,7 @@ | |||||
| namespace juce | namespace juce | ||||
| { | { | ||||
| #if JUCE_MAC || JUCE_IOS | |||||
| #if JUCE_MAC || JUCE_IOS && ! DOXYGEN | |||||
| struct CoreAudioLayouts | struct CoreAudioLayouts | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Used by AudioSource::getNextAudioBlock(). | Used by AudioSource::getNextAudioBlock(). | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| struct JUCE_API AudioSourceChannelInfo | struct JUCE_API AudioSourceChannelInfo | ||||
| { | { | ||||
| @@ -103,6 +105,8 @@ struct JUCE_API AudioSourceChannelInfo | |||||
| back into an 'unprepared' state. | back into an 'unprepared' state. | ||||
| @see AudioFormatReaderSource, ResamplingAudioSource | @see AudioFormatReaderSource, ResamplingAudioSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioSource | class JUCE_API AudioSource | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| directly, or use it indirectly using an AudioTransportSource. | directly, or use it indirectly using an AudioTransportSource. | ||||
| @see PositionableAudioSource, AudioTransportSource | @see PositionableAudioSource, AudioTransportSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API BufferingAudioSource : public PositionableAudioSource, | class JUCE_API BufferingAudioSource : public PositionableAudioSource, | ||||
| private TimeSliceClient | private TimeSliceClient | ||||
| @@ -37,6 +37,8 @@ namespace juce | |||||
| it'll produce silence. | it'll produce silence. | ||||
| @see AudioSource | @see AudioSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class ChannelRemappingAudioSource : public AudioSource | class ChannelRemappingAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| An AudioSource that performs an IIR filter on another source. | An AudioSource that performs an IIR filter on another source. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API IIRFilterAudioSource : public AudioSource | class JUCE_API IIRFilterAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| An AudioSource which takes some float audio data as an input. | An AudioSource which takes some float audio data as an input. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MemoryAudioSource : public AudioSource | class JUCE_API MemoryAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -30,6 +30,8 @@ namespace juce | |||||
| Input sources can be added and removed while the mixer is running as long as their | 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 | prepareToPlay() and releaseResources() methods are called before and after adding | ||||
| them to the mixer. | them to the mixer. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MixerAudioSource : public AudioSource | class JUCE_API MixerAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| that has a current read position. | that has a current read position. | ||||
| @see AudioSource, AudioTransportSource | @see AudioSource, AudioTransportSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API PositionableAudioSource : public AudioSource | class JUCE_API PositionableAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -28,6 +28,8 @@ namespace juce | |||||
| A type of AudioSource that takes an input source and changes its sample rate. | A type of AudioSource that takes an input source and changes its sample rate. | ||||
| @see AudioSource, LagrangeInterpolator, CatmullRomInterpolator | @see AudioSource, LagrangeInterpolator, CatmullRomInterpolator | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API ResamplingAudioSource : public AudioSource | class JUCE_API ResamplingAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -28,6 +28,8 @@ namespace juce | |||||
| An AudioSource that uses the Reverb class to apply a reverb to another AudioSource. | An AudioSource that uses the Reverb class to apply a reverb to another AudioSource. | ||||
| @see Reverb | @see Reverb | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API ReverbAudioSource : public AudioSource | class JUCE_API ReverbAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -27,6 +27,8 @@ namespace juce | |||||
| /** | /** | ||||
| A simple AudioSource that generates a sine wave. | A simple AudioSource that generates a sine wave. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API ToneGeneratorAudioSource : public AudioSource | class JUCE_API ToneGeneratorAudioSource : public AudioSource | ||||
| { | { | ||||
| @@ -35,6 +35,8 @@ namespace juce | |||||
| more than one SynthesiserVoice to play the same sound at the same time. | more than one SynthesiserVoice to play the same sound at the same time. | ||||
| @see Synthesiser, SynthesiserVoice | @see Synthesiser, SynthesiserVoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API SynthesiserSound : public ReferenceCountedObject | class JUCE_API SynthesiserSound : public ReferenceCountedObject | ||||
| { | { | ||||
| @@ -79,6 +81,8 @@ private: | |||||
| voices so that it can play polyphonically. | voices so that it can play polyphonically. | ||||
| @see Synthesiser, SynthesiserSound | @see Synthesiser, SynthesiserSound | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API SynthesiserVoice | class JUCE_API SynthesiserVoice | ||||
| { | { | ||||
| @@ -302,6 +306,8 @@ private: | |||||
| Before rendering, be sure to call the setCurrentPlaybackSampleRate() to tell it | 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 | what the target playback rate is. This value is passed on to the voices so that | ||||
| they can pitch their output correctly. | they can pitch their output correctly. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API Synthesiser | class JUCE_API Synthesiser | ||||
| { | { | ||||
| @@ -60,6 +60,8 @@ namespace juce | |||||
| listeners whenever one of its settings is changed. | listeners whenever one of its settings is changed. | ||||
| @see AudioDeviceSelectorComponent, AudioIODevice, AudioIODeviceType | @see AudioDeviceSelectorComponent, AudioIODevice, AudioIODeviceType | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioDeviceManager : public ChangeBroadcaster | class JUCE_API AudioDeviceManager : public ChangeBroadcaster | ||||
| { | { | ||||
| @@ -36,6 +36,8 @@ class AudioIODevice; | |||||
| the next block of data. | the next block of data. | ||||
| @see AudioIODevice, AudioDeviceManager | @see AudioIODevice, AudioDeviceManager | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioIODeviceCallback | class JUCE_API AudioIODeviceCallback | ||||
| { | { | ||||
| @@ -128,6 +130,8 @@ public: | |||||
| AudioDeviceManager class. | AudioDeviceManager class. | ||||
| @see AudioIODeviceType, AudioDeviceManager | @see AudioIODeviceType, AudioDeviceManager | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioIODevice | class JUCE_API AudioIODevice | ||||
| { | { | ||||
| @@ -55,6 +55,8 @@ namespace juce | |||||
| AudioDeviceManager class. | AudioDeviceManager class. | ||||
| @see AudioIODevice, AudioDeviceManager | @see AudioIODevice, AudioDeviceManager | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioIODeviceType | class JUCE_API AudioIODeviceType | ||||
| { | { | ||||
| @@ -26,6 +26,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Contains functions to control the system's master volume. | Contains functions to control the system's master volume. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API SystemAudioVolume | class JUCE_API SystemAudioVolume | ||||
| { | { | ||||
| @@ -34,6 +34,8 @@ class MidiInput; | |||||
| class for more details. | class for more details. | ||||
| @see MidiInput | @see MidiInput | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiInputCallback | class JUCE_API MidiInputCallback | ||||
| { | { | ||||
| @@ -84,6 +86,8 @@ public: | |||||
| available, and then use the openDevice() method to try to open one. | available, and then use the openDevice() method to try to open one. | ||||
| @see MidiOutput | @see MidiOutput | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiInput | class JUCE_API MidiInput | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| so it can easily use a midi input or keyboard component as its source. | so it can easily use a midi input or keyboard component as its source. | ||||
| @see MidiMessage, MidiInput | @see MidiMessage, MidiInput | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiMessageCollector : public MidiKeyboardStateListener, | class JUCE_API MidiMessageCollector : public MidiKeyboardStateListener, | ||||
| public MidiInputCallback | public MidiInputCallback | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| available output devices, then use the openDevice() method to try to open one. | available output devices, then use the openDevice() method to try to open one. | ||||
| @see MidiInput | @see MidiInput | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MidiOutput : private Thread | class JUCE_API MidiOutput : private Thread | ||||
| { | { | ||||
| @@ -27,6 +27,8 @@ namespace juce | |||||
| /** | /** | ||||
| Helper class that takes chunks of incoming midi bytes, packages them into | Helper class that takes chunks of incoming midi bytes, packages them into | ||||
| messages, and dispatches them to a midi callback. | messages, and dispatches them to a midi callback. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class MidiDataConcatenator | class MidiDataConcatenator | ||||
| { | { | ||||
| @@ -30,6 +30,8 @@ namespace juce | |||||
| This object acts as an AudioIODeviceCallback, so can be attached to an | This object acts as an AudioIODeviceCallback, so can be attached to an | ||||
| output device, and will stream audio from an AudioSource. | output device, and will stream audio from an AudioSource. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioSourcePlayer : public AudioIODeviceCallback | class JUCE_API AudioSourcePlayer : public AudioIODeviceCallback | ||||
| { | { | ||||
| @@ -35,6 +35,8 @@ namespace juce | |||||
| to control playback of an audio file. | to control playback of an audio file. | ||||
| @see AudioSource, AudioSourcePlayer | @see AudioSource, AudioSourcePlayer | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioTransportSource : public PositionableAudioSource, | class JUCE_API AudioTransportSource : public PositionableAudioSource, | ||||
| public ChangeBroadcaster | public ChangeBroadcaster | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| Reads and Writes AIFF format audio files. | Reads and Writes AIFF format audio files. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AiffAudioFormat : public AudioFormat | class JUCE_API AiffAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -37,7 +37,9 @@ namespace juce | |||||
| This should be able to understand formats such as mp3, m4a, etc. | This should be able to understand formats such as mp3, m4a, etc. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| */ | |||||
| @tags{Audio} | |||||
| */ | |||||
| class JUCE_API CoreAudioFormat : public AudioFormat | class JUCE_API CoreAudioFormat : public AudioFormat | ||||
| { | { | ||||
| public: | public: | ||||
| @@ -36,6 +36,8 @@ namespace juce | |||||
| To compile this, you'll need to set the JUCE_USE_FLAC flag. | To compile this, you'll need to set the JUCE_USE_FLAC flag. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API FlacAudioFormat : public AudioFormat | class JUCE_API FlacAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -42,6 +42,8 @@ namespace juce | |||||
| the writer. | the writer. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API LAMEEncoderAudioFormat : public AudioFormat | class JUCE_API LAMEEncoderAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -42,6 +42,8 @@ namespace juce | |||||
| intellectual property. If you wish to use it, please seek your own independent advice about the | 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 | 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. | of using this code, then do not enable the JUCE_USE_MP3AUDIOFORMAT setting. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class MP3AudioFormat : public AudioFormat | class MP3AudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -36,6 +36,8 @@ namespace juce | |||||
| To compile this, you'll need to set the JUCE_USE_OGGVORBIS flag. | To compile this, you'll need to set the JUCE_USE_OGGVORBIS flag. | ||||
| @see AudioFormat, | @see AudioFormat, | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API OggVorbisAudioFormat : public AudioFormat | class JUCE_API OggVorbisAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| Reads and Writes WAV format audio files. | Reads and Writes WAV format audio files. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API WavAudioFormat : public AudioFormat | class JUCE_API WavAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Audio format which uses the Windows Media codecs (Windows only). | Audio format which uses the Windows Media codecs (Windows only). | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class WindowsMediaAudioFormat : public AudioFormat | class WindowsMediaAudioFormat : public AudioFormat | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| file formats. | file formats. | ||||
| @see AudioFormatReader, AudioFormatWriter, WavAudioFormat, AiffAudioFormat | @see AudioFormatReader, AudioFormatWriter, WavAudioFormat, AiffAudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioFormat | class JUCE_API AudioFormat | ||||
| { | { | ||||
| @@ -36,6 +36,8 @@ namespace juce | |||||
| or registerBasicFormats() to give it a list of format types that it can use. | or registerBasicFormats() to give it a list of format types that it can use. | ||||
| @see AudioFormat | @see AudioFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioFormatManager | class JUCE_API AudioFormatManager | ||||
| { | { | ||||
| @@ -38,6 +38,8 @@ class AudioFormat; | |||||
| an AudioFormat object. | an AudioFormat object. | ||||
| @see AudioFormat, AudioFormatWriter | @see AudioFormat, AudioFormatWriter | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioFormatReader | class JUCE_API AudioFormatReader | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| A type of AudioSource that will read from an AudioFormatReader. | A type of AudioSource that will read from an AudioFormatReader. | ||||
| @see PositionableAudioSource, AudioTransportSource, BufferingAudioSource | @see PositionableAudioSource, AudioTransportSource, BufferingAudioSource | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioFormatReaderSource : public PositionableAudioSource | class JUCE_API AudioFormatReaderSource : public PositionableAudioSource | ||||
| { | { | ||||
| @@ -38,6 +38,8 @@ namespace juce | |||||
| you can call its write() method to store the samples, and then delete it. | you can call its write() method to store the samples, and then delete it. | ||||
| @see AudioFormat, AudioFormatReader | @see AudioFormat, AudioFormatReader | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioFormatWriter | class JUCE_API AudioFormatWriter | ||||
| { | { | ||||
| @@ -210,6 +212,7 @@ public: | |||||
| */ | */ | ||||
| bool write (const float* const* data, int numSamples); | bool write (const float* const* data, int numSamples); | ||||
| /** Receiver for incoming data. */ | |||||
| class JUCE_API IncomingDataReceiver | class JUCE_API IncomingDataReceiver | ||||
| { | { | ||||
| public: | public: | ||||
| @@ -223,8 +226,8 @@ public: | |||||
| /** Allows you to specify a callback that this writer should update with the | /** Allows you to specify a callback that this writer should update with the | ||||
| incoming data. | 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. | The object passed-in must not be deleted while this writer is still using it. | ||||
| */ | */ | ||||
| @@ -39,6 +39,8 @@ namespace juce | |||||
| be at a non-zero position. | be at a non-zero position. | ||||
| @see AudioFormatReader | @see AudioFormatReader | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioSubsectionReader : public AudioFormatReader | class JUCE_API AudioSubsectionReader : public AudioFormatReader | ||||
| { | { | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| another reader. | another reader. | ||||
| @see AudioFormatReader | @see AudioFormatReader | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API BufferingAudioReader : public AudioFormatReader, | class JUCE_API BufferingAudioReader : public AudioFormatReader, | ||||
| private TimeSliceClient | private TimeSliceClient | ||||
| @@ -41,6 +41,8 @@ namespace juce | |||||
| read has been mapped. | read has been mapped. | ||||
| @see AudioFormat::createMemoryMappedReader, AudioFormatReader | @see AudioFormat::createMemoryMappedReader, AudioFormatReader | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API MemoryMappedAudioFormatReader : public AudioFormatReader | class JUCE_API MemoryMappedAudioFormatReader : public AudioFormatReader | ||||
| { | { | ||||
| @@ -38,6 +38,8 @@ namespace juce | |||||
| give it some SampledSound objects to play. | give it some SampledSound objects to play. | ||||
| @see SamplerVoice, Synthesiser, SynthesiserSound | @see SamplerVoice, Synthesiser, SynthesiserSound | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API SamplerSound : public SynthesiserSound | class JUCE_API SamplerSound : public SynthesiserSound | ||||
| { | { | ||||
| @@ -110,6 +112,8 @@ private: | |||||
| give it some SampledSound objects to play. | give it some SampledSound objects to play. | ||||
| @see SamplerSound, Synthesiser, SynthesiserVoice | @see SamplerSound, Synthesiser, SynthesiserVoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API SamplerVoice : public SynthesiserVoice | class JUCE_API SamplerVoice : public SynthesiserVoice | ||||
| { | { | ||||
| @@ -27,6 +27,8 @@ | |||||
| namespace juce | namespace juce | ||||
| { | { | ||||
| #ifndef DOXYGEN | |||||
| struct ModifierKeyProvider | struct ModifierKeyProvider | ||||
| { | { | ||||
| virtual ~ModifierKeyProvider() {} | virtual ~ModifierKeyProvider() {} | ||||
| @@ -40,4 +42,6 @@ struct ModifierKeyReceiver | |||||
| virtual void removeModifierKeyProvider() = 0; | virtual void removeModifierKeyProvider() = 0; | ||||
| }; | }; | ||||
| #endif | |||||
| } // namespace juce | } // namespace juce | ||||
| @@ -38,12 +38,15 @@ namespace juce | |||||
| The object will create your processor using the same createPluginFilter() | The object will create your processor using the same createPluginFilter() | ||||
| function that the other plugin wrappers use, and will run it through the | function that the other plugin wrappers use, and will run it through the | ||||
| computer's audio/MIDI devices using AudioDeviceManager and AudioProcessorPlayer. | computer's audio/MIDI devices using AudioDeviceManager and AudioProcessorPlayer. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class StandalonePluginHolder : private AudioIODeviceCallback, | class StandalonePluginHolder : private AudioIODeviceCallback, | ||||
| private Timer | private Timer | ||||
| { | { | ||||
| public: | public: | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for the number of inputs and outputs. */ | |||||
| struct PluginInOuts { short numIns, numOuts; }; | struct PluginInOuts { short numIns, numOuts; }; | ||||
| //============================================================================== | //============================================================================== | ||||
| @@ -558,6 +561,8 @@ private: | |||||
| Just create one of these objects in your JUCEApplicationBase::initialise() method, and | 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 | let it do its work. It will create your filter object using the same createPluginFilter() function | ||||
| that the other plugin wrappers use. | that the other plugin wrappers use. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class StandaloneFilterWindow : public DocumentWindow, | class StandaloneFilterWindow : public DocumentWindow, | ||||
| public Button::Listener | public Button::Listener | ||||
| @@ -29,6 +29,8 @@ namespace juce | |||||
| /** An interface to allow an AudioProcessor to receive VST specific calls from | /** An interface to allow an AudioProcessor to receive VST specific calls from | ||||
| the host. | the host. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| struct VSTCallbackHandler | struct VSTCallbackHandler | ||||
| { | { | ||||
| @@ -27,6 +27,8 @@ | |||||
| namespace juce | namespace juce | ||||
| { | { | ||||
| #ifndef DOXYGEN | |||||
| #if JUCE_MAC | #if JUCE_MAC | ||||
| //============================================================================== | //============================================================================== | ||||
| @@ -90,4 +92,6 @@ private: | |||||
| struct FakeMouseMoveGenerator {}; | struct FakeMouseMoveGenerator {}; | ||||
| #endif | #endif | ||||
| #endif | |||||
| } // namespace juce | } // namespace juce | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| loaded. | loaded. | ||||
| Declare a PluginHostType object in your class to use it. | Declare a PluginHostType object in your class to use it. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class PluginHostType | class PluginHostType | ||||
| { | { | ||||
| @@ -32,11 +32,14 @@ namespace juce | |||||
| The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc. | The base class for a type of plugin format, such as VST, AudioUnit, LADSPA, etc. | ||||
| @see AudioPluginFormatManager | @see AudioPluginFormatManager | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioPluginFormat | class JUCE_API AudioPluginFormat | ||||
| { | { | ||||
| public: | public: | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for callbacks when instantiation is completed. */ | |||||
| struct JUCE_API InstantiationCompletionCallback | struct JUCE_API InstantiationCompletionCallback | ||||
| { | { | ||||
| virtual ~InstantiationCompletionCallback() {} | virtual ~InstantiationCompletionCallback() {} | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| This maintains a list of known AudioPluginFormats. | This maintains a list of known AudioPluginFormats. | ||||
| @see AudioPluginFormat | @see AudioPluginFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioPluginFormatManager | class JUCE_API AudioPluginFormatManager | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ | |||||
| namespace juce | namespace juce | ||||
| { | { | ||||
| #ifndef DOXYGEN | |||||
| struct AudioUnitHelpers | struct AudioUnitHelpers | ||||
| { | { | ||||
| class ChannelRemapper | class ChannelRemapper | ||||
| @@ -530,4 +532,6 @@ struct AudioUnitHelpers | |||||
| } | } | ||||
| }; | }; | ||||
| #endif // ! DOXYGEN | |||||
| } // namespace juce | } // namespace juce | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Implements a plugin format manager for AudioUnits. | Implements a plugin format manager for AudioUnits. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioUnitPluginFormat : public AudioPluginFormat | class JUCE_API AudioUnitPluginFormat : public AudioPluginFormat | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Implements a plugin format manager for LADSPA plugins. | Implements a plugin format manager for LADSPA plugins. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API LADSPAPluginFormat : public AudioPluginFormat | class JUCE_API LADSPAPluginFormat : public AudioPluginFormat | ||||
| { | { | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| /** | /** | ||||
| Implements a plugin format for VST3s. | Implements a plugin format for VST3s. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API VST3PluginFormat : public AudioPluginFormat | class JUCE_API VST3PluginFormat : public AudioPluginFormat | ||||
| { | { | ||||
| @@ -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) | struct SpeakerMappings : private AudioChannelSet // (inheritance only to give easier access to items in the namespace) | ||||
| { | { | ||||
| /** Structure describing a mapping */ | |||||
| struct Mapping | struct Mapping | ||||
| { | { | ||||
| int32 vst2; | int32 vst2; | ||||
| @@ -125,6 +130,7 @@ struct SpeakerMappings : private AudioChannelSet // (inheritance only to give e | |||||
| return vstSpeakerConfigTypeUser; | return vstSpeakerConfigTypeUser; | ||||
| } | } | ||||
| /** Class to hold a speaker configuration */ | |||||
| class VstSpeakerConfigurationHolder | class VstSpeakerConfigurationHolder | ||||
| { | { | ||||
| public: | public: | ||||
| @@ -48,6 +48,10 @@ const int32 juceVstInterfaceVersion = 2400; | |||||
| const int32 juceVstInterfaceIdentifier = 0x56737450; // The "magic" identifier in the SDK is 'VstP'. | const int32 juceVstInterfaceIdentifier = 0x56737450; // The "magic" identifier in the SDK is 'VstP'. | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstEffectInterface | struct VstEffectInterface | ||||
| { | { | ||||
| int32 interfaceIdentifier; | int32 interfaceIdentifier; | ||||
| @@ -221,6 +225,10 @@ enum VstPlugInCategory | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstEditorBounds | struct VstEditorBounds | ||||
| { | { | ||||
| int16 upper; | int16 upper; | ||||
| @@ -241,6 +249,10 @@ enum VstMaxStringLengths | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstPinInfo | struct VstPinInfo | ||||
| { | { | ||||
| char text[vstMaxParameterOrPinLabelLength]; | char text[vstMaxParameterOrPinLabelLength]; | ||||
| @@ -258,6 +270,10 @@ enum VstPinInfoFlags | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstEvent | struct VstEvent | ||||
| { | { | ||||
| int32 type; | int32 type; | ||||
| @@ -273,6 +289,10 @@ enum VstEventTypes | |||||
| vstSysExEventType = 6 | vstSysExEventType = 6 | ||||
| }; | }; | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstEventBlock | struct VstEventBlock | ||||
| { | { | ||||
| int32 numberOfEvents; | int32 numberOfEvents; | ||||
| @@ -280,6 +300,10 @@ struct VstEventBlock | |||||
| VstEvent* events[2]; | VstEvent* events[2]; | ||||
| }; | }; | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstMidiEvent | struct VstMidiEvent | ||||
| { | { | ||||
| int32 type; | int32 type; | ||||
| @@ -300,6 +324,10 @@ enum VstMidiEventFlags | |||||
| vstMidiEventIsRealtime = 1 | vstMidiEventIsRealtime = 1 | ||||
| }; | }; | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstSysExEvent | struct VstSysExEvent | ||||
| { | { | ||||
| int32 type; | int32 type; | ||||
| @@ -313,6 +341,10 @@ struct VstSysExEvent | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstTimingInformation | struct VstTimingInformation | ||||
| { | { | ||||
| double samplePosition; | double samplePosition; | ||||
| @@ -369,6 +401,10 @@ enum VstSmpteRates | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstIndividualSpeakerInfo | struct VstIndividualSpeakerInfo | ||||
| { | { | ||||
| float azimuthalAngle; | float azimuthalAngle; | ||||
| @@ -406,6 +442,10 @@ enum VstIndividualSpeakerType | |||||
| vstIndividualSpeakerTypeLFE2 | vstIndividualSpeakerTypeLFE2 | ||||
| }; | }; | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct VstSpeakerConfiguration | struct VstSpeakerConfiguration | ||||
| { | { | ||||
| int32 type; | int32 type; | ||||
| @@ -461,6 +501,10 @@ enum PresonusExtensionConstants | |||||
| }; | }; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used for VSTs | |||||
| @tags{Audio} | |||||
| */ | |||||
| struct vst2FxBank | struct vst2FxBank | ||||
| { | { | ||||
| int32 magic1; | int32 magic1; | ||||
| @@ -35,6 +35,8 @@ namespace juce | |||||
| events to the list. | events to the list. | ||||
| This is used by both the VST hosting code and the plugin wrapper. | This is used by both the VST hosting code and the plugin wrapper. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class VSTMidiEventList | class VSTMidiEventList | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| //============================================================================== | //============================================================================== | ||||
| /** | /** | ||||
| Implements a plugin format manager for VSTs. | Implements a plugin format manager for VSTs. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API VSTPluginFormat : public AudioPluginFormat | class JUCE_API VSTPluginFormat : public AudioPluginFormat | ||||
| { | { | ||||
| @@ -39,6 +39,8 @@ namespace juce | |||||
| return AudioPluginInstance objects which wrap external plugins. | return AudioPluginInstance objects which wrap external plugins. | ||||
| @see AudioProcessor, AudioPluginFormat | @see AudioProcessor, AudioPluginFormat | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioPluginInstance : public AudioProcessor | class JUCE_API AudioPluginInstance : public AudioProcessor | ||||
| { | { | ||||
| @@ -96,6 +98,7 @@ public: | |||||
| protected: | protected: | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Structure used to describe plugin parameters */ | |||||
| struct Parameter : public AudioProcessorParameter | struct Parameter : public AudioProcessorParameter | ||||
| { | { | ||||
| Parameter(); | Parameter(); | ||||
| @@ -40,6 +40,8 @@ namespace juce | |||||
| You should derive your own class from this base class, and if you're building a | 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 | plugin, you should implement a global function called createPluginFilter() which | ||||
| creates and returns a new instance of your subclass. | creates and returns a new instance of your subclass. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessor | class JUCE_API AudioProcessor | ||||
| { | { | ||||
| @@ -1480,6 +1482,7 @@ protected: | |||||
| bool isActivatedByDefault; | bool isActivatedByDefault; | ||||
| }; | }; | ||||
| /** Structure used for AudioProcessor Callbacks */ | |||||
| struct BusesProperties | struct BusesProperties | ||||
| { | { | ||||
| /** The layouts of the input buses */ | /** The layouts of the input buses */ | ||||
| @@ -38,6 +38,8 @@ class AudioProcessorEditorListener; | |||||
| by overriding the AudioProcessor::createEditor() method. | by overriding the AudioProcessor::createEditor() method. | ||||
| @see AudioProcessor, GenericAudioProcessorEditor | @see AudioProcessor, GenericAudioProcessorEditor | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessorEditor : public Component | class JUCE_API AudioProcessorEditor : public Component | ||||
| { | { | ||||
| @@ -40,6 +40,8 @@ namespace juce | |||||
| To play back a graph through an audio device, you might want to use an | To play back a graph through an audio device, you might want to use an | ||||
| AudioProcessorPlayer object. | AudioProcessorPlayer object. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessorGraph : public AudioProcessor, | class JUCE_API AudioProcessorGraph : public AudioProcessor, | ||||
| public ChangeBroadcaster, | public ChangeBroadcaster, | ||||
| @@ -34,6 +34,8 @@ namespace juce | |||||
| Use AudioProcessor::addListener() to register your listener with an AudioProcessor. | Use AudioProcessor::addListener() to register your listener with an AudioProcessor. | ||||
| @see AudioProcessor | @see AudioProcessor | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessorListener | class JUCE_API AudioProcessorListener | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| AudioProcessor. | AudioProcessor. | ||||
| @see AudioProcessor::addParameter | @see AudioProcessor::addParameter | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessorParameter | class JUCE_API AudioProcessorParameter | ||||
| { | { | ||||
| @@ -36,6 +36,8 @@ namespace juce | |||||
| its own custom editor. | its own custom editor. | ||||
| @see AudioProcessor | @see AudioProcessor | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API GenericAudioProcessorEditor : public AudioProcessorEditor | class JUCE_API GenericAudioProcessorEditor : public AudioProcessorEditor | ||||
| { | { | ||||
| @@ -37,6 +37,8 @@ namespace juce | |||||
| A KnownPluginList contains a list of PluginDescription objects. | A KnownPluginList contains a list of PluginDescription objects. | ||||
| @see KnownPluginList | @see KnownPluginList | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API PluginDescription | class JUCE_API PluginDescription | ||||
| { | { | ||||
| @@ -35,6 +35,8 @@ namespace juce | |||||
| the plugin types in it. | the plugin types in it. | ||||
| @see PluginListComponent | @see PluginListComponent | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API KnownPluginList : public ChangeBroadcaster | class JUCE_API KnownPluginList : public ChangeBroadcaster | ||||
| { | { | ||||
| @@ -185,6 +187,7 @@ public: | |||||
| PluginTree* createTree (const SortMethod sortMethod) const; | PluginTree* createTree (const SortMethod sortMethod) const; | ||||
| //============================================================================== | //============================================================================== | ||||
| /** Class to define a custom plugin scanner */ | |||||
| class CustomScanner | class CustomScanner | ||||
| { | { | ||||
| public: | public: | ||||
| @@ -33,6 +33,8 @@ namespace juce | |||||
| To use one of these, create it and call scanNextFile() repeatedly, until | To use one of these, create it and call scanNextFile() repeatedly, until | ||||
| it returns false. | it returns false. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API PluginDirectoryScanner | class JUCE_API PluginDirectoryScanner | ||||
| { | { | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| /** | /** | ||||
| A component displaying a list of plugins, with options to scan for them, | A component displaying a list of plugins, with options to scan for them, | ||||
| add, remove and sort them. | add, remove and sort them. | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API PluginListComponent : public Component, | class JUCE_API PluginListComponent : public Component, | ||||
| public FileDragAndDropTarget, | public FileDragAndDropTarget, | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| Provides a class of AudioProcessorParameter that can be used as a boolean value. | Provides a class of AudioProcessorParameter that can be used as a boolean value. | ||||
| @see AudioParameterFloat, AudioParameterInt, AudioParameterChoice | @see AudioParameterFloat, AudioParameterInt, AudioParameterChoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioParameterBool : public AudioProcessorParameterWithID | class JUCE_API AudioParameterBool : public AudioProcessorParameterWithID | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| an indexed, named choice from a list. | an indexed, named choice from a list. | ||||
| @see AudioParameterFloat, AudioParameterInt, AudioParameterBool | @see AudioParameterFloat, AudioParameterInt, AudioParameterBool | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioParameterChoice : public AudioProcessorParameterWithID | class JUCE_API AudioParameterChoice : public AudioProcessorParameterWithID | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| parameter which maps onto a given NormalisableRange. | parameter which maps onto a given NormalisableRange. | ||||
| @see AudioParameterInt, AudioParameterBool, AudioParameterChoice | @see AudioParameterInt, AudioParameterBool, AudioParameterChoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioParameterFloat : public AudioProcessorParameterWithID | class JUCE_API AudioParameterFloat : public AudioProcessorParameterWithID | ||||
| { | { | ||||
| @@ -32,6 +32,8 @@ namespace juce | |||||
| integer value with a given range. | integer value with a given range. | ||||
| @see AudioParameterFloat, AudioParameterBool, AudioParameterChoice | @see AudioParameterFloat, AudioParameterBool, AudioParameterChoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioParameterInt : public AudioProcessorParameterWithID | class JUCE_API AudioParameterInt : public AudioProcessorParameterWithID | ||||
| { | { | ||||
| @@ -31,6 +31,8 @@ namespace juce | |||||
| This abstract base class is used by some AudioProcessorParameter helper classes. | This abstract base class is used by some AudioProcessorParameter helper classes. | ||||
| @see AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice | @see AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice | ||||
| @tags{Audio} | |||||
| */ | */ | ||||
| class JUCE_API AudioProcessorParameterWithID : public AudioProcessorParameter | class JUCE_API AudioProcessorParameterWithID : public AudioProcessorParameter | ||||
| { | { | ||||