openshot-audio  0.1.7
Public Member Functions | List of all members
AudioSourcePlayer Class Reference

#include <juce_AudioSourcePlayer.h>

Inheritance diagram for AudioSourcePlayer:
AudioIODeviceCallback

Public Member Functions

 AudioSourcePlayer ()
 
virtual ~AudioSourcePlayer ()
 
void setSource (AudioSource *newSource)
 
AudioSourcegetCurrentSource () const noexcept
 
void setGain (float newGain) noexcept
 
float getGain () const noexcept
 
void audioDeviceIOCallback (const float **inputChannelData, int totalNumInputChannels, float **outputChannelData, int totalNumOutputChannels, int numSamples) override
 
void audioDeviceAboutToStart (AudioIODevice *device) override
 
void audioDeviceStopped () override
 
void prepareToPlay (double sampleRate, int blockSize)
 
- Public Member Functions inherited from AudioIODeviceCallback
virtual ~AudioIODeviceCallback ()
 
virtual void audioDeviceError (const String &errorMessage)
 

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.

Constructor & Destructor Documentation

AudioSourcePlayer::AudioSourcePlayer ( )

Creates an empty AudioSourcePlayer.

AudioSourcePlayer::~AudioSourcePlayer ( )
virtual

Destructor.

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

Member Function Documentation

void AudioSourcePlayer::audioDeviceAboutToStart ( AudioIODevice device)
overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

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

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

void AudioSourcePlayer::audioDeviceStopped ( )
overridevirtual

Implementation of the AudioIODeviceCallback method.

Implements AudioIODeviceCallback.

AudioSource* AudioSourcePlayer::getCurrentSource ( ) const
inlinenoexcept

Returns the source that's playing. May return nullptr if there's no source.

float AudioSourcePlayer::getGain ( ) const
inlinenoexcept

Returns the current gain.

See Also
setGain
void AudioSourcePlayer::prepareToPlay ( double  sampleRate,
int  blockSize 
)

An alternative method for initialising the source without an AudioIODevice.

void AudioSourcePlayer::setGain ( float  newGain)
noexcept

Sets a gain to apply to the audio data.

See Also
getGain
void 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
newSourcethe 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.

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