This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W
     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T
     open all    |    close all

GUI Interactions:
  B
  F
  H
  S
     open all    |    close all

GUI Layouts:
  L
     open all    |    close all

Games/Demos:
  M
     open all    |    close all

Third Party Libraries:
  P
  F
  Z
     open all    |    close all
Information about this Website / Informationen zu dieser Webseite:
In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module portaudio_module [Version: v01]

This documentation describes the Prokee module interface.

This module provides an interface for Prokee to the PortAudio library.
PortAudio is a free, cross-platform, open-source library for audio I/O.

PortAudio Website: http://www.portaudio.com

Git-Repository: https://www.assembla.com/spaces/portaudio/git/source
git@git.assembla.com:portaudio.git


Static Methods:
main
int portaudio_module::main(int argc,char **argv)
Pa_GetVersion
int Pa_GetVersion()
Pa_GetVersionText
const char *Pa_GetVersionText()
Pa_GetVersionInfo
const PaVersionInfo *Pa_GetVersionInfo()
Pa_GetErrorText
const char *Pa_GetErrorText(PaError errorCode)
Pa_Initialize
PaError Pa_Initialize()
Pa_Terminate
PaError Pa_Terminate()
Pa_GetHostApiCount
PaHostApiIndex Pa_GetHostApiCount()
Pa_GetDefaultHostApi
PaHostApiIndex Pa_GetDefaultHostApi()
Pa_GetHostApiInfo
const PaHostApiInfo *Pa_GetHostApiInfo(PaHostApiIndex hostApi)
Pa_HostApiTypeIdToHostApiIndex
PaHostApiIndex Pa_HostApiTypeIdToHostApiIndex(PaHostApiTypeId type)
Pa_HostApiDeviceIndexToDeviceIndex
PaDeviceIndex Pa_HostApiDeviceIndexToDeviceIndex(PaHostApiIndex hostApi,int hostApiDeviceIndex)
Pa_GetLastHostErrorInfo
const PaHostErrorInfo *Pa_GetLastHostErrorInfo()
Pa_GetDeviceCount
PaDeviceIndex Pa_GetDeviceCount()
Pa_GetDefaultInputDevice
PaDeviceIndex Pa_GetDefaultInputDevice()
Pa_GetDefaultOutputDevice
PaDeviceIndex Pa_GetDefaultOutputDevice()
Pa_GetDeviceInfo
const PaDeviceInfo *Pa_GetDeviceInfo(PaDeviceIndex device)
Pa_IsFormatSupported
PaError Pa_IsFormatSupported(const PaStreamParameters *inputParameters,const PaStreamParameters *outputParameters,double sampleRate)
Pa_OpenStream
PaError Pa_OpenStream(PaStream **stream,const PaStreamParameters *inputParameters,const PaStreamParameters *outputParameters,double sampleRate,unsigned long int framesPerBuffer,PaStreamFlags streamFlags,PaStreamCallback *streamCallback,void *userData)
Pa_OpenDefaultStream
PaError Pa_OpenDefaultStream(PaStream **stream,int numInputChannels,int numOutputChannels,PaSampleFormat sampleFormat,double sampleRate,unsigned long int framesPerBuffer,PaStreamCallback *streamCallback,void *userData)
Pa_CloseStream
PaError Pa_CloseStream(PaStream *stream)
Pa_SetStreamFinishedCallback
PaError Pa_SetStreamFinishedCallback(PaStream *stream,PaStreamFinishedCallback *streamFinishedCallback)
Pa_StartStream
PaError Pa_StartStream(PaStream *stream)
Pa_StopStream
PaError Pa_StopStream(PaStream *stream)
Pa_AbortStream
PaError Pa_AbortStream(PaStream *stream)
Pa_IsStreamStopped
PaError Pa_IsStreamStopped(PaStream *stream)
Pa_IsStreamActive
PaError Pa_IsStreamActive(PaStream *stream)
Pa_GetStreamInfo
const PaStreamInfo *Pa_GetStreamInfo(PaStream *stream)
Pa_GetStreamTime
PaTime Pa_GetStreamTime(PaStream *stream)
Pa_GetStreamCpuLoad
double Pa_GetStreamCpuLoad(PaStream *stream)
Pa_ReadStream
PaError Pa_ReadStream(PaStream *stream,void *buffer,unsigned long int frames)
Pa_WriteStream
PaError Pa_WriteStream(PaStream *stream,const void *buffer,unsigned long int frames)
Pa_GetStreamReadAvailable
long int Pa_GetStreamReadAvailable(PaStream *stream)
Pa_GetStreamWriteAvailable
long int Pa_GetStreamWriteAvailable(PaStream *stream)
Pa_GetSampleSize
PaError Pa_GetSampleSize(PaSampleFormat format)
Pa_Sleep
void Pa_Sleep(long int msec)

