version 2.8
gaudio.h File Reference
#include "../../gfx.h"

Go to the source code of this file.

Data Structures

struct  GEventAudioPlay_t
 The Audio play event structure. More...
 
struct  GEventAudioRecord_t
 The Audio record event structure. More...
 

Functions

bool_t gaudioPlayInit (uint16_t channel, uint32_t frequency, ArrayDataFormat format)
 Set the audio device to play on the specified channel and with the specified sample frequency. More...
 
void gaudioPlay (GDataBuffer *paud)
 Play the specified sample data. More...
 
void gaudioPlayPause (void)
 Pause any currently playing sounds. More...
 
void gaudioPlayStop (void)
 Stop any currently playing sounds. More...
 
bool_t gaudioPlaySetVolume (uint8_t vol)
 Set the output volume. More...
 
GSourceHandle gaudioPlayGetSource (void)
 Turn on sending results to the GEVENT sub-system. More...
 
bool_t gaudioPlayWait (delaytime_t ms)
 Wait for any currently playing sounds to complete. More...
 
bool_t gaudioRecordInit (uint16_t channel, uint32_t frequency, ArrayDataFormat format)
 Initialise (but not start) the Audio Recording sub-system. More...
 
void gaudioRecordStart (void)
 Start the audio recording. More...
 
void gaudioRecordStop (void)
 Stop the audio recording. More...
 
GDataBuffergaudioRecordGetData (delaytime_t ms)
 Get a filled audio buffer from the recording list. More...
 
GSourceHandle gaudioRecordGetSource (void)
 Turn on sending results to the GEVENT sub-system. More...
 

Macros

#define GAUDIO_PLAY_LOSTEVENT   0x0001
 The event flag values. More...
 
#define GAUDIO_PLAY_PLAYING   0x0002
 The audio out system is currently playing. More...
 
#define GAUDIO_PLAY_FREEBLOCK   0x0004
 An audio buffer has been freed. More...
 
#define GAUDIO_RECORD_LOSTEVENT   0x0001
 The event flag values. More...
 
#define GAUDIO_RECORD_RECORDING   0x0002
 The audio recording system is currently recording. More...
 
#define GAUDIO_RECORD_GOTBUFFER   0x0004
 An audio buffer is ready for processing. More...
 
#define GAUDIO_RECORD_STALL   0x0008
 The recording process has stalled due to no free buffers. More...
 

Typedefs

typedef struct GEventAudioPlay_t GEventAudioPlay
 The Audio play event structure. More...
 
typedef struct GEventAudioRecord_t GEventAudioRecord
 The Audio record event structure. More...
 

Macro Definition Documentation

#define GAUDIO_PLAY_FREEBLOCK   0x0004

An audio buffer has been freed.

Definition at line 61 of file gaudio.h.

#define GAUDIO_PLAY_LOSTEVENT   0x0001

The event flag values.

The last GEVENT_AUDIO_PLAY event was lost

Definition at line 59 of file gaudio.h.

#define GAUDIO_PLAY_PLAYING   0x0002

The audio out system is currently playing.

Definition at line 60 of file gaudio.h.

#define GAUDIO_RECORD_GOTBUFFER   0x0004

An audio buffer is ready for processing.

Definition at line 85 of file gaudio.h.

#define GAUDIO_RECORD_LOSTEVENT   0x0001

The event flag values.

The last GEVENT_AUDIO_IN event was lost

Definition at line 83 of file gaudio.h.

#define GAUDIO_RECORD_RECORDING   0x0002

The audio recording system is currently recording.

Definition at line 84 of file gaudio.h.

#define GAUDIO_RECORD_STALL   0x0008

The recording process has stalled due to no free buffers.

Definition at line 86 of file gaudio.h.