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 String &	getName () const
	Returns the sample's name.
AudioSampleBuffer *	getAudioData () const
	Returns the audio sample data.
bool	appliesToNote (const int midiNoteNumber)
	Returns true if this sound should be played when a given midi note is pressed.
bool	appliesToChannel (const int midiChannel)
	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.
int	getReferenceCount () const noexcept
	Returns the object's current reference count.

Additional Inherited Members
Public Types inherited from SynthesiserSound
typedef ReferenceCountedObjectPtr < SynthesiserSound >	Ptr
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

name	a name for the sample
source	the audio to load. This object can be safely deleted by the caller after this constructor returns
midiNotes	the set of midi keys that this sound should be played on. This is used by the SynthesiserSound::appliesToNote() method
midiNoteForNormalPitch	the 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
attackTimeSecs	the attack (fade-in) time, in seconds
releaseTimeSecs	the decay (fade-out) time, in seconds
maxSampleLengthSeconds	a maximum length of audio to read from the audio source, in seconds

SamplerSound::~SamplerSound

(

)

Destructor.

Member Function Documentation

const String& SamplerSound::getName

(

)

const

Returns the sample's name.

AudioSampleBuffer* SamplerSound::getAudioData

(

)

const

Returns the audio sample data.

This could be 0 if there was a problem loading it.

bool SamplerSound::appliesToNote ( const int  midiNoteNumber )

virtual

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 ( const int  midiChannel )

virtual

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:

• juce_Sampler.h