openshot-audio  0.1.5
Public Member Functions | List of all members
juce::SamplerVoice Class Reference

#include <juce_audio_formats.h>

Inheritance diagram for juce::SamplerVoice:
juce::SynthesiserVoice

Public Member Functions

 SamplerVoice ()
 
 ~SamplerVoice ()
 
bool canPlaySound (SynthesiserSound *) override
 
void startNote (int midiNoteNumber, float velocity, SynthesiserSound *, int pitchWheel) override
 
void stopNote (float velocity, bool allowTailOff) override
 
void pitchWheelMoved (int newValue) override
 
void controllerMoved (int controllerNumber, int newValue) override
 
void renderNextBlock (AudioSampleBuffer &, int startSample, int numSamples) override
 
- Public Member Functions inherited from juce::SynthesiserVoice
 SynthesiserVoice ()
 
virtual ~SynthesiserVoice ()
 
int getCurrentlyPlayingNote () const noexcept
 
SynthesiserSound::Ptr getCurrentlyPlayingSound () const noexcept
 
virtual bool isVoiceActive () const
 
virtual void aftertouchChanged (int newAftertouchValue)
 
virtual void channelPressureChanged (int newChannelPressureValue)
 
virtual void setCurrentPlaybackSampleRate (double newRate)
 
virtual bool isPlayingChannel (int midiChannel) const
 
double getSampleRate () const noexcept
 
bool isKeyDown () const noexcept
 
bool isSustainPedalDown () const noexcept
 
bool isSostenutoPedalDown () const noexcept
 
bool isPlayingButReleased () const noexcept
 
bool wasStartedBefore (const SynthesiserVoice &other) const noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from juce::SynthesiserVoice
void clearCurrentNote ()
 

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::SamplerVoice ( )

Creates a SamplerVoice.

◆ ~SamplerVoice()

SamplerVoice::~SamplerVoice ( )

Destructor.

Member Function Documentation

◆ canPlaySound()

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 juce::SynthesiserVoice.

◆ controllerMoved()

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 juce::SynthesiserVoice.

◆ pitchWheelMoved()

void SamplerVoice::pitchWheelMoved ( int  newPitchWheelValue)
overridevirtual

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 juce::SynthesiserVoice.

◆ renderNextBlock()

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 juce::SynthesiserVoice.

◆ startNote()

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 juce::SynthesiserVoice.

◆ stopNote()

void SamplerVoice::stopNote ( float  velocity,
bool  allowTailOff 
)
overridevirtual

Called to stop a note.

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

The velocity indicates how quickly the note was released - 0 is slowly, 1 is quickly.

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 juce::SynthesiserVoice.


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