GoldFish Engine
Quite simple and lightweight game engine
Loading...
Searching...
No Matches
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_tgf_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.
 
int gf_audio_load_file (gf_audio_t *audio, const char *path)
 Load and play file.
 
int gf_audio_load (gf_audio_t *audio, const void *data, size_t size)
 Load and play data.
 

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
engineEngine instance
Returns
Audio interface

Definition at line 155 of file gf_audio.c.

◆ gf_audio_decoder_destroy()

void gf_audio_decoder_destroy ( gf_audio_decoder_t decoder)
extern

Destroy audio decoder.

Parameters
decoderAudio decoder

Definition at line 199 of file gf_audio.c.

◆ gf_audio_destroy()

void gf_audio_destroy ( gf_audio_t audio)
extern

Destroy audio interface.

Parameters
audioAudio interface

Definition at line 217 of file gf_audio.c.

◆ gf_audio_load()

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

Load and play data.

Parameters
audioAudio interface
dataData
sizeData size
Returns
0 if successful, otherwise -1

Definition at line 88 of file gf_audio.c.

◆ gf_audio_load_file()

int gf_audio_load_file ( gf_audio_t audio,
const char *  path 
)

Load and play file.

Parameters
audioAudio interface
pathPath
Returns
0 if successful, otherwise -1

Definition at line 136 of file gf_audio.c.