JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
SamplerSound Class Reference

A subclass of SynthesiserSound that represents a sampled audio clip. More...

Inherits SynthesiserSound.

Public Member Functions

 SamplerSound (const String &name, AudioFormatReader &source, const BigInteger &midiNotes, int midiNoteForNormalPitch, double attackTimeSecs, double releaseTimeSecs, double maxSampleLengthSeconds)
 Creates a sampled sound from an audio reader.
 
 ~SamplerSound ()
 Destructor.
 
const StringgetName () const noexcept
 Returns the sample's name.
 
AudioSampleBuffergetAudioData () const noexcept
 Returns the audio sample data.
 
bool appliesToNote (int midiNoteNumber) override
 Returns true if this sound should be played when a given midi note is pressed.
 
bool appliesToChannel (int midiChannel) override
 Returns true if the sound should be triggered by midi events on a given channel.
 
- Public Member Functions inherited from SynthesiserSound
virtual ~SynthesiserSound ()
 Destructor.
 
- Public Member Functions inherited from ReferenceCountedObject
void incReferenceCount () noexcept
 Increments the object's reference count.
 
void decReferenceCount () noexcept
 Decreases the object's reference count.
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count.
 
int getReferenceCount () const noexcept
 Returns the object's current reference count.
 

Additional Inherited Members

- Public Types inherited from SynthesiserSound
typedef
ReferenceCountedObjectPtr
< SynthesiserSound
Ptr
 The class is reference-counted, so this is a handy pointer class for it.
 
- Protected Member Functions inherited from SynthesiserSound
 SynthesiserSound ()
 

Detailed Description

A subclass of SynthesiserSound that represents a sampled audio clip.

This is a pretty basic sampler, and just attempts to load the whole audio stream into memory.

To use it, create a Synthesiser, add some SamplerVoice objects to it, then give it some SampledSound objects to play.

See Also
SamplerVoice, Synthesiser, SynthesiserSound

Constructor & Destructor Documentation

SamplerSound::SamplerSound ( const String name,
AudioFormatReader source,
const BigInteger midiNotes,
int  midiNoteForNormalPitch,
double  attackTimeSecs,
double  releaseTimeSecs,
double  maxSampleLengthSeconds 
)

Creates a sampled sound from an audio reader.

This will attempt to load the audio from the source into memory and store it in this object.

Parameters
namea name for the sample
sourcethe audio to load. This object can be safely deleted by the caller after this constructor returns
midiNotesthe set of midi keys that this sound should be played on. This is used by the SynthesiserSound::appliesToNote() method
midiNoteForNormalPitchthe midi note at which the sample should be played with its natural rate. All other notes will be pitched up or down relative to this one
attackTimeSecsthe attack (fade-in) time, in seconds
releaseTimeSecsthe decay (fade-out) time, in seconds
maxSampleLengthSecondsa maximum length of audio to read from the audio source, in seconds
SamplerSound::~SamplerSound ( )

Destructor.

Member Function Documentation

const String& SamplerSound::getName ( ) const
noexcept

Returns the sample's name.

AudioSampleBuffer* SamplerSound::getAudioData ( ) const
noexcept

Returns the audio sample data.

This could return nullptr if there was a problem loading the data.

bool SamplerSound::appliesToNote ( int  midiNoteNumber)
overridevirtual

Returns true if this sound should be played when a given midi note is pressed.

The Synthesiser will use this information when deciding which sounds to trigger for a given note.

Implements SynthesiserSound.

bool SamplerSound::appliesToChannel ( int  midiChannel)
overridevirtual

Returns true if the sound should be triggered by midi events on a given channel.

The Synthesiser will use this information when deciding which sounds to trigger for a given note.

Implements SynthesiserSound.


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