RMF_AudioCapture_Settings Struct Reference

Configuration parameters of audio capture interface. More...

#include <rmfAudioCapture.h>

Data Fields
RMF_AudioCaptureBufferReadyCb	cbBufferReady
	Callback to send audio data to caller. Must be set in Open call.
void *	cbBufferReadyParm
	Caller context data passed back in buffer-ready callback; can be NULL.
RMF_AudioCapture_StatusChangeCb	cbStatusChange
	If cbStatusChange is not NULL, then the underlying implementation should invoke this callback when there is a change of state in the audio capture interface. Examples: OnStart of AC, Change from Start to Stop of AC. On underflow/overflow.
void *	cbStatusParm
	Caller 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 buffer-ready will be invoked.
racFormat	format
	Format of captured data. Default is racFormat_e16BitStereThis value is ignored for compressed data, and can not be changed while connected to any inputs.
racFreq	samplingFreq
	Sampling rate of captured audio. Not currently supported. TBD.
unsigned int	delayCompensation_ms
	Delay compensation in milli seconds. This parameter is used to maintain AV sync when using latency-prone audio outputs like Bluetooth. It's the number of ms to delay video by in order to stay in sync with Bluetooth audio.

Detailed Description

Configuration parameters of audio capture interface.

Field Documentation

cbBufferReady

RMF_AudioCaptureBufferReadyCb cbBufferReady

Callback to send audio data to caller. Must be set in Open call.

cbBufferReadyParm

void* cbBufferReadyParm

Caller context data passed back in buffer-ready callback; can be NULL.

cbStatusChange

RMF_AudioCapture_StatusChangeCb cbStatusChange

If cbStatusChange is not NULL, then the underlying implementation should invoke this callback when there is a change of state in the audio capture interface. Examples: OnStart of AC, Change from Start to Stop of AC. On underflow/overflow.

cbStatusParm

void* cbStatusParm

Caller context data passed back in status change callback.

delayCompensation_ms

unsigned int delayCompensation_ms

Delay compensation in milli seconds. This parameter is used to maintain AV sync when using latency-prone audio outputs like Bluetooth. It's the number of ms to delay video by in order to stay in sync with Bluetooth audio.

fifoSize

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)

format

racFormat format

Format of captured data. Default is racFormat_e16BitStereThis value is ignored for compressed data, and can not be changed while connected to any inputs.

samplingFreq

racFreq samplingFreq

Sampling rate of captured audio. Not currently supported. TBD.

threshold

size_t threshold

FIFO data callback threshold in bytes. When the amount of data in the FIFO reaches this level, the buffer-ready will be invoked.

---

The documentation for this struct was generated from the following file:

• rmfAudioCapture.h