cmdfx 0.3.0
Lightweight game engine for your terminal
Loading...
Searching...
No Matches
Functions
sound.h File Reference

Primary sound engine declarations. More...

Go to the source code of this file.

Functions

int Sound_play (const char *soundFile)
 Play a sound file.
int Sound_playLooped (const char *soundFile, int loopCount)
 Play a sound file in a loop.
int Sound_pause (const char *soundFile)
 Pause a sound file.
int Sound_pauseAll ()
 Pause all sound files.
int Sound_resume (const char *soundFile)
 Resume a sound file.
int Sound_resumeAll ()
 Resume all sound files.
int Sound_stop (const char *soundFile)
 Stop a sound file.
int Sound_stopAll ()
 Stop all sound files.
int Sound_getVolume (const char *soundFile, double *volume)
 Get the volume of a sound file.
int Sound_getVolumeAll (double *volume)
 Get the volume of all sound files.
int Sound_setVolume (const char *soundFile, double volume)
 Set the volume of a sound file.
int Sound_setVolumeAll (double volume)
 Set the volume of all sound files.

Detailed Description

Primary sound engine declarations.

C++ Extensions for sound engine declarations.

Author
Gregory Mitchell (me@gm.nosp@m.itch.nosp@m.215.x.nosp@m.yz)
Version
0.3.0
Date
2025-07-30
Copyright
Copyright (c) 2025
Author
Gregory Mitchell (me@gm.nosp@m.itch.nosp@m.215.x.nosp@m.yz)
Version
0.3.0
Date
2025-09-02
Copyright
Copyright (c) 2025

Function Documentation

◆ Sound_getVolume()

int Sound_getVolume ( const char * soundFile,
double * volume )

Get the volume of a sound file.

Parameters
soundFileThe path to the sound file.
volumePointer to store the volume level (0.0 to 1.0).
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_getVolumeAll()

int Sound_getVolumeAll ( double * volume)

Get the volume of all sound files.

Parameters
volumePointer to store the volume level (0.0 to 1.0).
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_pause()

int Sound_pause ( const char * soundFile)

Pause a sound file.

Parameters
soundFileThe path to the sound file to pause.
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_pauseAll()

int Sound_pauseAll ( )

Pause all sound files.

Returns
int 0 on success, or a negative error code on failure.

◆ Sound_play()

int Sound_play ( const char * soundFile)

Play a sound file.

Supported formats:

  • WAV
  • MP3
  • OGG
  • FLAC
  • AAC

Formats should be available on all platforms.

Parameters
soundFileThe path to the sound file to play.
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_playLooped()

int Sound_playLooped ( const char * soundFile,
int loopCount )

Play a sound file in a loop.

Parameters
soundFileThe path to the sound file to play.
loopCountThe number of times to loop the sound. Use -1 for infinite looping.
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_resume()

int Sound_resume ( const char * soundFile)

Resume a sound file.

Parameters
soundFileThe path to the sound file to resume.
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_resumeAll()

int Sound_resumeAll ( )

Resume all sound files.

Returns
int 0 on success, or a negative error code on failure.

◆ Sound_setVolume()

int Sound_setVolume ( const char * soundFile,
double volume )

Set the volume of a sound file.

Parameters
soundFileThe path to the sound file.
volumeThe volume level (0.0 to 1.0).
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_setVolumeAll()

int Sound_setVolumeAll ( double volume)

Set the volume of all sound files.

Parameters
volumeThe volume level (0.0 to 1.0).
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_stop()

int Sound_stop ( const char * soundFile)

Stop a sound file.

Parameters
soundFileThe path to the sound file to stop.
Returns
int 0 on success, or a negative error code on failure.

◆ Sound_stopAll()

int Sound_stopAll ( )

Stop all sound files.

Returns
int 0 on success, or a negative error code on failure.
Generated by doxygen 1.14.0