→ home

→ index of namespace default

→ index of project tkportaudio

→ index of module tkportaudio

Class `tkportaudio.PortAudio`

Synopsis: Pseudo-static utility class which is used to init/tear down the library, query devices, open streams etc.

Base classes:

core.Object

Methods:

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.

Constants:

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)

Description:

For an example on how to use this library, see the "test.tks" script in the tkportaudio/ folder.

→ top of page

Method GetDefaultInputDeviceIndex

Query default input device index

Signature

GetDefaultInputDeviceIndex

(

)

int

Returns

int

–

→ top of page

Method GetDefaultOutputDeviceIndex

Query default output device index

Signature

GetDefaultOutputDeviceIndex

(

)

int

Returns

int

–

→ top of page

Method getDeviceInfo

Query information for the given device

Signature

getDeviceInfo	(	int	devIdx	)
	:	PaDeviceInfo

Arguments

int

devIdx

–

0..GetNumDevices()

Returns

PaDeviceInfo

–

→ top of page

Method GetNumDevices

Query number of available devices

Signature

GetNumDevices

(

)

int

Returns

int

–

→ top of page

Method GetSampleSize

Query sample size (number of bytes) for the given sample format.

Signature

GetSampleSize	(	int	sampleFormat	)
	:	int

Arguments

int sampleFormat – See PA_xxx constants, e.g. PA_INT24.

Returns

int

–

→ top of page

Method Initialize

Initialize the portaudio library

Signature

Initialize

(

)

→ top of page

Method IsFormatSupported

Signature

IsFormatSupported	(	PaStreamParameters	inParams	,
		PaStreamParameters	outParams	,
		float	sampleRate
		)
	:	boolean

Arguments

PaStreamParameters	inParams	–
PaStreamParameters	outParams	–
float	sampleRate	–

Returns

boolean

–

→ top of page

Method OpenStream

Open audio stream and initialize the given PaStream object.

Signature

OpenStream	(	PaStreamParameters	inParams	,
		PaStreamParameters	outParams	,
		float	sampleRate	,
		Function	streamCbk	,
		PaStream	retStream
		)
	:	int

Arguments

PaStreamParameters	inParams	–	Input stream parameters
PaStreamParameters	outParams	–	Output stream parameters
float	sampleRate	–	Sample rate (Hz)
Function	streamCbk	–	Stream callback function. Argument list must be (PaStream stream, FloatArray input, FloatArray output, int numFrames).
PaStream	retStream	–	The stream object to initialize

Returns

int

–

1(true) if the stream has been opened, 0(false) otherwise.

Description

Note: The stream callback always uses float arrays. Conversions to/from the actual sample formats are transparent to the application.

→ top of page

Method Terminate

Tear down the portaudio library.

Signature

Terminate

(

)

Description

All streams/info objects become invalid after this call (resp. their internal data does).

→ top of page

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

Class tkportaudio.PortAudio

Class `tkportaudio.PortAudio`