Motivation

Static Methods

   main


Runs portaudio_module as if it would be called from the command-line.

See Commandline-Interface.

Signature:
int portaudio_module::main(int argc,char **argv)

Parameters:
Type Name Direction Description
int argcThe number of command-line parameters.
char **argv[IN]The command-line parameters.

Return value:
Exit status.

   Pa_GetVersion


Please see PortAudio documentation.

Signature:
int Pa_GetVersion()

   Pa_GetVersionText


Please see PortAudio documentation.

Signature:
const char *Pa_GetVersionText()

   Pa_GetVersionInfo


Please see PortAudio documentation.

Signature:
const PaVersionInfo *Pa_GetVersionInfo()

   Pa_GetErrorText


Please see PortAudio documentation.

Signature:
const char *Pa_GetErrorText(PaError errorCode)

Parameters:
Type Name Direction Description
PaError errorCode

   Pa_Initialize


Please see PortAudio documentation.

Signature:
PaError Pa_Initialize()

   Pa_Terminate


Please see PortAudio documentation.

Signature:
PaError Pa_Terminate()

   Pa_GetHostApiCount


Please see PortAudio documentation.

Signature:
PaHostApiIndex Pa_GetHostApiCount()

   Pa_GetDefaultHostApi


Please see PortAudio documentation.

Signature:
PaHostApiIndex Pa_GetDefaultHostApi()

   Pa_GetHostApiInfo


Please see PortAudio documentation.

Signature:
const PaHostApiInfo *Pa_GetHostApiInfo(PaHostApiIndex hostApi)

Parameters:
Type Name Direction Description
PaHostApiIndex hostApi

   Pa_HostApiTypeIdToHostApiIndex


Please see PortAudio documentation.

Signature:
PaHostApiIndex Pa_HostApiTypeIdToHostApiIndex(PaHostApiTypeId type)

Parameters:
Type Name Direction Description
PaHostApiTypeId type

   Pa_HostApiDeviceIndexToDeviceIndex


Please see PortAudio documentation.

Signature:
PaDeviceIndex Pa_HostApiDeviceIndexToDeviceIndex(PaHostApiIndex hostApi,int hostApiDeviceIndex)

Parameters:
Type Name Direction Description
PaHostApiIndex hostApi
int hostApiDeviceIndex

   Pa_GetLastHostErrorInfo


Please see PortAudio documentation.

Signature:
const PaHostErrorInfo *Pa_GetLastHostErrorInfo()

   Pa_GetDeviceCount


Please see PortAudio documentation.

Signature:
PaDeviceIndex Pa_GetDeviceCount()

   Pa_GetDefaultInputDevice


Please see PortAudio documentation.

Signature:
PaDeviceIndex Pa_GetDefaultInputDevice()

   Pa_GetDefaultOutputDevice


Please see PortAudio documentation.

Signature:
PaDeviceIndex Pa_GetDefaultOutputDevice()

   Pa_GetDeviceInfo


Please see PortAudio documentation.

Signature:
const PaDeviceInfo *Pa_GetDeviceInfo(PaDeviceIndex device)

Parameters:
Type Name Direction Description
PaDeviceIndex device

   Pa_IsFormatSupported


Please see PortAudio documentation.

