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
    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 = pa.paFloat32
  paInt32 = pa.paInt32
  paInt24 = pa.paInt24
  paInt16 = pa.paInt16
  paInt8 = pa.paInt8
  paUInt8 = pa.paUInt8
  paCustomFormat = pa.paCustomFormat
    PaHostApiTypeId Values
  paInDevelopment = pa.paInDevelopment
  paDirectSound = pa.paDirectSound
  paMME = pa.paMME
  paASIO = pa.paASIO
  paSoundManager = pa.paSoundManager
  paCoreAudio = pa.paCoreAudio
  paOSS = pa.paOSS
  paALSA = pa.paALSA
  paAL = pa.paAL
  paBeOS = pa.paBeOS
  paWDMKS = pa.paWDMKS
  paJACK = pa.paJACK
  paWASAPI = pa.paWASAPI
  paNoDevice = pa.paNoDevice
    PaErrorCode Values
  paNoError = pa.paNoError
  paNotInitialized = pa.paNotInitialized
  paUnanticipatedHostError = pa.paUnanticipatedHostError
  paInvalidChannelCount = pa.paInvalidChannelCount
  paInvalidSampleRate = pa.paInvalidSampleRate
  paInvalidDevice = pa.paInvalidDevice
  paInvalidFlag = pa.paInvalidFlag
  paSampleFormatNotSupported = pa.paSampleFormatNotSupported
  paBadIODeviceCombination = pa.paBadIODeviceCombination
  paInsufficientMemory = pa.paInsufficientMemory
  paBufferTooBig = pa.paBufferTooBig
  paBufferTooSmall = pa.paBufferTooSmall
  paNullCallback = pa.paNullCallback
  paBadStreamPtr = pa.paBadStreamPtr
  paTimedOut = pa.paTimedOut
  paInternalError = pa.paInternalError
  paDeviceUnavailable = pa.paDeviceUnavailable
  paIncompatibleHostApiSpecificStreamInfo = pa.paIncompatibleHos...
  paStreamIsStopped = pa.paStreamIsStopped
  paStreamIsNotStopped = pa.paStreamIsNotStopped
  paInputOverflowed = pa.paInputOverflowed
  paOutputUnderflowed = pa.paOutputUnderflowed
  paHostApiNotFound = pa.paHostApiNotFound
  paInvalidHostApi = pa.paInvalidHostApi
  paCanNotReadFromACallbackStream = pa.paCanNotReadFromACallback...
  paCanNotWriteToACallbackStream = pa.paCanNotWriteToACallbackSt...
  paCanNotReadFromAnOutputOnlyStream = pa.paCanNotReadFromAnOutp...
  paCanNotWriteToAnInputOnlyStream = pa.paCanNotWriteToAnInputOn...
  paIncompatibleStreamHostApi = pa.paIncompatibleStreamHostApi
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', 'p\
aCustomFormat']

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', 'paSoundManage\
r', 'paCoreAudio', 'paOSS', 'paALSA', 'paAL', 'paBeOS', 'paWDMKS', 'pa\
JACK', 'paWASAPI', 'paNoDevice']

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', 'paInval\
idChannelCount', 'paInvalidSampleRate', 'paInvalidDevice', 'paInvalidF\
lag', 'paSampleFormatNotSupported', 'paBadIODeviceCombination', 'paIns\
ufficientMemory', 'paBufferTooBig', 'paBufferTooSmall', 'paNullCallbac\
k', 'paBadStreamPtr', 'paTimedOut', 'paInternalError', 'paDeviceUnavai\
lable', 'paIncompatibleHostApiSpecificStreamInfo', 'paStreamIsStopped'\
, 'paStreamIsNotStopped', 'paInputOverflowed', 'paOutputUnderflowed', \
'paHostApiNotFound', 'paInvalidHostApi', 'paCanNotReadFromACallbackStr\
...

paIncompatibleHostApiSpecificStreamInfo

Value:
pa.paIncompatibleHostApiSpecificStreamInfo

paCanNotReadFromACallbackStream

Value:
pa.paCanNotReadFromACallbackStream

paCanNotWriteToACallbackStream

Value:
pa.paCanNotWriteToACallbackStream

paCanNotReadFromAnOutputOnlyStream

Value:
pa.paCanNotReadFromAnOutputOnlyStream

paCanNotWriteToAnInputOnlyStream

Value:
pa.paCanNotWriteToAnInputOnlyStream