PaHostApiInfo Struct Reference

#include <portaudio.h>

Data Fields
int	structVersion
PaHostApiTypeId	type
const char *	name
int	deviceCount
PaDeviceIndex	defaultInputDevice
PaDeviceIndex	defaultOutputDevice

Detailed Description

A structure containing information about a particular host API.

Field Documentation

defaultInputDevice

PaDeviceIndex PaHostApiInfo::defaultInputDevice

The default input device for this host API. The value will be a device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice if no default input device is available.

Referenced by main(), Pa_GetDefaultInputDevice(), PaAsiHpi_Initialize(), PaAudioIO_Initialize(), PaPulseAudio_Initialize(), and PaPulseAudio_StartStreamCb().

defaultOutputDevice

PaDeviceIndex PaHostApiInfo::defaultOutputDevice

The default output device for this host API. The value will be a device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice if no default output device is available.

Referenced by main(), main(), Pa_GetDefaultOutputDevice(), PaAsiHpi_Initialize(), PaAudioIO_Initialize(), PaPulseAudio_Initialize(), and PaPulseAudio_StartStreamCb().

deviceCount

int PaHostApiInfo::deviceCount

The number of devices belonging to this host API. This field may be used in conjunction with Pa_HostApiDeviceIndexToDeviceIndex() to enumerate all devices for this host API.

See also

Pa_HostApiDeviceIndexToDeviceIndex

Referenced by PaAsiHpi_Initialize(), PaAudioIO_Initialize(), and PaUtil_DeviceIndexToHostApiDeviceIndex().

name

const char* PaHostApiInfo::name

A textual description of the host API for display on user interfaces. Encoded as UTF-8.

Referenced by main(), main(), Pa_GetHostApiInfo(), PaAsiHpi_Initialize(), PaAudioIO_Initialize(), and PaQa_ListAudioDevices().

structVersion

int PaHostApiInfo::structVersion

this is struct version 1

Referenced by Pa_GetHostApiInfo(), PaAsiHpi_Initialize(), PaAsio_Initialize(), PaAudioIO_Initialize(), PaJack_Initialize(), PaMacCore_Initialize(), PaOSS_Initialize(), PaPulseAudio_Initialize(), PaSkeleton_Initialize(), PaSndio_Initialize(), PaWasapi_Initialize(), PaWinDs_Initialize(), PaWinMme_Initialize(), and PaWinWdm_Initialize().

type

PaHostApiTypeId PaHostApiInfo::type

The well known unique identifier of this host API

See also

PaHostApiTypeId

Referenced by main(), Pa_GetHostApiInfo(), PaAsiHpi_Initialize(), and PaAudioIO_Initialize().

---

The documentation for this struct was generated from the following file:

• portaudio.h