pa_hostapi_skeleton.c File Reference

Skeleton implementation of support for a host API. More...

#include <string.h>
#include "pa_util.h"
#include "pa_allocation.h"
#include "pa_hostapi.h"
#include "pa_stream.h"
#include "pa_cpuload.h"
#include "pa_process.h"

Data Structures
struct	PaSkeletonHostApiRepresentation
struct	PaSkeletonStream

Macros
#define	PA_SKELETON_SET_LAST_HOST_ERROR(errorCode, errorText)   PaUtil_SetLastHostErrorInfo( paInDevelopment, errorCode, errorText )

Typedefs
typedef struct PaSkeletonStream	PaSkeletonStream

Functions
PaError	PaSkeleton_Initialize (PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index)

Detailed Description

Skeleton implementation of support for a host API.

This file is provided as a starting point for implementing support for a new host API. It provides examples of how the common code can be used.

Note

IMPLEMENT ME comments are used to indicate functionality which much be customised for each implementation.

Macro Definition Documentation

#define PA_SKELETON_SET_LAST_HOST_ERROR	(		errorCode,
			errorText
	)		PaUtil_SetLastHostErrorInfo( paInDevelopment, errorCode, errorText )

Typedef Documentation

typedef struct PaSkeletonStream PaSkeletonStream

Function Documentation

PaError PaSkeleton_Initialize	(	PaUtilHostApiRepresentation **	hostApi,
		PaHostApiIndex	index
	)

References PaSkeletonHostApiRepresentation::allocations, PaSkeletonHostApiRepresentation::blockingStreamInterface, PaSkeletonHostApiRepresentation::callbackStreamInterface, PaDeviceInfo::defaultHighInputLatency, PaDeviceInfo::defaultHighOutputLatency, PaDeviceInfo::defaultLowInputLatency, PaDeviceInfo::defaultLowOutputLatency, PaDeviceInfo::defaultSampleRate, GetStreamReadAvailable(), GetStreamWriteAvailable(), PaDeviceInfo::hostApi, PaUtilHostApiRepresentation::info, PaSkeletonHostApiRepresentation::inheritedHostApiRep, PaUtilHostApiRepresentation::IsFormatSupported, PaDeviceInfo::maxInputChannels, PaDeviceInfo::maxOutputChannels, PaDeviceInfo::name, PaUtilHostApiRepresentation::OpenStream, paInDevelopment, paInsufficientMemory, paNoDevice, paNoError, PaUtil_AllocateMemory(), PaUtil_CreateAllocationGroup(), PaUtil_DestroyAllocationGroup(), PaUtil_DummyGetCpuLoad(), PaUtil_DummyGetReadAvailable(), PaUtil_DummyGetWriteAvailable(), PaUtil_DummyRead(), PaUtil_DummyWrite(), PaUtil_FreeAllAllocations(), PaUtil_FreeMemory(), PaUtil_GroupAllocateMemory(), PaUtil_InitializeStreamInterface(), ReadStream(), PaHostApiInfo::structVersion, PaDeviceInfo::structVersion, PaUtilHostApiRepresentation::Terminate, and WriteStream().