gf_audio.h File Reference

Audio interface. More...

#include <gf_pre.h>
#include <gf_macro.h>
#include <gf_type/audio.h>
#include <gf_type/core.h>
#include <stddef.h>

Go to the source code of this file.

Functions
gf_audio_t *	gf_audio_create (gf_engine_t *engine)
	Create audio interface.
void	gf_audio_destroy (gf_audio_t *audio)
	Destroy audio interface.
void	gf_audio_decoder_destroy (gf_audio_decoder_t *decoder)
	Destroy audio decoder.
gf_audio_id_t	gf_audio_load_file (gf_audio_t *audio, const char *path)
	Load and play file.
gf_audio_id_t	gf_audio_load (gf_audio_t *audio, const void *data, size_t size)
	Load and play data.
void	gf_audio_pause (gf_audio_t *audio, gf_audio_id_t id)
	Pause audio.
void	gf_audio_resume (gf_audio_t *audio, gf_audio_id_t id)
	Resume audio.
void	gf_audio_stop (gf_audio_t *audio, gf_audio_id_t id)
	Stop audio.

Detailed Description

Audio interface.

Definition in file gf_audio.h.

Function Documentation

gf_audio_create()

gf_audio_t * gf_audio_create ( gf_engine_t *  engine )

extern

Create audio interface.

Parameters

engine

Engine instance

Returns

Audio interface

Definition at line 170 of file gf_audio.c.

gf_audio_decoder_destroy()

void gf_audio_decoder_destroy ( gf_audio_decoder_t *  decoder )

extern

Destroy audio decoder.

Parameters

decoder

Audio decoder

Definition at line 226 of file gf_audio.c.

gf_audio_destroy()

void gf_audio_destroy ( gf_audio_t *  audio )

extern

Destroy audio interface.

Parameters

audio

Audio interface

Definition at line 246 of file gf_audio.c.

gf_audio_load()

gf_audio_id_t gf_audio_load ( gf_audio_t *  audio, const void *  data, size_t  size  )

extern

Load and play data.

Parameters

audio	Audio interface
data	Data
size	Data size

Returns

ID if successful, otherwise -1

Definition at line 97 of file gf_audio.c.

gf_audio_load_file()

gf_audio_id_t gf_audio_load_file ( gf_audio_t *  audio, const char *  path  )

extern

Load and play file.

Parameters

audio	Audio interface
path	Path

Returns

ID if successful, otherwise -1

Definition at line 151 of file gf_audio.c.

gf_audio_pause()

void gf_audio_pause ( gf_audio_t *  audio, gf_audio_id_t  id  )

extern

Pause audio.

Parameters

audio	Audio interface
id	Audio ID

Definition at line 269 of file gf_audio.c.

gf_audio_resume()

void gf_audio_resume ( gf_audio_t *  audio, gf_audio_id_t  id  )

extern

Resume audio.

Parameters

audio	Audio interface
id	Audio ID

Definition at line 263 of file gf_audio.c.

gf_audio_stop()

void gf_audio_stop ( gf_audio_t *  audio, gf_audio_id_t  id  )

extern

Stop audio.

Parameters

audio	Audio interface
id	Audio ID

Definition at line 275 of file gf_audio.c.