Module tksampler

Classes

• StADSR - 
   
  
• StEnvelope - 
   
  
• StFFT - 
   
  
• StLFO - 
   
  
• StModSeq - 
   
  
• StPluginInfo - 
   
  
• StPluginLibrary - 
   
  
• StPluginShared - 
   
  
• StPluginSharedMissing - 
   
  
• StPluginVoice - 
   
  
• StRange - 
   
  
• StSample - 
    Constants:
  • int STSAMPLE_DEFAULT_MAXVOICES - 
  
   
  
• StSampleBank - 
   
  
• StSampleMutexGroup - 
   
  
• StSamplePlayer - Manages a finite number of StSampleVoice objects
    Methods:
  • allNotesOff() - Stop all currently playing voices (with fadeout but no release)
  • allNotesOffRelease() - Release all currently playing voices (like regular note offs)
  • allocVoices(int maxPolyphony) : boolean - Allocate internal voice pool
  • findFirstActiveSampleVoice(StSample sample) : StSampleVoice - Query voice object
  • findLastStartedVoice(StSample sample) : StSampleVoice - Query voice object
  • findPreviousGlideNoteByKey(int key) : int historyIdx:int - Return -1 or glide_prev_note for first gliding voice that is assigned the given voicekey.
  • findVoicesByKey(int key, PointerArray ret) : int - Find all voices that are assigned the given key.
  • getDefaultFreqTable() : FloatArray - Query default frequency table
  • getDefaultMixRate() : float - Query default mixrate
  • getNumActiveNotes() : int - Query number of currently (pressed) notes
  • getNumActiveVoices() : int - Query number of currently used (allocated) voices
  • getNumPlayingVoices() : int - Query number of currently used (allocated+playing) voices
  • getNumUsedVoices() : int - Query number of currently used voices
  • getNumVoices() : int - Query polyphony
  • getPolyMode() : int - Query voice allocation strategy
  • getVoice(int idx) : StSampleVoice - Query voice object
  • getVolume() : float - 
  • initStartedVoicesByKey(int key) - Really trigger note-on. Should be called after (initial) params have been set.
  • noteOff(int note, float velocity) : int - Begin release phase of all voices that were triggered on the given key
  • noteOffByKey(int voiceKey, float velocity) : int - Begin release phase of all voices that share the given voice key
  • removeFromGlideNoteHistory(int note, boolean bLastOnly) - Iterate voices and remove given note from glide note histories
  • render(FloatArray buf) - Render currently playing voices to the given (stereo) buffer (add).
  • renderWithInputs(FloatArray buf, PointerArray paInputs, boolean bRender) - Render currently playing voices to the given (stereo) buffer (add).
  • reset() - Immediately reset / stop all voices (no fadeout)
  • resetLFOAuxPhase() - Reset aux LFO phase
  • resetLFOFreqPhase() - Reset frequency LFO phase
  • resetLFOPanPhase() - Reset panning LFO phase
  • resetLFOVolPhase() - Reset volume LFO phase
  • resetModulator() - Reset all modulators
  • restartVoicesByKey(int key) - Reset playing voices.
  • setDefaultFreqTable(FloatArray freqTable) - Set default frequency table for new sample voices
  • setDefaultMixRate(float mixRate) - Set default mixrate for new sample voices
  • setPolyMode(int mode) - Select voice allocation strategy
  • setSoftPedal(float val) - Update soft pedal state (0..1) (for zone mod matrix)
  • setSustainPedal(float val) - Update sustain pedal state (0..1) (for zone mod matrix)
  • setVolume(float volume) - 
  • startSample(StSample sample, FloatArray freqTableOrNull, int note, float velocity, mod) : int - Allocate voice and prepare to play the given sample.
  • startSampleBank(StSampleBank sampleBank, FloatArray freqTableOrNull, int note, float velocity, mod) : int - Allocate voice(s) and play the samplebank samples that match the given note/velo/mod zones.
  • stopADSRFreqBySample(StSample sample) - Immediately stop all frequency ADSRs that belong to voices that play the given sample.
  • stopADSRPanBySample(StSample sample) - Immediately stop all pan ADSRs that belong to voices that play the given sample.
  • stopADSRVolBySample(StSample sample) - Immediately stop all volume ADSRs that belong to voices that play the given sample.
  • stopLFOFreqBySample(StSample sample) - Immediately stop all frequency LFOs that belong to voices that play the given sample.
  • stopLFOPanBySample(StSample sample) - Immediately stop all pan LFOs that belong to voices that play the given sample.
  • stopLFOVolBySample(StSample sample) - Immediately stop all volume LFOs that belong to voices that play the given sample.
  • stopVoicesByKey(int voiceKey) - Immediately stop all voices that are assigned the given key (no fadeout)
  • stopVoicesBySample(StSample sample) - Stop all voices that play the given sample (with fadeout)
  • stopVoicesBySample(StSample sample) - Immediately stop all voices that play the given sample (no fadeout)
  • updateAAuxSpd(float int) - Update aux attack speed of all active voices
  • updateADSFreqInt(float int) - Update frequency ADSR intensity of all active voices
  • updateADSRAuxInt(float int) - Update aux ADSR intensity of all active voices
  • updateADSRAuxLvl(float lvl) - Update aux ADSR level of all active voices
  • updateADSRAuxSpd(float spd) - Update aux ADSR speed of all active voices
  • updateADSRFreqLvl(float lvl) - Update frequency ADSR level of all active voices
  • updateADSRFreqSpd(float spd) - Update frequency ADSR speed of all active voices
  • updateADSRPanInt(float int) - Update pan ADSR intensity of all active voices
  • updateADSRPanLvl(float lvl) - Update pan ADSR level of all active voices
  • updateADSRPanSpd(float spd) - Update pan ADSR speed of all active voices
  • updateADSRVolInt(float int) - Update volume ADSR intensity of all active voices
  • updateADSRVolLvl(float lvl) - Update volume ADSR level of all active voices
  • updateADSRVolSpd(float spd) - Update volume ADSR speed of all active voices
  • updateAFreqSpd(float int) - Update freq attack speed of all active voices
  • updateAltVolume(float v) - Update alternative volume modulation of all active voices
  • updateAPanSpd(float int) - Update pan attack speed of all active voices
  • updateAVolSpd(float int) - Update volume attack speed of all active voices
  • updateCycleLen(float v) - Update timestretch granularity modulation of all active voices
  • updateFltCutOff(float f) - Update filter cutoff of all active voices
  • updateFltOffset(float f) - Update filter offset of all active voices
  • updateFltPan(float f) - Update filter panning of all active voices
  • updateFltRes(float f) - Update filter resonance of all active voices
  • updateFreq(float v) - Update frequency modulation of all active voices
  • updateFreq2(float v) - Update frequency modulation #2 of all active voices
  • updateGlideSpeed(float speed) - Update glide speed of all active voices
  • updateGlideSwitch(boolean bEnable) - Update glide switch of all active voices
  • updateJumpToLoop(int idx) - Make all playing voices jump to the given loop
  • updateJumpToLoopRel(int idx) - Make all playing voices jump to the given loop (0..1 => 0..num_loops-1)
  • updateLFOAuxFltAmt(float amt) - Update aux LFO => filter cutoff amount modifier
  • updateLFOAuxLvl(float lvl) - Update aux LFO level of all active voices
  • updateLFOAuxSpd(float spd) - Update aux LFO speed of all active voices
  • updateLFOFreqAmt(float amt) - Update frequency LFO => frequency amount modifier
  • updateLFOFreqLvl(float lvl) - Update frequency LFO level of all active voices
  • updateLFOFreqSpd(float spd) - Update frequency LFO speed of all active voices
  • updateLFOPanAmt(float amt) - Update pan LFO => pan amount modifier
  • updateLFOPanLvl(float lvl) - Update pan LFO level of all active voices
  • updateLFOPanSpd(float spd) - Update pan LFO speed of all active voices
  • updateLFOVolAmt(float amt) - Update volume LFO => volume amount modifier
  • updateLFOVolLvl(float lvl) - Update volume LFO level of all active voices
  • updateLFOVolSpd(float spd) - Update volume LFO speed of all active voices
  • updateMod(float v) - Update modulation of all active voices
  • updatePan(float v) - Update panning modulation of all active voices
  • updatePerfCtl(int idx, float val) - Update performance controller (original MIDI range, 0..127 or 0..16383)
  • updatePerfCtls(FloatArray initialPerfCtl) - Update performance controllers. Skip when value is <0.
  • updateRAuxSpd(float int) - Update aux release speed of all active voices
  • updateRetrigMask(int v) - Retrigger envelope/LFO of all active voices
  • updateRFreqSpd(float int) - Update freq release speed of all active voices
  • updateRPanSpd(float int) - Update pan release speed of all active voices
  • updateRVolSpd(float int) - Update volume release speed of all active voices
  • updateSampleOff(float v) - Update sample offset modulation of all active voices
  • updateSampleShift(float v) - Update sample shift modulation of all active voices
  • updateSampleShiftEndOfLoop(float v) - Update sample shift modulation of all active voices (queue until end of loop)
  • updateSAuxSpd(float int) - Update aux sustain speed of all active voices
  • updateSFreqSpd(float int) - Update freq sustain speed of all active voices
  • updateSPanSpd(float int) - Update pan sustain speed of all active voices
  • updateSVolSpd(float int) - Update volume sustain speed of all active voices
  • updateTimestretch(float v) - Update timestretch modulation of all active voices
  • updateTimestretchBend(float v) - Update timestretch phase bend modulation of all active voices
  • updateVol(float v) - Update volume modulation of all active voices
  • updateWavepathIndex(int idx) - Make all playing voices jump to the given cycle index (granular mode)
  
    Constants:
  • int STSAMPLEPLAYER_MAXVOICES - 
  • int STSAMPLEPLAYER_NUM_POLYMODES - 
  • int STSAMPLEPLAYER_POLYMODE_HIGHEST - 
  • int STSAMPLEPLAYER_POLYMODE_LOWEST - 
  • int STSAMPLEPLAYER_POLYMODE_OLDEST - 
  
  
