usb_mic_ringbuffer_t

Syntax

#include <cafe/usb_mic.h>

typedef struct {
    unsigned long int       modulus;
    usb_mic_pcm_sample_t*   base;
} usb_mic_ringbuffer_t;

typedef short int usb_mic_pcm_sample_t;

Elements

modulus Size of the ring buffer in units of sizeof(usb_mic_pcm_sample_t).
base Pointer to an array of type usb_mic_pcm_sample_t that is the base address of the shared ring buffer.

Description

This data structure defines the ringbuffer that receives the PCM data stream from the USB microphone. The data pointed to in this structure need to remain valid until the corresponding instance's handle is closed. The data in this ringbuffer can be used directly for streaming via AX, without the need for further copies of the data stream.

Revision History

2013/05/08 Automated cleanup pass.
2012/08/03 Cleanup Pass
2012/01/06 Initial version.


CONFIDENTIAL