JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
ReverbAudioSource Class Reference

An AudioSource that uses the Reverb class to apply a reverb to another AudioSource. More...

Inherits AudioSource.

Public Member Functions

 ReverbAudioSource (AudioSource *inputSource, bool deleteInputWhenDeleted)
 Creates a ReverbAudioSource to process a given input source.
 
 ~ReverbAudioSource ()
 Destructor.
 
const Reverb::ParametersgetParameters () const noexcept
 Returns the parameters from the reverb.
 
void setParameters (const Reverb::Parameters &newParams)
 Changes the reverb's parameters.
 
void setBypassed (bool isBypassed) noexcept
 
bool isBypassed () const noexcept
 
void prepareToPlay (int samplesPerBlockExpected, double sampleRate) override
 Tells the source to prepare for playing.
 
void releaseResources () override
 Allows the source to release anything it no longer needs after playback has stopped.
 
void getNextAudioBlock (const AudioSourceChannelInfo &) override
 Called repeatedly to fetch subsequent blocks of audio data.
 
- Public Member Functions inherited from AudioSource
virtual ~AudioSource ()
 Destructor.
 

Additional Inherited Members

- Protected Member Functions inherited from AudioSource
 AudioSource () noexcept
 Creates an AudioSource.
 

Detailed Description

An AudioSource that uses the Reverb class to apply a reverb to another AudioSource.

See Also
Reverb

Constructor & Destructor Documentation

ReverbAudioSource::ReverbAudioSource ( AudioSource inputSource,
bool  deleteInputWhenDeleted 
)

Creates a ReverbAudioSource to process a given input source.

Parameters
inputSourcethe input source to read from - this must not be null
deleteInputWhenDeletedif true, the input source will be deleted when this object is deleted
ReverbAudioSource::~ReverbAudioSource ( )

Destructor.

Member Function Documentation

const Reverb::Parameters& ReverbAudioSource::getParameters ( ) const
noexcept

Returns the parameters from the reverb.

void ReverbAudioSource::setParameters ( const Reverb::Parameters newParams)

Changes the reverb's parameters.

void ReverbAudioSource::setBypassed ( bool  isBypassed)
noexcept
bool ReverbAudioSource::isBypassed ( ) const
noexcept
void ReverbAudioSource::prepareToPlay ( int  samplesPerBlockExpected,
double  sampleRate 
)
overridevirtual

Tells the source to prepare for playing.

An AudioSource has two states: prepared and unprepared.

The prepareToPlay() method is guaranteed to be called at least once on an 'unpreprared' source to put it into a 'prepared' state before any calls will be made to getNextAudioBlock(). This callback allows the source to initialise any resources it might need when playing.

Once playback has finished, the releaseResources() method is called to put the stream back into an 'unprepared' state.

Note that this method could be called more than once in succession without a matching call to releaseResources(), so make sure your code is robust and can handle that kind of situation.

Parameters
samplesPerBlockExpectedthe number of samples that the source will be expected to supply each time its getNextAudioBlock() method is called. This number may vary slightly, because it will be dependent on audio hardware callbacks, and these aren't guaranteed to always use a constant block size, so the source should be able to cope with small variations.
sampleRatethe sample rate that the output will be used at - this is needed by sources such as tone generators.
See Also
releaseResources, getNextAudioBlock

Implements AudioSource.

void ReverbAudioSource::releaseResources ( )
overridevirtual

Allows the source to release anything it no longer needs after playback has stopped.

This will be called when the source is no longer going to have its getNextAudioBlock() method called, so it should release any spare memory, etc. that it might have allocated during the prepareToPlay() call.

Note that there's no guarantee that prepareToPlay() will actually have been called before releaseResources(), and it may be called more than once in succession, so make sure your code is robust and doesn't make any assumptions about when it will be called.

See Also
prepareToPlay, getNextAudioBlock

Implements AudioSource.

void ReverbAudioSource::getNextAudioBlock ( const AudioSourceChannelInfo bufferToFill)
overridevirtual

Called repeatedly to fetch subsequent blocks of audio data.

After calling the prepareToPlay() method, this callback will be made each time the audio playback hardware (or whatever other destination the audio data is going to) needs another block of data.

It will generally be called on a high-priority system thread, or possibly even an interrupt, so be careful not to do too much work here, as that will cause audio glitches!

See Also
AudioSourceChannelInfo, prepareToPlay, releaseResources

Implements AudioSource.


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