Description

Macros
#define	RMF_ERROR (1)

#define	RMF_INVALID_PARM (2)

#define	RMF_AC_TYPE_PRIMARY "primary"

#define	RMF_AC_TYPE_AUXILIARY "auxiliary"

Typedefs
typedef struct RMF_AudioCapture_Struct *	RMF_AudioCaptureHandle

typedef char *	RMF_AudioCaptureType

typedef enum RMF_AudioCapture_Format	racFormat

typedef enum RMF_AudioCapture_Freq	racFreq

typedef rmf_Error(*	RMF_AudioCaptureBufferReadyCb) (void cbBufferReadyParm, void AudioCaptureBuffer, unsigned int AudioCaptureBufferSize)

typedef rmf_Error(*	RMF_AudioCapture_StatusChangeCb) (void *cbStatusParm)

typedef struct RMF_AudioCapture_Settings	RMF_AudioCapture_Settings

typedef struct RMF_AudioCapture_Status	RMF_AudioCapture_Status

Data Structure Documentation

struct RMF_AudioCapture_Settings

Definition at line 104 of file rmfAudioCapture.h.

Collaboration diagram for RMF_AudioCapture_Settings:

Data Fields
RMF_AudioCaptureBufferReadyCb	cbBufferReady	Callback to send audio data to application. Must be set during Open call, no other way to get audio data to application
void *	cbBufferReadyParm	Application context data passed back in Buffer Ready callback, can be NULL
RMF_AudioCapture_StatusChangeCb	cbStatusChange	If cbStatusChange is NOT NULL, then the library should trigger the callback when there is a status change is AudioCapture Examples: OnStart of AC, Change from Start to Stop of AC. On underflow/overflow
void *	cbStatusParm	Application context data passed back in Status Change callback
size_t	fifoSize	FIFO size in bytes. This value is a total FIFO size to hold all channels of data If not set, a default size will be used. Needs to be big enough to avoid overflow (expected service time * byte rate)
size_t	threshold	FIFO data callback threshold in bytes. When the amount of data in the FIFO reaches this level, the dataCallback will be invoked
racFormat	format	Captured data format. Default is 16bit stereo. This value is ignored for compressed data, and can not be changed while connected to any inputs.
racFreq	samplingFreq	Captured data sampling freq tbd, not currently supported..
unsigned int	delayCompensation_ms	Delay compensation in milli seconds

struct RMF_AudioCapture_Status

Definition at line 124 of file rmfAudioCapture.h.

Collaboration diagram for RMF_AudioCapture_Status:

Data Fields
int	started	is the capture started
racFormat	format	Current capture format (Bit depth & Channel)
racFreq	samplingFreq	Current capture sample rate
size_t	fifoDepth	number of bytes in local fifo
unsigned int	overflows	count of overflows
unsigned int	underflows	count of overflows
int	muted	is the capture muted
int	paused	is the capture muted
float	volume	current capture volume

Enumerator
racFormat_e16BitStereo	Stereo, 16 bits per sample interleaved into a 32-bit word.
racFormat_e24BitStereo	Stereo, 24 bits per sample. The data is aligned to 32-bits, left-justified. Left and right channels will interleave one sample per 32-bit word.
racFormat_e16BitMonoLeft	Mono, 16 bits per sample interleaved into a 32-bit word. Left channel samples only.
racFormat_e16BitMonoRight	Mono, 16 bits per sample interleaved into a 32-bit word. Right channel samples only.
racFormat_e16BitMono	Mono, 16 bits per sample interleaved into a 32-bit word. Left and Right channels mixed.
racFormat_e24Bit5_1	5.1 Multichannel, 24 bits per sample. The data is aligned to 32-bits, left-justified. Channels will interleave one sample per 32-bit word, ordered L,R,Ls,Rs,C,LFE.

Definition at line 67 of file rmfAudioCapture.h.

Definition at line 82 of file rmfAudioCapture.h.