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

Wrapper class to continuously stream audio from an audio source to an AudioIODevice. More...

Inherits AudioIODeviceCallback.

Public Member Functions

 AudioSourcePlayer ()
 Creates an empty AudioSourcePlayer.
 
virtual ~AudioSourcePlayer ()
 Destructor.
 
void setSource (AudioSource *newSource)
 Changes the current audio source to play from.
 
AudioSourcegetCurrentSource () const noexcept
 Returns the source that's playing.
 
void setGain (float newGain) noexcept
 Sets a gain to apply to the audio data.
 
float getGain () const noexcept
 Returns the current gain.
 
void audioDeviceIOCallback (const float **inputChannelData, int totalNumInputChannels, float **outputChannelData, int totalNumOutputChannels, int numSamples) override
 Implementation of the AudioIODeviceCallback method.
 
void audioDeviceAboutToStart (AudioIODevice *device) override
 Implementation of the AudioIODeviceCallback method.
 
void audioDeviceStopped () override
 Implementation of the AudioIODeviceCallback method.
 
void prepareToPlay (double sampleRate, int blockSize)
 An alternative method for initialising the source without an AudioIODevice.
 
- Public Member Functions inherited from AudioIODeviceCallback
virtual ~AudioIODeviceCallback ()
 Destructor.
 
virtual void audioDeviceError (const String &errorMessage)
 This can be overridden to be told if the device generates an error while operating.
 

Detailed Description

Wrapper class to continuously stream audio from an audio source to an AudioIODevice.

This object acts as an AudioIODeviceCallback, so can be attached to an output device, and will stream audio from an AudioSource.

Constructor & Destructor Documentation

AudioSourcePlayer::AudioSourcePlayer ( )

Creates an empty AudioSourcePlayer.

virtual AudioSourcePlayer::~AudioSourcePlayer ( )
virtual

Destructor.

Make sure this object isn't still being used by an AudioIODevice before deleting it!

Member Function Documentation

void AudioSourcePlayer::setSource ( AudioSource newSource)

Changes the current audio source to play from.

If the source passed in is already being used, this method will do nothing. If the source is not null, its prepareToPlay() method will be called before it starts being used for playback.

If there's another source currently playing, its releaseResources() method will be called after it has been swapped for the new one.

Parameters
newSourcethe new source to use - this will NOT be deleted by this object when no longer needed, so it's the caller's responsibility to manage it.
AudioSource* AudioSourcePlayer::getCurrentSource ( ) const
noexcept

Returns the source that's playing.

May return nullptr if there's no source.

void AudioSourcePlayer::setGain ( float  newGain)
noexcept

Sets a gain to apply to the audio data.

See Also
getGain
float AudioSourcePlayer::getGain ( ) const
noexcept

Returns the current gain.

See Also
setGain
void AudioSourcePlayer::audioDeviceIOCallback ( const float **  inputChannelData,
int  totalNumInputChannels,
float **  outputChannelData,
int  totalNumOutputChannels,
int  numSamples 
)
overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

void AudioSourcePlayer::audioDeviceAboutToStart ( AudioIODevice device)
overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

void AudioSourcePlayer::audioDeviceStopped ( )
overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

void AudioSourcePlayer::prepareToPlay ( double  sampleRate,
int  blockSize 
)

An alternative method for initialising the source without an AudioIODevice.


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