A type of AudioSource which can be repositioned. More...

#include <juce_PositionableAudioSource.h>

Inheritance diagram for PositionableAudioSource:

[legend]

Collaboration diagram for PositionableAudioSource:

Public Member Functions
	~PositionableAudioSource ()
	Destructor. More...

virtual void	getNextAudioBlock (const AudioSourceChannelInfo &bufferToFill)=0
	Called repeatedly to fetch subsequent blocks of audio data. More...

virtual int64	getNextReadPosition () const =0
	Returns the position from which the next block will be returned. More...

virtual int64	getTotalLength () const =0
	Returns the total length of the stream (in samples). More...

virtual bool	isLooping () const =0
	Returns true if this source is actually playing in a loop. More...

virtual void	prepareToPlay (int samplesPerBlockExpected, double sampleRate)=0
	Tells the source to prepare for playing. More...

virtual void	releaseResources ()=0
	Allows the source to release anything it no longer needs after playback has stopped. More...

virtual void	setLooping (bool shouldLoop)
	Tells the source whether you'd like it to play in a loop. More...

virtual void	setNextReadPosition (int64 newPosition)=0
	Tells the stream to move to a new position. More...

Protected Member Functions
	PositionableAudioSource () noexcept
	Creates the PositionableAudioSource. More...

Detailed Description

A type of AudioSource which can be repositioned.

The basic AudioSource just streams continuously with no idea of a current time or length, so the PositionableAudioSource is used for a finite stream that has a current read position.

See also: AudioSource, AudioTransportSource

Constructor & Destructor Documentation

◆ PositionableAudioSource()

PositionableAudioSource::PositionableAudioSource ( )

inlineprotectednoexcept

Creates the PositionableAudioSource.

◆ ~PositionableAudioSource()

PositionableAudioSource::~PositionableAudioSource ( )

inline

Destructor.

Member Function Documentation

◆ getNextAudioBlock()

virtual void AudioSource::getNextAudioBlock ( const AudioSourceChannelInfo & bufferToFill )

pure virtualinherited

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

Implemented in AudioTransportSource, ChannelRemappingAudioSource, AudioAppComponent, MixerAudioSource, AudioFormatReaderSource, BufferingAudioSource, ResamplingAudioSource, ReverbAudioSource, ToneGeneratorAudioSource, IIRFilterAudioSource, and MemoryAudioSource.

Referenced by AudioFormatReaderSource::getAudioFormatReader(), AudioTransportSource::getGain(), ResamplingAudioSource::getResamplingRatio(), and ReverbAudioSource::isBypassed().

◆ getNextReadPosition()

virtual int64 PositionableAudioSource::getNextReadPosition ( ) const

pure virtual

Returns the position from which the next block will be returned.

See also: setNextReadPosition

Implemented in AudioTransportSource, AudioFormatReaderSource, and BufferingAudioSource.

Referenced by AudioFormatReaderSource::getAudioFormatReader(), and AudioTransportSource::getGain().

◆ getTotalLength()

virtual int64 PositionableAudioSource::getTotalLength ( ) const

pure virtual

Returns the total length of the stream (in samples).

Implemented in AudioTransportSource, AudioFormatReaderSource, and BufferingAudioSource.

Referenced by AudioFormatReaderSource::getAudioFormatReader(), AudioTransportSource::getGain(), and BufferingAudioSource::getTotalLength().

◆ isLooping()

virtual bool PositionableAudioSource::isLooping ( ) const

pure virtual

Returns true if this source is actually playing in a loop.

Implemented in AudioTransportSource, BufferingAudioSource, and AudioFormatReaderSource.

Referenced by AudioTransportSource::getGain(), and BufferingAudioSource::isLooping().

◆ prepareToPlay()

virtual void AudioSource::prepareToPlay	(	int	samplesPerBlockExpected,
		double	sampleRate
	)

pure virtualinherited

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

samplesPerBlockExpected	the 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.
sampleRate	the sample rate that the output will be used at - this is needed by sources such as tone generators.

See also: releaseResources, getNextAudioBlock

Implemented in AudioTransportSource, ChannelRemappingAudioSource, MixerAudioSource, AudioAppComponent, AudioFormatReaderSource, BufferingAudioSource, ResamplingAudioSource, ReverbAudioSource, IIRFilterAudioSource, ToneGeneratorAudioSource, and MemoryAudioSource.

Referenced by AudioFormatReaderSource::getAudioFormatReader(), AudioTransportSource::getGain(), ResamplingAudioSource::getResamplingRatio(), and ReverbAudioSource::isBypassed().

◆ releaseResources()

virtual void AudioSource::releaseResources ( )

pure virtualinherited

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.