openshot-audio  0.1.2
Public Member Functions | List of all members
AudioTransportSource Class Reference

#include <juce_AudioTransportSource.h>

Inheritance diagram for AudioTransportSource:
PositionableAudioSource ChangeBroadcaster AudioSource

Public Member Functions

 AudioTransportSource ()
 
 ~AudioTransportSource ()
 
void setSource (PositionableAudioSource *newSource, int readAheadBufferSize=0, TimeSliceThread *readAheadThread=nullptr, double sourceSampleRateToCorrectFor=0.0, int maxNumChannels=2)
 
void setPosition (double newPosition)
 
double getCurrentPosition () const
 
double getLengthInSeconds () const
 
bool hasStreamFinished () const noexcept
 
void start ()
 
void stop ()
 
bool isPlaying () const noexcept
 
void setGain (float newGain) noexcept
 
float getGain () const noexcept
 
void prepareToPlay (int samplesPerBlockExpected, double sampleRate) override
 
void releaseResources () override
 
void getNextAudioBlock (const AudioSourceChannelInfo &) override
 
void setNextReadPosition (int64 newPosition) override
 
int64 getNextReadPosition () const override
 
int64 getTotalLength () const override
 
bool isLooping () const override
 
- Public Member Functions inherited from PositionableAudioSource
 ~PositionableAudioSource ()
 
virtual void setLooping (bool shouldLoop)
 
- Public Member Functions inherited from AudioSource
virtual ~AudioSource ()
 
- Public Member Functions inherited from ChangeBroadcaster
 ChangeBroadcaster () noexcept
 
virtual ~ChangeBroadcaster ()
 
void addChangeListener (ChangeListener *listener)
 
void removeChangeListener (ChangeListener *listener)
 
void removeAllChangeListeners ()
 
void sendChangeMessage ()
 
void sendSynchronousChangeMessage ()
 
void dispatchPendingMessages ()
 

Additional Inherited Members

- Protected Member Functions inherited from PositionableAudioSource
 PositionableAudioSource () noexcept
 
- Protected Member Functions inherited from AudioSource
 AudioSource () noexcept
 

Detailed Description

An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc.

This can also be told use a buffer and background thread to read ahead, and if can correct for different sample-rates.

You may want to use one of these along with an AudioSourcePlayer and AudioIODevice to control playback of an audio file.

See also
AudioSource, AudioSourcePlayer

Constructor & Destructor Documentation

◆ AudioTransportSource()

AudioTransportSource::AudioTransportSource ( )

Creates an AudioTransportSource. After creating one of these, use the setSource() method to select an input source.

◆ ~AudioTransportSource()

AudioTransportSource::~AudioTransportSource ( )

Destructor.

Member Function Documentation

◆ getCurrentPosition()

double AudioTransportSource::getCurrentPosition ( ) const

Returns the position that the next data block will be read from This is a time in seconds.

◆ getGain()

float AudioTransportSource::getGain ( ) const
inlinenoexcept

Returns the current gain setting.

See also
setGain

◆ getLengthInSeconds()

double AudioTransportSource::getLengthInSeconds ( ) const

Returns the stream's length in seconds.

◆ getNextAudioBlock()

void AudioTransportSource::getNextAudioBlock ( const AudioSourceChannelInfo info)
overridevirtual

Implementation of the AudioSource method.

Implements AudioSource.

◆ getNextReadPosition()

int64 AudioTransportSource::getNextReadPosition ( ) const
overridevirtual

Implements the PositionableAudioSource method.

Implements PositionableAudioSource.

◆ getTotalLength()

int64 AudioTransportSource::getTotalLength ( ) const
overridevirtual

Implements the PositionableAudioSource method.

Implements PositionableAudioSource.

◆ hasStreamFinished()

bool AudioTransportSource::hasStreamFinished ( ) const
inlinenoexcept

Returns true if the player has stopped because its input stream ran out of data.

◆ isLooping()

bool AudioTransportSource::isLooping ( ) const
overridevirtual

Implements the PositionableAudioSource method.

Implements PositionableAudioSource.

◆ isPlaying()

bool AudioTransportSource::isPlaying ( ) const
inlinenoexcept

Returns true if it's currently playing.

◆ prepareToPlay()

void AudioTransportSource::prepareToPlay ( int  samplesPerBlockExpected,
double  sampleRate 
)
overridevirtual

Implementation of the AudioSource method.

Implements AudioSource.

◆ releaseResources()

void AudioTransportSource::releaseResources ( )
overridevirtual

Implementation of the AudioSource method.

Implements AudioSource.

◆ setGain()

void AudioTransportSource::setGain ( float  newGain)
noexcept

Changes the gain to apply to the output.

Parameters
newGaina factor by which to multiply the outgoing samples, so 1.0 = 0dB, 0.5 = -6dB, 2.0 = 6dB, etc.

◆ setNextReadPosition()

void AudioTransportSource::setNextReadPosition ( int64  newPosition)
overridevirtual

Implements the PositionableAudioSource method.

Implements PositionableAudioSource.

◆ setPosition()

void AudioTransportSource::setPosition ( double  newPosition)

Changes the current playback position in the source stream.

The next time the getNextAudioBlock() method is called, this is the time from which it'll read data.

See also
getPosition

◆ setSource()

void AudioTransportSource::setSource ( PositionableAudioSource newSource,
int  readAheadBufferSize = 0,
TimeSliceThread readAheadThread = nullptr,
double  sourceSampleRateToCorrectFor = 0.0,
int  maxNumChannels = 2 
)

Sets the reader that is being used as the input source.

This will stop playback, reset the position to 0 and change to the new reader.

The source passed in will not be deleted by this object, so must be managed by the caller.

Parameters
newSourcethe new input source to use. This may be zero
readAheadBufferSizea size of buffer to use for reading ahead. If this is zero, no reading ahead will be done; if it's greater than zero, a BufferingAudioSource will be used to do the reading-ahead. If you set a non-zero value here, you'll also need to set the readAheadThread parameter.
readAheadThreadif you set readAheadBufferSize to a non-zero value, then you'll also need to supply this TimeSliceThread object for the background reader to use. The thread object must not be deleted while the AudioTransport source is still using it.
sourceSampleRateToCorrectForif this is non-zero, it specifies the sample rate of the source, and playback will be sample-rate adjusted to maintain playback at the correct pitch. If this is 0, no sample-rate adjustment will be performed
maxNumChannelsthe maximum number of channels that may need to be played

◆ start()

void AudioTransportSource::start ( )

Starts playing (if a source has been selected).

If it starts playing, this will send a message to any ChangeListeners that are registered with this object.

◆ stop()

void AudioTransportSource::stop ( )

Stops playing.

If it's actually playing, this will send a message to any ChangeListeners that are registered with this object.


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