Signature:
PaError Pa_IsFormatSupported(const PaStreamParameters *inputParameters,const PaStreamParameters *outputParameters,double sampleRate)

Parameters:
Type Name Direction Description
const PaStreamParameters *inputParameters
const PaStreamParameters *outputParameters
double sampleRate

   Pa_OpenStream


Please see PortAudio documentation.

Signature:
PaError Pa_OpenStream(PaStream **stream,const PaStreamParameters *inputParameters,const PaStreamParameters *outputParameters,double sampleRate,unsigned long int framesPerBuffer,PaStreamFlags streamFlags,PaStreamCallback *streamCallback,void *userData)

Parameters:
Type Name Direction Description
PaStream **stream
const PaStreamParameters *inputParameters
const PaStreamParameters *outputParameters
double sampleRate
unsigned long int framesPerBuffer
PaStreamFlags streamFlags
PaStreamCallback *streamCallback
void *userData

   Pa_OpenDefaultStream


Please see PortAudio documentation.

Signature:
PaError Pa_OpenDefaultStream(PaStream **stream,int numInputChannels,int numOutputChannels,PaSampleFormat sampleFormat,double sampleRate,unsigned long int framesPerBuffer,PaStreamCallback *streamCallback,void *userData)

Parameters:
Type Name Direction Description
PaStream **stream
int numInputChannels
int numOutputChannels
PaSampleFormat sampleFormat
double sampleRate
unsigned long int framesPerBuffer
PaStreamCallback *streamCallback
void *userData

   Pa_CloseStream


Please see PortAudio documentation.

Signature:
PaError Pa_CloseStream(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_SetStreamFinishedCallback


Please see PortAudio documentation.

Signature:
PaError Pa_SetStreamFinishedCallback(PaStream *stream,PaStreamFinishedCallback *streamFinishedCallback)

Parameters:
Type Name Direction Description
PaStream *stream
PaStreamFinishedCallback *streamFinishedCallback

   Pa_StartStream


Please see PortAudio documentation.

Signature:
PaError Pa_StartStream(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_StopStream


Please see PortAudio documentation.

Signature:
PaError Pa_StopStream(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_AbortStream


Please see PortAudio documentation.

Signature:
PaError Pa_AbortStream(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_IsStreamStopped


Please see PortAudio documentation.

Signature:
PaError Pa_IsStreamStopped(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_IsStreamActive


Please see PortAudio documentation.

Signature:
PaError Pa_IsStreamActive(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_GetStreamInfo


Please see PortAudio documentation.

Signature:
const PaStreamInfo *Pa_GetStreamInfo(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_GetStreamTime


Please see PortAudio documentation.

Signature:
PaTime Pa_GetStreamTime(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_GetStreamCpuLoad


Please see PortAudio documentation.

Signature:
double Pa_GetStreamCpuLoad(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_ReadStream


Please see PortAudio documentation.

Signature:
PaError Pa_ReadStream(PaStream *stream,void *buffer,unsigned long int frames)

Parameters:
Type Name Direction Description
PaStream *stream
void *buffer
unsigned long int frames

   Pa_WriteStream


Please see PortAudio documentation.

Signature:
PaError Pa_WriteStream(PaStream *stream,const void *buffer,unsigned long int frames)

Parameters:
Type Name Direction Description
PaStream *stream
const void *buffer
unsigned long int frames

   Pa_GetStreamReadAvailable


Please see PortAudio documentation.

Signature:
long int Pa_GetStreamReadAvailable(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_GetStreamWriteAvailable


Please see PortAudio documentation.

Signature:
long int Pa_GetStreamWriteAvailable(PaStream *stream)

Parameters:
Type Name Direction Description
PaStream *stream

   Pa_GetSampleSize


Please see PortAudio documentation.

Signature:
PaError Pa_GetSampleSize(PaSampleFormat format)

Parameters:
Type Name Direction Description
PaSampleFormat format

   Pa_Sleep


Please see PortAudio documentation.

Signature:
void Pa_Sleep(long int msec)

Parameters:
Type Name Direction Description
long int msec

Copyright © 2017 - 2019 by Andreas Pollhammer