pu::audio Namespace Reference

Typedefs
using	Music = Mix_Music*
	Type representing a music file.
using	Sfx = Mix_Chunk*
	Type representing a sound effect.

Functions
bool	Initialize (i32 mix_flags)
	Initializes the underlying audio system (SDL2-Mixer) with the specified flags.
void	Finalize ()
	Finalizes the underlying audio system (SDL2-Mixer).
Music	OpenMusic (std::string &path)
	Opens a music file from the specified path.
void	PlayMusic (Music mus, i32 loops)
	Plays a music file.
void	PlayMusicWithFadeIn (Music mus, i32 loops, i32 ms)
	Plays a music file with a fade-in effect.
bool	IsPlayingMusic ()
	Checks if music is currently playing.
void	PauseMusic ()
	Pauses the currently playing music.
void	ResumeMusic ()
	Resumes the currently paused music.
void	SetMusicVolume (i32 vol)
	Sets the volume of the currently playing music.
i32	GetMusicVolume ()
	Gets the volume of the currently playing music.
void	FadeOutMusic (i32 ms)
	Fades out the currently playing music.
void	RewindMusic ()
	Rewinds the currently playing music.
void	StopMusic ()
	Stops the currently playing music.
void	SetMusicPosition (double sec)
	Sets the position of the currently playing music.
void	DestroyMusic (Music &mus)
	Destroys a music file.
Sfx	LoadSfx (std::string &path)
	Loads a sound effect from the specified path.
void	PlaySfx (Sfx sfx)
	Plays a sound effect.
void	DestroySfx (Sfx &sfx)
	Destroys a sound effect.

Variables
constexpr i32	MixerAllFlags = MIX_INIT_FLAC | MIX_INIT_MOD | MIX_INIT_MP3 | MIX_INIT_OGG
	Complete set of flags to initialize the audio system with: supports FLAC, MOD, MP3 and OGG formats.

Typedef Documentation

Music

using pu::audio::Music = Mix_Music*

Type representing a music file.

Sfx

using pu::audio::Sfx = Mix_Chunk*

Type representing a sound effect.

Function Documentation

DestroyMusic()

void pu::audio::DestroyMusic

(

Music &

mus

)

Destroys a music file.

Parameters

mus	Music file to destroy. If NULL is passed, nothing will happen.

DestroySfx()

void pu::audio::DestroySfx

(

Sfx &

sfx

)

Destroys a sound effect.

Parameters

sfx	Sound effect to destroy. If NULL is passed, nothing will happen.

FadeOutMusic()

void pu::audio::FadeOutMusic

(

i32

ms

)

Fades out the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

Parameters

ms	Time in milliseconds to fade out the music file.

Finalize()

void pu::audio::Finalize

(

)

Finalizes the underlying audio system (SDL2-Mixer).

GetMusicVolume()

i32 pu::audio::GetMusicVolume

(

)

Gets the volume of the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

Returns

Volume of the currently playing music.

Initialize()

bool pu::audio::Initialize

(

i32

mix_flags

)

Initializes the underlying audio system (SDL2-Mixer) with the specified flags.

Parameters

mix_flags

Flags to initialize the audio system with.

Returns

Whether the audio system was initialized successfully.

IsPlayingMusic()

bool pu::audio::IsPlayingMusic

(

)

Checks if music is currently playing.

Returns

Whether music is currently playing.

LoadSfx()

Sfx pu::audio::LoadSfx

(

std::string &

path

)

Loads a sound effect from the specified path.

Note

pu::audio::Initialize must be called before using this function.

The sound effect must be manually freed with pu::audio::DestroySfx when it is no longer needed.

Parameters

path	Path to the sound effect file.

Returns

Sound effect loaded, or NULL if an error occurred.

OpenMusic()

Music pu::audio::OpenMusic

(

std::string &

path

)

Opens a music file from the specified path.

Note

pu::audio::Initialize must be called before using this function.

The music file must be manually freed with pu::audio::DestroyMusic when it is no longer needed.

Parameters

path	Path to the music file.

Returns

Music file opened, or NULL if an error occurred.

PauseMusic()

void pu::audio::PauseMusic

(

)

Pauses the currently playing music.

PlayMusic()

void pu::audio::PlayMusic	(	Music	mus,
		i32	loops )

Plays a music file.

Note

pu::audio::Initialize must be called before using this function.

Parameters

mus	Music file to play. If NULL is passed, nothing will happen.
loops	Number of times to loop the music file.

PlayMusicWithFadeIn()

void pu::audio::PlayMusicWithFadeIn	(	Music	mus,
		i32	loops,
		i32	ms )

Plays a music file with a fade-in effect.

Note

pu::audio::Initialize must be called before using this function.

Parameters

mus	Music file to play. If NULL is passed, nothing will happen.
loops	Number of times to loop the music file.
ms	Time in milliseconds to fade in the music file.

PlaySfx()

void pu::audio::PlaySfx

(

Sfx

sfx

)

Plays a sound effect.

Note

pu::audio::Initialize must be called before using this function.

Parameters

sfx	Sound effect to play. If NULL is passed, nothing will happen.

ResumeMusic()

void pu::audio::ResumeMusic

(

)

Resumes the currently paused music.

RewindMusic()

void pu::audio::RewindMusic

(

)

Rewinds the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

SetMusicPosition()

void pu::audio::SetMusicPosition

(

double

sec

)

Sets the position of the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

Parameters

sec	Position in seconds to set.

SetMusicVolume()

void pu::audio::SetMusicVolume

(

i32

vol

)

Sets the volume of the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

Parameters

vol	Volume to set (0-128).

StopMusic()

void pu::audio::StopMusic

(

)

Stops the currently playing music.

Note

pu::audio::Initialize must be called before using this function.

Variable Documentation

MixerAllFlags

i32 pu::audio::MixerAllFlags = MIX_INIT_FLAC | MIX_INIT_MOD | MIX_INIT_MP3 | MIX_INIT_OGG

constexpr

Complete set of flags to initialize the audio system with: supports FLAC, MOD, MP3 and OGG formats.