• StSampleVoice - *
    Methods:
  • getAltVolume() : float - Return alternative volume modulation
  • getCycleLen() : float - Return sample cycle length modulation
  • getFreq() : float - Return frequency modulation
  • getFreq2() : float - Return frequency modulation
  • getMod() : float - Return modulation
  • getPan() : float - Return panning modulation
  • getPan2() : float - Return panning modulation (randomization)
  • getSampleOff() : float - Return sample offset modulation
  • getSampleOff2() : float - Return sample offset modulation (randomization)
  • getSampleShift() : float - Return sample shift modulation
  • getSampleShiftEndOfLoop() : float - Return sample shift modulation (queued until end of loop)
  • getTimedLoopBase() : float - 
  • getTimestretch() : float - Return timestretch modulation
  • getTimestretchBend() : float - Return timestretch phase bend modulation
  • getVoiceIndex() : int - Query index of sample voice in sample player voice array
  • getVol() : float - Return volume modulation
  • getVol2() : float - Return volume modulation (randomization)
  • init(StSample sample, FloatArray freqTable, float mixRate, int note) - Initialize sample voice.
  • mmVarGetIdx() : int - Returns currently playing mod matrix variation index (0..15)
  • noteOff(float velocity) - Start release phase
  • noteToFreq(float note) : float - Map MIDI note to frequency (Hz) using currently set freq_table.
  • PrintDebugStats() - Pseudo-static method that prints mixer codepath statistics (for debugging/optimization)
  • render(FloatArray buf) - 
  • resetLFOAuxPhase() - Reset aux LFO phase
  • resetLFOFreqPhase() - Reset frequency LFO phase
  • resetLFOPanPhase() - Reset panning LFO phase
  • resetLFOVolPhase() - Reset volume LFO phase
  • restartVoice() - Reset currently playing voice
  • retrigEnvLFO(int mask) - Retrigger envelopes/LFOs
  • setAAuxSpd(float int) - Set aux attack speed modifier
  • setADSRAuxInt(float int) - Set aux ADSR intensity modifier
  • setADSRAuxLvl(float lvl) - Set aux ADSR level modifier
  • setADSRAuxSpd(float spd) - Set aux ADSR speed modifier
  • setADSRFreqInt(float int) - Set frequency ADSR intensity modifier
  • setADSRFreqLvl(float lvl) - Set frequency ADSR level modifier
  • setADSRFreqSpd(float spd) - Set frequency ADSR speed modifier
  • setADSRPanInt(float int) - Set pan ADSR intensity modifier
  • setADSRPanLvl(float lvl) - Set pan ADSR level modifier
  • setADSRPanSpd(float spd) - Set pan ADSR speed modifier
  • setADSRVolInt(float int) - Set volume ADSR intensity modifier
  • setADSRVolLvl(float lvl) - Set volume ADSR level modifier
  • setADSRVolSpd(float spd) - Set volume ADSR speed modifier
  • setAFreqSpd(float int) - Set freq attack speed modifier
  • setAltVolume(float av) - Set alternative volume modulation
  • setAPanSpd(float int) - Set pan attack speed modifier
  • setAVolSpd(float int) - Set volume attack speed modifier
  • setCycleLen(float so) - Set granular cycle length modulation
  • setFilterCutOff(float f) - Set filter cutoff modifier
  • setFilterOffset(float f) - Set filter offset modifier
  • setFilterPan(float f) - Set filter stereo pan modifier
  • setFilterResonance(float f) - Set filter resonance modifier
  • setFreq(float freq) - Set frequency modulation
  • setFreq2(float freq) - Set frequency modulation 2 (additive, randomization)
  • setGlideSpeed(float speed) - Set glide speed
  • setGlideSwitch(boolean bEnable) - Set glide switch
  • setJumpToLoop(int idx) - Queue jump to loop
  • setJumpToLoopRel(float relIdx) - Queue jump to loop (0..1 => 0..num_loops-1)
  • setLFOAuxFltAmt(float amt) - Set aux LFO => flt amount modifier
  • setLFOAuxLvl(float lvl) - Set aux LFO level modifier
  • setLFOAuxSpd(float spd) - Set aux LFO speed modifier
  • setLFOFreqAmt(float amt) - Set frequency LFO => frequency amount modifier
  • setLFOFreqLvl(float lvl) - Set frequency LFO level modifier
  • setLFOFreqSpd(float spd) - Set frequency LFO speed modifier
  • setLFOPanAmt(float amt) - Set pan LFO => pan amount modifier
  • setLFOPanLvl(float lvl) - Set pan LFO level modifier
  • setLFOPanSpd(float spd) - Set pan LFO speed modifier
  • setLFOVolAmt(float amt) - Set volume LFO => volume amount modifier
  • setLFOVolLvl(float lvl) - Set volume LFO level modifier
  • setLFOVolSpd(float spd) - Set volume LFO speed modifier
  • setMod(float mod) - Set modulation
  • setModSeqAdvance(float advance) - 
  • setModSeqLevel(float level) - 
  • setModSeqNumStepsRel(float numStepsRel) - 
  • setModSeqRetrigMask(int mask) - 
  • setModSeqSpeed(float speed) - 
  • setPan(float pan) - Set panning modulation
  • setPan2(float pan) - Set panning modulation (randomization)
  • setRAuxSpd(float int) - Set aux release speed modifier
  • setRFreqSpd(float int) - Set freq release speed modifier
  • setRPanSpd(float int) - Set pan release speed modifier
  • setRVolSpd(float int) - Set volume release speed modifier
  • setSampleOff(float so) - Set sample offset modulation
  • setSampleOff2(float so) - Set sample offset modulation (randomization)
  • setSampleShift(float sh) - Set sample shift modulation
  • setSampleShiftEndOfLoop(float sh) - Set sample shift modulation (queued until end of loop)
  • setSAuxSpd(float int) - Set aux sustain speed modifier
  • setSFreqSpd(float int) - Set freq sustain speed modifier
  • setSPanSpd(float int) - Set pan sustain speed modifier
  • setSVolSpd(float int) - Set volume sustain speed modifier
  • setTimedLoopBase(float base) - Set timedloop repeat frequency (1sec/base)
  • setTimestretch(float ts) - Set timestretch modulation
  • setTimestretchBend(float ts) - Set timestretch phase bend modulation
  • setVol(float vol) - Set volume modulation
  • setVol2(float vol) - Set volume modulation 2 (randomization)
  • setWavepathIndex(int idx) - Queue next cycle
  • softStopVoice() - Fadeout voice and stop it
  • stopVoice() - Mark voice inactive (no fadeout)
  • updatePerfCtlPolyPressure(float value) - Update poly pressure (0..127)
  
  
• StWaveform -