PaUtilStreamInterface Struct Reference

#include <pa_stream.h>

Data Fields
PaError(*	Close )(PaStream *stream)
PaError(*	Start )(PaStream *stream)
PaError(*	Stop )(PaStream *stream)
PaError(*	Abort )(PaStream *stream)
PaError(*	IsStopped )(PaStream *stream)
PaError(*	IsActive )(PaStream *stream)
PaTime(*	GetTime )(PaStream *stream)
double(*	GetCpuLoad )(PaStream *stream)
PaError(*	Read )(PaStream *stream, void *buffer, unsigned long frames)
PaError(*	Write )(PaStream *stream, const void *buffer, unsigned long frames)
signed long(*	GetReadAvailable )(PaStream *stream)
signed long(*	GetWriteAvailable )(PaStream *stream)

Detailed Description

A structure representing an (abstract) interface to a host API. Contains pointers to functions which implement the interface.

All PaStreamInterface functions are guaranteed to be called with a non-null, valid stream parameter.

Field Documentation

Abort

PaError(* PaUtilStreamInterface::Abort) (PaStream *stream)

Referenced by Pa_CloseStream(), and PaUtil_InitializeStreamInterface().

Close

PaError(* PaUtilStreamInterface::Close) (PaStream *stream)

Referenced by Pa_CloseStream(), and PaUtil_InitializeStreamInterface().

GetCpuLoad

double(* PaUtilStreamInterface::GetCpuLoad) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

GetReadAvailable

signed long(* PaUtilStreamInterface::GetReadAvailable) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

GetTime

PaTime(* PaUtilStreamInterface::GetTime) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

GetWriteAvailable

signed long(* PaUtilStreamInterface::GetWriteAvailable) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

IsActive

PaError(* PaUtilStreamInterface::IsActive) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

IsStopped

PaError(* PaUtilStreamInterface::IsStopped) (PaStream *stream)

Referenced by Pa_CloseStream(), and PaUtil_InitializeStreamInterface().

Read

PaError(* PaUtilStreamInterface::Read) (PaStream *stream, void *buffer, unsigned long frames)

Referenced by PaUtil_InitializeStreamInterface().

Start

PaError(* PaUtilStreamInterface::Start) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

Stop

PaError(* PaUtilStreamInterface::Stop) (PaStream *stream)

Referenced by PaUtil_InitializeStreamInterface().

Write

PaError(* PaUtilStreamInterface::Write) (PaStream *stream, const void *buffer, unsigned long frames)

Referenced by PaUtil_InitializeStreamInterface().

---

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

• pa_stream.h