Module pyaudio
[frames] | no frames]

Module pyaudio

source code

PyAudio : Python Bindings for PortAudio v19.

These bindings only support PortAudio blocking mode.


Version: 0.2.4

Author: Hubert Pham

Classes
  Stream
PortAudio Stream Wrapper. Use PyAudio.open to make a new Stream.
  PyAudio
initialize and terminate PortAudio
  PaMacCoreStreamInfo
Mac OS X-only: PaMacCoreStreamInfo is a PortAudio Host API Specific Stream Info data structure for specifying Mac OS X-only settings. Instantiate this class (if desired) and pass the instance as the argument in PyAudio.open to parameters input_host_api_specific_stream_info or output_host_api_specific_stream_info. (See Stream.__init__.)
Functions
    Stream Conversion Convenience Functions
int
get_sample_size(format)
Returns the size (in bytes) for the specified sample format (a PaSampleFormat constant).
source code
PaSampleFormat
get_format_from_width(width, unsigned=True)
Returns a PortAudio format constant for the specified width.
source code
    PortAudio version
str
get_portaudio_version()
Returns portaudio version.
source code
str
get_portaudio_version_text()
Returns PortAudio version as a text string.
source code
Variables
  paMacCoreStreamInfo = pa.paMacCoreStreamInfo
  __package__ = None
    PortAudio Constants
  PaSampleFormat = ['paFloat32', 'paInt32', 'paInt24', 'paInt16'...
A list of all PortAudio PaSampleFormat value constants.
  PaHostApiTypeId = ['paInDevelopment', 'paDirectSound', 'paMME'...
A list of all PortAudio PaHostApiTypeId constants.
  PaErrorCode = ['paNoError', 'paNotInitialized', 'paUnanticipat...
A list of all PortAudio PaErrorCode constants. Typically, error code constants are included in Python exception objects (as the second argument).
    PaSampleFormat Values
  paFloat32 = 1
  paInt32 = 2
  paInt24 = 4
  paInt16 = 8
  paInt8 = 16
  paUInt8 = 32
  paCustomFormat = 65536
    PaHostApiTypeId Values
  paInDevelopment = 0
  paDirectSound = 1
  paMME = 2
  paASIO = 3
  paSoundManager = 4
  paCoreAudio = 5
  paOSS = 7
  paALSA = 8
  paAL = 9
  paBeOS = 10
  paWDMKS = 11
  paJACK = 12
  paWASAPI = 13
  paNoDevice = -1
    PaErrorCode Values
  paNoError = 0
  paNotInitialized = -10000
  paUnanticipatedHostError = -9999
  paInvalidChannelCount = -9998
  paInvalidSampleRate = -9997
  paInvalidDevice = -9996
  paInvalidFlag = -9995
  paSampleFormatNotSupported = -9994
  paBadIODeviceCombination = -9993
  paInsufficientMemory = -9992
  paBufferTooBig = -9991
  paBufferTooSmall = -9990
  paNullCallback = -9989
  paBadStreamPtr = -9988
  paTimedOut = -9987
  paInternalError = -9986
  paDeviceUnavailable = -9985
  paIncompatibleHostApiSpecificStreamInfo = -9984
  paStreamIsStopped = -9983
  paStreamIsNotStopped = -9982
  paInputOverflowed = -9981
  paOutputUnderflowed = -9980
  paHostApiNotFound = -9979
  paInvalidHostApi = -9978
  paCanNotReadFromACallbackStream = -9977
  paCanNotWriteToACallbackStream = -9976
  paCanNotReadFromAnOutputOnlyStream = -9975
  paCanNotWriteToAnInputOnlyStream = -9974
  paIncompatibleStreamHostApi = -9973
Function Details

get_sample_size(format)

source code 
Returns the size (in bytes) for the specified sample format (a PaSampleFormat constant).
Parameters:
Returns: int
Raises:
  • ValueError - Invalid specified format.

get_format_from_width(width, unsigned=True)

source code 
Returns a PortAudio format constant for the specified width.
Parameters:
  • width - The desired sample width in bytes (1, 2, 3, or 4)
  • unsigned - For 1 byte width, specifies signed or unsigned format.
Returns: PaSampleFormat
Raises:
  • ValueError - for invalid width

Variables Details

PaSampleFormat

A list of all PortAudio PaSampleFormat value constants.

See: paInt32, paInt24, paInt16, paInt8, and paUInt8.

Value:
['paFloat32',
 'paInt32',
 'paInt24',
 'paInt16',
 'paInt8',
 'paUInt8',
 'paCustomFormat']

PaHostApiTypeId

A list of all PortAudio PaHostApiTypeId constants.

See: paInDevelopment, paDirectSound, paMME, paASIO, paSoundManager, paCoreAudio, paOSS, paALSA, paAL, et al...

Value:
['paInDevelopment',
 'paDirectSound',
 'paMME',
 'paASIO',
 'paSoundManager',
 'paCoreAudio',
 'paOSS',
 'paALSA',
...

PaErrorCode

A list of all PortAudio PaErrorCode constants. Typically, error code constants are included in Python exception objects (as the second argument).

See: paNoError, paNotInitialized, paUnanticipatedHostError, et al...

Value:
['paNoError',
 'paNotInitialized',
 'paUnanticipatedHostError',
 'paInvalidChannelCount',
 'paInvalidSampleRate',
 'paInvalidDevice',
 'paInvalidFlag',
 'paSampleFormatNotSupported',
...