default
tksdl
tksdl
tksdl.SamplePlayer
getPan() : float
- Query panning offset for next noteOn calls
getPolyphony() : int
- Query polyphony
getSample() : AudioSample
- Query currently active sample
getVolume() : float
- Query global volume
noteOff(int note)
- Stop sample that is has been playing the given note for the longest time
noteOn(int note, float v)
- Trigger note using the currently active sample
processSamples(FloatArray fa)
- Render/mix samples to the given output stream
setPan(float v)
- Set panning offset for next noteOn
setPolyphony(int numVoices)
- Set polyphony
setSample(AudioSample sample)
- Set active sample
setVolume(float v)
- Set global volume
It's probably only good enough for simple game sound effects. Never used it for anything else, anyway ;)
Maximum polyphony is 16 voices.
Method getPan | |||||
Query panning offset for next noteOn calls | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPolyphony | |||||
Query polyphony | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getSample | |||||
Query currently active sample | |||||
Signature | |||||
| |||||
Returns | |||||
Method getVolume | |||||
Query global volume | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method noteOff | |||||
Stop sample that is has been playing the given note for the longest time | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method noteOn | |||||||||||||||
Trigger note using the currently active sample | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method processSamples | |||||
Render/mix samples to the given output stream | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPan | |||||
Set panning offset for next noteOn | |||||
Signature | |||||
| |||||
Arguments | |||||
| |||||
Description | |||||
TODO: why is this not a parameter to the noteOn() method |
Method setPolyphony | |||||
Set polyphony | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSample | |||||
Set active sample | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setVolume | |||||
Set global volume | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Project Modules: | tksdl |
Project Classes: | AudioDevice , AudioSample , Cursor , FPS , Joystick , Key , Mouse , SamplePlayer , SDL , Viewport |
Project Functions: | MIDINoteToFrequency |
All Namespaces: | default , ui |
All Projects: | core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit |
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54