pa_asio.h File Reference

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

#include "portaudio.h"

Go to the source code of this file.

Data Structures

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)
PaError PaAsio_SetStreamSampleRate (PaStream *stream, double sampleRate)


Detailed Description

ASIO-specific PortAudio API extension header file.


Define Documentation

#define paAsioUseChannelSelectors   (0x01)


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 be renamed to PaAsio_GetAvailableBufferSizes. No reason to use a wildly different name from the ASIO version.

References PaAsioDeviceInfo::bufferGranularity, PaUtilHostApiRepresentation::deviceInfos, PaAsioDeviceInfo::maxBufferSize, PaAsioDeviceInfo::minBufferSize, paASIO, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), PaUtil_GetHostApiRepresentation(), and PaAsioDeviceInfo::preferredBufferSize.

Referenced by main().

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.

References PaAsioDeviceInfo::asioChannelInfos, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::maxInputChannels, paASIO, paInvalidChannelCount, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), and PaUtil_GetHostApiRepresentation().

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.

References PaAsioDeviceInfo::asioChannelInfos, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::maxInputChannels, PaDeviceInfo::maxOutputChannels, paASIO, paInvalidChannelCount, paNoError, PaUtil_DeviceIndexToHostApiDeviceIndex(), and PaUtil_GetHostApiRepresentation().

PaError PaAsio_SetStreamSampleRate ( PaStream stream,
double  sampleRate 
)

Set the sample rate of an open paASIO stream.

Parameters:
stream The stream to operate on.
sampleRate The new sample rate.
Note that this function may fail if the stream is alredy running and the ASIO driver does not support switching the sample rate of a running stream.

Returns paIncompatibleStreamHostApi if stream is not a paASIO stream.

References paBadStreamPtr, and paNoError.

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.

References PaAsioHostApiRepresentation::asioDrivers, PaAsioDeviceInfo::commonDeviceInfo, PaUtilHostApiRepresentation::deviceInfos, PaDeviceInfo::name, PaAsioHostApiRepresentation::openAsioDeviceIndex, PA_ASIO_SET_LAST_ASIO_ERROR, PA_DEBUG, paASIO, paDeviceUnavailable, paNoDevice, paNoError, paUnanticipatedHostError, PaUtil_DeviceIndexToHostApiDeviceIndex(), and PaUtil_GetHostApiRepresentation().


Generated on Tue Aug 9 14:05:53 2011 for PortAudio by  doxygen 1.5.7.1