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

A subclass of SynthesiserVoice that can play a SamplerSound. More...

Inherits SynthesiserVoice.

Public Member Functions

 SamplerVoice ()
 Creates a SamplerVoice.
 
 ~SamplerVoice ()
 Destructor.
 
bool canPlaySound (SynthesiserSound *) override
 Must return true if this voice object is capable of playing the given sound.
 
void startNote (int midiNoteNumber, float velocity, SynthesiserSound *, int pitchWheel) override
 Called to start a new note.
 
void stopNote (bool allowTailOff) override
 Called to stop a note.
 
void pitchWheelMoved (int newValue)
 Called to let the voice know that the pitch wheel has been moved.
 
void controllerMoved (int controllerNumber, int newValue) override
 Called to let the voice know that a midi controller has been moved.
 
void renderNextBlock (AudioSampleBuffer &, int startSample, int numSamples) override
 Renders the next block of data for this voice.
 
- Public Member Functions inherited from SynthesiserVoice
 SynthesiserVoice ()
 Creates a voice.
 
virtual ~SynthesiserVoice ()
 Destructor.
 
int getCurrentlyPlayingNote () const noexcept
 Returns the midi note that this voice is currently playing.
 
SynthesiserSound::Ptr getCurrentlyPlayingSound () const noexcept
 Returns the sound that this voice is currently playing.
 
virtual void aftertouchChanged (int newAftertouchValue)
 Called to let the voice know that the aftertouch has changed.
 
bool isPlayingChannel (int midiChannel) const
 Returns true if the voice is currently playing a sound which is mapped to the given midi channel.
 
void setCurrentPlaybackSampleRate (double newRate)
 Changes the voice's reference sample rate.
 
bool isKeyDown () const noexcept
 Returns true if the key that triggered this voice is still held down.
 
bool isSostenutoPedalDown () const noexcept
 Returns true if the sostenuto pedal is currently active for this voice.
 
bool wasStartedBefore (const SynthesiserVoice &other) const noexcept
 Returns true if this voice started playing its current note before the other voice did.
 

Additional Inherited Members

- Protected Member Functions inherited from SynthesiserVoice
double getSampleRate () const
 Returns the current target sample rate at which rendering is being done.
 
void clearCurrentNote ()
 Resets the state of this voice after a sound has finished playing.
 

Detailed Description

A subclass of SynthesiserVoice that can play a SamplerSound.

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

See Also
SamplerSound, Synthesiser, SynthesiserVoice

Constructor & Destructor Documentation

SamplerVoice::SamplerVoice ( )

Creates a SamplerVoice.

SamplerVoice::~SamplerVoice ( )

Destructor.

Member Function Documentation

bool SamplerVoice::canPlaySound ( SynthesiserSound )
overridevirtual

Must return true if this voice object is capable of playing the given sound.

If there are different classes of sound, and different classes of voice, a voice can choose which ones it wants to take on.

A typical implementation of this method may just return true if there's only one type of voice and sound, or it might check the type of the sound object passed-in and see if it's one that it understands.

Implements SynthesiserVoice.

void SamplerVoice::startNote ( int  midiNoteNumber,
float  velocity,
SynthesiserSound sound,
int  currentPitchWheelPosition 
)
overridevirtual

Called to start a new note.

This will be called during the rendering callback, so must be fast and thread-safe.

Implements SynthesiserVoice.

void SamplerVoice::stopNote ( bool  allowTailOff)
overridevirtual

Called to stop a note.

This will be called during the rendering callback, so must be fast and thread-safe.

If allowTailOff is false or the voice doesn't want to tail-off, then it must stop all sound immediately, and must call clearCurrentNote() to reset the state of this voice and allow the synth to reassign it another sound.

If allowTailOff is true and the voice decides to do a tail-off, then it's allowed to begin fading out its sound, and it can stop playing until it's finished. As soon as it finishes playing (during the rendering callback), it must make sure that it calls clearCurrentNote().

Implements SynthesiserVoice.

void SamplerVoice::pitchWheelMoved ( int  newPitchWheelValue)
virtual

Called to let the voice know that the pitch wheel has been moved.

This will be called during the rendering callback, so must be fast and thread-safe.

Implements SynthesiserVoice.

void SamplerVoice::controllerMoved ( int  controllerNumber,
int  newControllerValue 
)
overridevirtual

Called to let the voice know that a midi controller has been moved.

This will be called during the rendering callback, so must be fast and thread-safe.

Implements SynthesiserVoice.

void SamplerVoice::renderNextBlock ( AudioSampleBuffer outputBuffer,
int  startSample,
int  numSamples 
)
overridevirtual

Renders the next block of data for this voice.

The output audio data must be added to the current contents of the buffer provided. Only the region of the buffer between startSample and (startSample + numSamples) should be altered by this method.

If the voice is currently silent, it should just return without doing anything.

If the sound that the voice is playing finishes during the course of this rendered block, it must call clearCurrentNote(), to tell the synthesiser that it has finished.

The size of the blocks that are rendered can change each time it is called, and may involve rendering as little as 1 sample at a time. In between rendering callbacks, the voice's methods will be called to tell it about note and controller events.

Implements SynthesiserVoice.


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