Class tksampler.StSampleVoice

• core.Object

• 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)

* The replayer (linearly) interpolates frequency/volume and panning across a "sample block". * Samples are also interpolated linearly. * Volume ramping can be done via the A(DS)R envelopes. * * Updated vol/pan/freq modulation info is read when a new block is started (copied from "queued" shadow members). * The default block size/length is STSAMPLEVOICE_BLOCK_LEN seconds, or 44.1 samples @44100Hz mixrate. * * The update mechanism is not "sample realtime" but behaves more like a hardware MIDI/USB sampler. * The latency depends on the output buffer size. * I recommend 256 samples @ 48Khz, i.e. 5 millisec latency. This should be fast enough for LFOs and arpeggiators.. * (also see the tkportaudio plugin for low latency audio I/O via Steinberg's ASIO2 API on Win32) * * The voice is marked inactive when * a) The end of the sample has been reached and there are no more loops * b) The volume release envelope finishes (i.e. some time after a note-off or immediately if there is no vol. envelope) * * The current replay note+finetune is mapped via a user-defined frequency table (can be changed per-voice). * * Reverse play and "scratch" fx currently only work with loop samples (i.e. the whole sample will be looped).