pa_hostapi.h File Reference

Interfaces and representation structures used by pa_front.c to manage and communicate with host API implementations. More...

#include "portaudio.h"

Go to the source code of this file.

Data Structures
struct	PaUtilPrivatePaFrontHostApiInfo
struct	PaUtilHostApiSpecificStreamInfoHeader
struct	PaUtilHostApiRepresentation
Typedefs
typedef PaError	PaUtilHostApiInitializer (PaUtilHostApiRepresentation **, PaHostApiIndex)
Variables
PaUtilHostApiInitializer *	paHostApiInitializers []
int	paDefaultHostApiIndex

---

Detailed Description

Interfaces and representation structures used by pa_front.c to manage and communicate with host API implementations.

---

Typedef Documentation

typedef PaError PaUtilHostApiInitializer(PaUtilHostApiRepresentation **, PaHostApiIndex)

Prototype for the initialization function which must be implemented by every host API.

This function should only return an error other than paNoError if it encounters an unexpected and fatal error (memory allocation error for example). In general, there may be conditions under which it returns a NULL interface pointer and also returns paNoError. For example, if the ASIO implementation detects that ASIO is not installed, it should return a NULL interface, and paNoError.

See also:

paHostApiInitializers

---

Variable Documentation

int paDefaultHostApiIndex

The index of the default host API in the paHostApiInitializers array.

There is a platform specific file which defines paDefaultHostApiIndex for that platform, see pa_win/pa_win_hostapis.c for example.

PaUtilHostApiInitializer* paHostApiInitializers[]

Note that ALSA is placed before OSS so that the latter is preferred over the latter on Linux.

---