default
tkportaudio
tkportaudio
tkportaudio.PortAudio
GetDefaultInputDeviceIndex() : int
- Query default input device index
GetDefaultOutputDeviceIndex() : int
- Query default output device index
getDeviceInfo(int devIdx) : PaDeviceInfo
- Query information for the given device
GetNumDevices() : int
- Query number of available devices
GetSampleSize(int sampleFormat) : int
- Query sample size (number of bytes) for the given sample format.
Initialize()
- Initialize the portaudio library
IsFormatSupported(PaStreamParameters inParams, outParams, float sampleRate) : boolean
-
OpenStream(PaStreamParameters inParams, outParams, float sampleRate, Function streamCbk, PaStream retStream) : int
- Open audio stream and initialize the given PaStream object.
Terminate()
- Tear down the portaudio library. int
PA_FLOAT
- single precision floating point sample format (4 bytes)
int
PA_INT16
- 16bit signed integer sample format (2 bytes)
int
PA_INT24
- 24bit signed integer sample format (3 bytes)
int
PA_INT32
- 32bit signed integer sample format (4 bytes)
int
PA_INT8
- 8bit signed integer sample format (1 byte)
int
PA_UINT8
- 8bit unsigned integer sample format (1 byte)
For an example on how to use this library, see the "test.tks" script in the tkportaudio/ folder.
Method GetDefaultInputDeviceIndex | |||||
Query default input device index | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method GetDefaultOutputDeviceIndex | |||||
Query default output device index | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDeviceInfo | ||||||||||
Query information for the given device | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method GetNumDevices | |||||
Query number of available devices | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method GetSampleSize | ||||||||||
Query sample size (number of bytes) for the given sample format. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method Initialize | |||
Initialize the portaudio library | |||
Signature | |||
|
Method IsFormatSupported | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Method OpenStream | |||||||||||||||||||||||||||||||||||
Open audio stream and initialize the given PaStream object. | |||||||||||||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Description | |||||||||||||||||||||||||||||||||||
Note: The stream callback always uses float arrays. Conversions to/from the actual sample formats are transparent to the application. |
Method Terminate | |||
Tear down the portaudio library. | |||
Signature | |||
| |||
Description | |||
All streams/info objects become invalid after this call (resp. their internal data does). |
Constant PA_FLOAT (int) | |
single precision floating point sample format (4 bytes) | |
Constant PA_INT16 (int) | |
16bit signed integer sample format (2 bytes) | |
Constant PA_INT24 (int) | |
24bit signed integer sample format (3 bytes) | |
Constant PA_INT32 (int) | |
32bit signed integer sample format (4 bytes) | |
Constant PA_INT8 (int) | |
8bit signed integer sample format (1 byte) | |
Constant PA_UINT8 (int) | |
8bit unsigned integer sample format (1 byte) | |
Project Modules: | tkportaudio |
Project Classes: | PaDeviceInfo , PaHostApiInfo , PaStream , PaStreamParameters , PortAudio |
Project Functions: | |
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