cgl_audio.h File Reference

Audio playback functions. More...

Go to the source code of this file.

Data Structures
struct	CGL_AUDIO_INFO_T
	Audio information. More...

Typedefs
typedef enum CGL_AUDIO_SAMPLING_FREQ_T	CGL_AUDIO_SAMPLING_FREQ_T
	Sampling frequency enum definitions.
typedef struct CGL_AUDIO_INFO_T	CGL_AUDIO_INFO_T
	Audio information.

Enumerations
enum	CGL_AUDIO_SAMPLING_FREQ_T
	Sampling frequency enum definitions.

Functions
static CGL_AUDIO_SAMPLING_FREQ_T	CGL_AUDIO_SAMPLING_FREQ_OF (int hertz)
	Helper function to get enum for certain sampling frequency. More...
int	CGL_OpenAudio (const CGL_AUDIO_INFO_T *info)
	Opens audio playback. More...
int	CGL_PlayAudio (const void *data, size_t size)
	Feed and play audio data. More...
int	CGL_CloseAudio ()
	Closes audio playback. More...

Detailed Description

Audio playback functions.

Function Documentation

CGL_AUDIO_SAMPLING_FREQ_OF()

static CGL_AUDIO_SAMPLING_FREQ_T CGL_AUDIO_SAMPLING_FREQ_OF ( int  hertz )

inlinestatic

Helper function to get enum for certain sampling frequency.

Parameters

hertz

Sampling frequency

Returns

Sampling frequency enum value

CGL_CloseAudio()

int CGL_CloseAudio

(

)

Closes audio playback.

Returns

0 if succeeded

CGL_OpenAudio()

int CGL_OpenAudio

(

const CGL_AUDIO_INFO_T *

info

)

Opens audio playback.

Parameters

info	Audio information

Returns

0 if succeeded

CGL_PlayAudio()

int CGL_PlayAudio	(	const void *	data,
		size_t	size
	)

Feed and play audio data.

Parameters

data	Audio stream buffer
size	Size of buffer

Returns

0 if succeeded