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:

Public Member Functions
	AudioSourcePlayer ()
	Creates an empty AudioSourcePlayer.
	~AudioSourcePlayer () override
	Destructor.
void	setSource (AudioSource *newSource)
	Changes the current audio source to play from.
AudioSource *	getCurrentSource () 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	audioDeviceIOCallbackWithContext (const float *const *inputChannelData, int totalNumInputChannels, float *const *outputChannelData, int totalNumOutputChannels, int numSamples, const AudioIODeviceCallbackContext &context) override
	Implementation of the AudioIODeviceCallbackWithContext 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 juce::AudioIODeviceCallback
virtual	~AudioIODeviceCallback ()=default
	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.

@tags{Audio}

Definition at line 36 of file juce_AudioSourcePlayer.h.

Constructor & Destructor Documentation

AudioSourcePlayer()

juce::AudioSourcePlayer::AudioSourcePlayer

(

)

Creates an empty AudioSourcePlayer.

Definition at line 26 of file juce_AudioSourcePlayer.cpp.

~AudioSourcePlayer()

juce::AudioSourcePlayer::~AudioSourcePlayer ( )

override

Destructor.

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

Definition at line 30 of file juce_AudioSourcePlayer.cpp.

Member Function Documentation

audioDeviceAboutToStart()

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

overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements juce::AudioIODeviceCallback.

Definition at line 154 of file juce_AudioSourcePlayer.cpp.

audioDeviceIOCallbackWithContext()

void juce::AudioSourcePlayer::audioDeviceIOCallbackWithContext ( const float *const *  inputChannelData, int  totalNumInputChannels, float *const *  outputChannelData, int  totalNumOutputChannels, int  numSamples, const AudioIODeviceCallbackContext &  context  )

overridevirtual

Implementation of the AudioIODeviceCallbackWithContext method.

Reimplemented from juce::AudioIODeviceCallback.

Definition at line 59 of file juce_AudioSourcePlayer.cpp.

audioDeviceStopped()

void juce::AudioSourcePlayer::audioDeviceStopped ( )

overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements juce::AudioIODeviceCallback.

Definition at line 170 of file juce_AudioSourcePlayer.cpp.

getCurrentSource()

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

noexcept

Returns the source that's playing.

May return nullptr if there's no source.

Definition at line 69 of file juce_AudioSourcePlayer.h.

getGain()

float juce::AudioSourcePlayer::getGain ( ) const

noexcept

Returns the current gain.

See also

setGain

Definition at line 79 of file juce_AudioSourcePlayer.h.

prepareToPlay()

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

An alternative method for initialising the source without an AudioIODevice.

Definition at line 160 of file juce_AudioSourcePlayer.cpp.

setGain()

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

noexcept

Sets a gain to apply to the audio data.

See also

getGain

Definition at line 54 of file juce_AudioSourcePlayer.cpp.

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.

Definition at line 35 of file juce_AudioSourcePlayer.cpp.

---

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

• juce_audio_devices/sources/juce_AudioSourcePlayer.h
• juce_audio_devices/sources/juce_AudioSourcePlayer.cpp