pa_win_wmme.h File Reference

WMME-specific PortAudio API extension header file. More...

#include "portaudio.h"
#include "pa_win_waveformat.h"

Go to the source code of this file.

Data Structures
struct	PaWinMmeDeviceAndChannelCount
struct	PaWinMmeStreamInfo

Macros
#define	paWinMmeUseLowLevelLatencyParameters   (0x01)
#define	paWinMmeUseMultipleDevices   (0x02) /* use mme specific multiple device feature */
#define	paWinMmeUseChannelMask   (0x04)
#define	paWinMmeDontThrottleOverloadedProcessingThread   (0x08)
#define	paWinMmeWaveFormatDolbyAc3Spdif   (0x10)
#define	paWinMmeWaveFormatWmaSpdif   (0x20)

Typedefs
typedef struct PaWinMmeDeviceAndChannelCount	PaWinMmeDeviceAndChannelCount
typedef struct PaWinMmeStreamInfo	PaWinMmeStreamInfo

Functions
int	PaWinMME_GetStreamInputHandleCount (PaStream *stream)
HWAVEIN	PaWinMME_GetStreamInputHandle (PaStream *stream, int handleIndex)
int	PaWinMME_GetStreamOutputHandleCount (PaStream *stream)
HWAVEOUT	PaWinMME_GetStreamOutputHandle (PaStream *stream, int handleIndex)

Detailed Description

WMME-specific PortAudio API extension header file.

Macro Definition Documentation

paWinMmeDontThrottleOverloadedProcessingThread

#define paWinMmeDontThrottleOverloadedProcessingThread   (0x08)

Referenced by main().

paWinMmeUseChannelMask

#define paWinMmeUseChannelMask   (0x04)

Referenced by main().

paWinMmeUseLowLevelLatencyParameters

#define paWinMmeUseLowLevelLatencyParameters   (0x01)

Referenced by main().

paWinMmeUseMultipleDevices

#define paWinMmeUseMultipleDevices   (0x02) /* use mme specific multiple device feature */

paWinMmeWaveFormatDolbyAc3Spdif

#define paWinMmeWaveFormatDolbyAc3Spdif   (0x10)

Referenced by main().

paWinMmeWaveFormatWmaSpdif

#define paWinMmeWaveFormatWmaSpdif   (0x20)

Typedef Documentation

PaWinMmeDeviceAndChannelCount

typedef struct PaWinMmeDeviceAndChannelCount PaWinMmeDeviceAndChannelCount

PaWinMmeStreamInfo

typedef struct PaWinMmeStreamInfo PaWinMmeStreamInfo

Function Documentation

PaWinMME_GetStreamInputHandle()

HWAVEIN PaWinMME_GetStreamInputHandle	(	PaStream *	stream,
		int	handleIndex )

Retrieve a wave in handle used by a PortAudio WinMME stream.

Parameters

stream	The stream to query.
handleIndex	The zero based index of the wave in handle to retrieve. This should be in the range [0, PaWinMME_GetStreamInputHandleCount(stream)-1].

Returns

A valid wave in handle, or NULL if an error occurred.

See also

PaWinMME_GetStreamInputHandle

References PaWinMmeStream::input, PA_IS_INPUT_STREAM_, paNoError, and PaWinMmeSingleDirectionHandlesAndBuffers::waveHandles.

PaWinMME_GetStreamInputHandleCount()

int PaWinMME_GetStreamInputHandleCount

(

PaStream *

stream

)

Retrieve the number of wave in handles used by a PortAudio WinMME stream. Returns zero if the stream is output only.

Returns

A non-negative value indicating the number of wave in handles or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.

See also

PaWinMME_GetStreamInputHandle

References PaWinMmeSingleDirectionHandlesAndBuffers::deviceCount, PaWinMmeStream::input, PA_IS_INPUT_STREAM_, and paNoError.

PaWinMME_GetStreamOutputHandle()

HWAVEOUT PaWinMME_GetStreamOutputHandle	(	PaStream *	stream,
		int	handleIndex )

Retrieve a wave out handle used by a PortAudio WinMME stream.

Parameters

stream	The stream to query.
handleIndex	The zero based index of the wave out handle to retrieve. This should be in the range [0, PaWinMME_GetStreamOutputHandleCount(stream)-1].

Returns

A valid wave out handle, or NULL if an error occurred.

See also

PaWinMME_GetStreamOutputHandleCount

References PaWinMmeStream::output, PA_IS_OUTPUT_STREAM_, paNoError, and PaWinMmeSingleDirectionHandlesAndBuffers::waveHandles.

PaWinMME_GetStreamOutputHandleCount()

int PaWinMME_GetStreamOutputHandleCount

(

PaStream *

stream

)

Retrieve the number of wave out handles used by a PortAudio WinMME stream. Returns zero if the stream is input only.

Returns

A non-negative value indicating the number of wave out handles or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.

See also

PaWinMME_GetStreamOutputHandle

References PaWinMmeSingleDirectionHandlesAndBuffers::deviceCount, PaWinMmeStream::output, PA_IS_OUTPUT_STREAM_, and paNoError.