PortAudio  2.0
Data Fields
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.

Definition at line 301 of file portaudio.h.

Field Documentation

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.

Definition at line 321 of file portaudio.h.

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.

Definition at line 327 of file portaudio.h.

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

Definition at line 315 of file portaudio.h.

const char* PaHostApiInfo::name

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

Definition at line 308 of file portaudio.h.

int PaHostApiInfo::structVersion

this is struct version 1

Definition at line 304 of file portaudio.h.

PaHostApiTypeId PaHostApiInfo::type

The well known unique identifier of this host API

See Also
PaHostApiTypeId

Definition at line 306 of file portaudio.h.


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