default
tksdl
tksdl
tksdl.AudioDevice
closeDSP()
- Close sound device
enableFileOutput(boolean bEnabled)
- Enable/disable file output
finishBlock()
- Finally send sample block to audio device
getBpm() : float
- Query beats per minute
getPpq() : int
- Query precision per quarter
getSwapstereo() : boolean
- Query whether stereo channels are swapped
getVolume() : float
- Query master volume
openDSP(float freq, int bufSize) : boolean
- Open sound device with the given parameters
processTimeFrames()
- Trigger onAudioFrame(), onAudioRender() signal callbacks
setBpm(float bpm)
- Set beats per minute
setDefaultBufferSize(int bufSize)
- Set output buffer size (and thus audio latency). Warning: Not all drivers can handle small buffer sizes. The default buffer size is 8192 samples
setFileName(String fileName)
- Where to write the sample data when file output is enabled
setPpq(int ppq)
- Set precision per quarter
setSwapstereo(boolean b)
- Enable stereo channel swapping
setVolume(float f)
- Set master volume for sample mixer.
start()
- Start sound output
stop()
- Stop sound output
This class emits the following signals:
onAudioFrame() - called whenever a new frame (according to PPQ and BPM) starts
onAudioPostProcess(FloatArray buf) - Called when a block of samples is about to be sent to the output device
onAudioRender(FloatArray buf) - Called when a new sample frame needs to be rendered
onAudioBeginBlock(FloatArray buf) - Called when a new block of samples needs to be rendered. The application may decide to call processTimeFrames() to trigger the onAudioFrame() and onAudioRender() callbacks. Note: This function runs in a separate thread.
Method closeDSP | |||
Close sound device | |||
Signature | |||
|
Method enableFileOutput | |||||
Enable/disable file output | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method finishBlock | |||
Finally send sample block to audio device | |||
Signature | |||
|
Method getBpm | |||||
Query beats per minute | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPpq | |||||
Query precision per quarter | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getSwapstereo | |||||
Query whether stereo channels are swapped | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getVolume | |||||
Query master volume | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method openDSP | ||||||||||||||||||||
Open sound device with the given parameters | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method processTimeFrames | |||
Trigger onAudioFrame(), onAudioRender() signal callbacks | |||
Signature | |||
|
Method setBpm | |||||
Set beats per minute | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setDefaultBufferSize | |||||
Set output buffer size (and thus audio latency). Warning: Not all drivers can handle small buffer sizes. The default buffer size is 8192 samples | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setFileName | |||||
Where to write the sample data when file output is enabled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPpq | |||||
Set precision per quarter | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSwapstereo | |||||
Enable stereo channel swapping | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setVolume | |||||
Set master volume for sample mixer. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method start | |||
Start sound output | |||
Signature | |||
|
Method stop | |||
Stop sound output | |||
Signature | |||
|
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