juce::AudioSourcePlayer Class Reference

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

#include <juce_AudioSourcePlayer.h>

Inheritance diagram for juce::AudioSourcePlayer:

Collaboration diagram for juce::AudioSourcePlayer:

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

Private Attributes
int	bufferSize = 0
float *	channels [128]
std::atomic< float >	gain { 1.0f }
const float *	inputChans [128]
float	lastGain = 1.0f
float *	outputChans [128]
CriticalSection	readLock
double	sampleRate = 0
AudioSource *	source = nullptr
AudioBuffer< float >	tempBuffer

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.

@tags{Audio}

Constructor & Destructor Documentation

AudioSourcePlayer()

juce::AudioSourcePlayer::AudioSourcePlayer

(

)

Creates an empty AudioSourcePlayer.

~AudioSourcePlayer()

juce::AudioSourcePlayer::~AudioSourcePlayer ( )

override

Destructor.

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

Member Function Documentation

audioDeviceAboutToStart()

void juce::AudioSourcePlayer::audioDeviceAboutToStart ( AudioIODevice *  device )

overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements juce::AudioIODeviceCallback.

audioDeviceError()

virtual void juce::AudioIODeviceCallback::audioDeviceError ( const String &  errorMessage )

virtualinherited

This can be overridden to be told if the device generates an error while operating.

Be aware that this could be called by any thread! And not all devices perform this callback.

Reimplemented in juce::SoundPlayer.

audioDeviceIOCallback()

void juce::AudioSourcePlayer::audioDeviceIOCallback ( const float **  inputChannelData, int  totalNumInputChannels, float **  outputChannelData, int  totalNumOutputChannels, int  numSamples  )

overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements juce::AudioIODeviceCallback.

audioDeviceStopped()

void juce::AudioSourcePlayer::audioDeviceStopped ( )

overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements juce::AudioIODeviceCallback.

getCurrentSource()

AudioSource* juce::AudioSourcePlayer::getCurrentSource ( ) const

inlinenoexcept

Returns the source that's playing.

May return nullptr if there's no source.

References juce::gl::source.

getGain()

float juce::AudioSourcePlayer::getGain ( ) const

inlinenoexcept

Returns the current gain.

See also

setGain

prepareToPlay()

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

An alternative method for initialising the source without an AudioIODevice.

setGain()

void juce::AudioSourcePlayer::setGain ( float  newGain )

noexcept

Sets a gain to apply to the audio data.

See also

getGain

setSource()

void juce::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

newSource

the 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.

Member Data Documentation

bufferSize

int juce::AudioSourcePlayer::bufferSize = 0

private

channels

float* juce::AudioSourcePlayer::channels[128]

private

gain

std::atomic<float> juce::AudioSourcePlayer::gain { 1.0f }

private

inputChans

const float* juce::AudioSourcePlayer::inputChans[128]

private

lastGain

float juce::AudioSourcePlayer::lastGain = 1.0f

private

outputChans

float* juce::AudioSourcePlayer::outputChans[128]

private

readLock

CriticalSection juce::AudioSourcePlayer::readLock

private

sampleRate

double juce::AudioSourcePlayer::sampleRate = 0

private

source

AudioSource* juce::AudioSourcePlayer::source = nullptr

private

tempBuffer

AudioBuffer<float> juce::AudioSourcePlayer::tempBuffer

private

---

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

• juce_AudioSourcePlayer.h