pa_asio.h File Reference

ASIO-specific PortAudio API extension header file. More...

#include "portaudio.h"

Go to the source code of this file.

Classes
struct	PaAsioStreamInfo
Defines
#define	paAsioUseChannelSelectors   (0x01)
Functions
PaError	PaAsio_GetAvailableLatencyValues (PaDeviceIndex device, long *minLatency, long *maxLatency, long *preferredLatency, long *granularity)
PaError	PaAsio_ShowControlPanel (PaDeviceIndex device, void *systemSpecific)
PaError	PaAsio_GetInputChannelName (PaDeviceIndex device, int channelIndex, const char **channelName)
PaError	PaAsio_GetOutputChannelName (PaDeviceIndex device, int channelIndex, const char **channelName)

---

Detailed Description

ASIO-specific PortAudio API extension header file.

Definition in file pa_asio.h.

---

Function Documentation

PaError PaAsio_GetAvailableLatencyValues	(	PaDeviceIndex	device,
		long *	minLatency,
		long *	maxLatency,
		long *	preferredLatency,
		long *	granularity
	)

Retrieve legal latency settings for the specificed device, in samples.

Parameters:

	device	The global index of the device about which the query is being made.
	minLatency	A pointer to the location which will recieve the minimum latency value.
	maxLatency	A pointer to the location which will recieve the maximum latency value.
	preferredLatency	A pointer to the location which will recieve the preferred latency value.
	granularity	A pointer to the location which will recieve the granularity. This value determines which values between minLatency and maxLatency are available. ie the step size, if granularity is -1 then available latency settings are powers of two.

See also:

ASIOGetBufferSize in the ASIO SDK.

Todo:

This function should have a better name, any suggestions?

PaError PaAsio_ShowControlPanel	(	PaDeviceIndex	device,
		void *	systemSpecific
	)

Display the ASIO control panel for the specified device.

Parameters:

	device	The global index of the device whose control panel is to be displayed.
	systemSpecific	On Windows, the calling application's main window handle, on Macintosh this value should be zero.

PaError PaAsio_GetInputChannelName	(	PaDeviceIndex	device,
		int	channelIndex,
		const char **	channelName
	)

Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.

The string will be no longer than 32 characters including the null terminator.

PaError PaAsio_GetOutputChannelName	(	PaDeviceIndex	device,
		int	channelIndex,
		const char **	channelName
	)

Retrieve a pointer to a string containing the name of the specified input channel. The string is valid until Pa_Terminate is called.

The string will be no longer than 32 characters including the null terminator.