openshot-audio  0.1.7
Public Member Functions | Public Attributes | List of all members
juce::AudioSourceChannelInfo Struct Reference

#include <juce_audio_basics.h>

Public Member Functions

 AudioSourceChannelInfo () noexcept
 
 AudioSourceChannelInfo (AudioSampleBuffer *bufferToUse, int startSampleOffset, int numSamplesToUse) noexcept
 
 AudioSourceChannelInfo (AudioSampleBuffer &bufferToUse) noexcept
 
void clearActiveBufferRegion () const
 

Public Attributes

AudioSampleBufferbuffer
 
int startSample
 
int numSamples
 

Detailed Description

Used by AudioSource::getNextAudioBlock().

Constructor & Destructor Documentation

juce::AudioSourceChannelInfo::AudioSourceChannelInfo ( )
inlinenoexcept

Creates an uninitialised AudioSourceChannelInfo.

juce::AudioSourceChannelInfo::AudioSourceChannelInfo ( AudioSampleBuffer bufferToUse,
int  startSampleOffset,
int  numSamplesToUse 
)
inlinenoexcept
juce::AudioSourceChannelInfo::AudioSourceChannelInfo ( AudioSampleBuffer bufferToUse)
inlineexplicitnoexcept

Creates an AudioSourceChannelInfo that uses the whole of a buffer. Note that the buffer provided must not be deleted while the AudioSourceChannelInfo is still using it.

Member Function Documentation

void juce::AudioSourceChannelInfo::clearActiveBufferRegion ( ) const
inline

Convenient method to clear the buffer if the source is not producing any data.

Member Data Documentation

AudioSampleBuffer* juce::AudioSourceChannelInfo::buffer

The destination buffer to fill with audio data.

When the AudioSource::getNextAudioBlock() method is called, the active section of this buffer should be filled with whatever output the source produces.

Only the samples specified by the startSample and numSamples members of this structure should be affected by the call.

The contents of the buffer when it is passed to the AudioSource::getNextAudioBlock() method can be treated as the input if the source is performing some kind of filter operation, but should be cleared if this is not the case - the clearActiveBufferRegion() is a handy way of doing this.

The number of channels in the buffer could be anything, so the AudioSource must cope with this in whatever way is appropriate for its function.

int juce::AudioSourceChannelInfo::numSamples

The number of samples in the buffer which the callback is expected to fill with data.

int juce::AudioSourceChannelInfo::startSample

The first sample in the buffer from which the callback is expected to write data.


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