openshot-audio  0.1.2
Public Member Functions | Protected Member Functions | List of all members
juce::PositionableAudioSource Class Referenceabstract

#include <juce_audio_basics.h>

Inheritance diagram for juce::PositionableAudioSource:
juce::AudioSource juce::AudioFormatReaderSource juce::AudioTransportSource juce::BufferingAudioSource

Public Member Functions

 ~PositionableAudioSource ()
 
virtual void setNextReadPosition (int64 newPosition)=0
 
virtual int64 getNextReadPosition () const =0
 
virtual int64 getTotalLength () const =0
 
virtual bool isLooping () const =0
 
virtual void setLooping (bool shouldLoop)
 
- Public Member Functions inherited from juce::AudioSource
virtual ~AudioSource ()
 
virtual void prepareToPlay (int samplesPerBlockExpected, double sampleRate)=0
 
virtual void releaseResources ()=0
 
virtual void getNextAudioBlock (const AudioSourceChannelInfo &bufferToFill)=0
 

Protected Member Functions

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

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

juce::PositionableAudioSource::PositionableAudioSource ( )
inlineprotectednoexcept
juce::PositionableAudioSource::~PositionableAudioSource ( )
inline

Destructor

Member Function Documentation

virtual int64 juce::PositionableAudioSource::getNextReadPosition ( ) const
pure virtual

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

See also
setNextReadPosition

Implemented in juce::AudioTransportSource, juce::BufferingAudioSource, and juce::AudioFormatReaderSource.

virtual int64 juce::PositionableAudioSource::getTotalLength ( ) const
pure virtual

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

Implemented in juce::AudioTransportSource, juce::BufferingAudioSource, and juce::AudioFormatReaderSource.

virtual bool juce::PositionableAudioSource::isLooping ( ) const
pure virtual

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

Implemented in juce::AudioTransportSource, juce::BufferingAudioSource, and juce::AudioFormatReaderSource.

virtual void juce::PositionableAudioSource::setLooping ( bool  shouldLoop)
inlinevirtual

Tells the source whether you'd like it to play in a loop.

Reimplemented in juce::AudioFormatReaderSource.

virtual void juce::PositionableAudioSource::setNextReadPosition ( int64  newPosition)
pure virtual

Tells the stream to move to a new position.

Calling this indicates that the next call to AudioSource::getNextAudioBlock() should return samples from this position.

Note that this may be called on a different thread to getNextAudioBlock(), so the subclass should make sure it's synchronised.

Implemented in juce::AudioTransportSource, juce::BufferingAudioSource, and juce::AudioFormatReaderSource.


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