Detailed Description

Recording driver interface for the GAUDIO module.

Functions
void	gaudioRecordSaveDataBlockI (GDataBuffer *paud)
	Save a block of recorded audio data ready for the application. More...

void	gaudioRecordDoneI (void)
	Signal that all recording has now stopped. More...

gBool	gaudio_record_lld_init (gU16 channel, gU32 frequency, ArrayDataFormat format)
	Initialise the record driver. More...

void	gaudio_record_lld_start (void)
	Start the audio recording. More...

void	gaudio_record_lld_stop (void)
	Stop the audio recording. More...

Macros
#define	gaudioRecordGetFreeBlockI() gfxBufferGetI()
	Get a free block of audio data that we can record into. More...

Function Documentation

◆ gaudio_record_lld_init()

gBool gaudio_record_lld_init	(	gU16	channel,
		gU32	frequency,
		ArrayDataFormat	format
	)

Initialise the record driver.

Returns: gTrue if the channel, frequency and format are valid.

Parameters

[in]	channel	The channel to use (see the driver for the available channels provided)
[in]	frequency	The sample frequency to use
[in]	format	The sample format

Note: The driver will always have been stopped and de-init before this is called.

Function Class: Normal API, this function can be invoked by regular system threads.

◆ gaudio_record_lld_start()

void gaudio_record_lld_start ( void )

Start the audio recording.

Function Class: Normal API, this function can be invoked by regular system threads.

◆ gaudio_record_lld_stop()

void gaudio_record_lld_stop ( void )

Stop the audio recording.

Note: Some drivers may only stop recording at a data block boundary.; This routine should not return until any currently active buffers have been saved (even if with zero length) and gaudioRecordDoneI() has been called.

Function Class: Normal API, this function can be invoked by regular system threads.

◆ gaudioRecordDoneI()

void gaudioRecordDoneI ( void )

Signal that all recording has now stopped.

Note: Defined in the high level GAUDIO code for use by the GAUDIO record drivers.

Function Class: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Function Class: Not an API, this function is for internal use only.

◆ gaudioRecordSaveDataBlockI()

void gaudioRecordSaveDataBlockI ( GDataBuffer * paud )

Save a block of recorded audio data ready for the application.

Parameters

[in] paud The GDataBuffer block with data.

Note: Defined in the high level GAUDIO code for use by the GAUDIO record drivers.

Function Class: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Function Class: Not an API, this function is for internal use only.

Macro Definition Documentation

◆ gaudioRecordGetFreeBlockI

#define gaudioRecordGetFreeBlockI ( ) gfxBufferGetI()

Get a free block of audio data that we can record into.

Returns: A pointer to the GAaudioData structure or NULL if none is currently available

Note: Defined in the high level GAUDIO code for use by the GAUDIO record drivers.

Function Class: This is an I-Class API, this function can be invoked from within a system lock zone by both threads and interrupt handlers.

Function Class: Not an API, this function is for internal use only.

Definition at line 40 of file gaudio_driver_record.h.