pixelbullet::MiniaudioBackend Class Reference

Implementation of the AudioBackend interface using the miniaudio engine. More...

#include <miniaudio_backend.h>

Inheritance diagram for pixelbullet::MiniaudioBackend:

Classes
struct	ActiveSound

Public Member Functions
virtual bool	init () override
	Initializes the backend. Returns true on success.
virtual void	shutdown () override
	Shuts down the backend.
virtual void	update () override
	Performs periodic backend maintenance.
virtual void	play_sound (AudioPlaybackHandle handle, const std::string &file_path, AudioPlaybackSettings settings) override
	Plays the sound file at filePath using an owned playback handle.
virtual void	stop_sound (AudioPlaybackHandle handle) override
	Stops an active playback handle if it still exists.
virtual void	pause_sound (AudioPlaybackHandle handle) override
	Pauses an active playback handle if it still exists.
virtual void	resume_sound (AudioPlaybackHandle handle) override
	Resumes an active playback handle if it still exists.
virtual void	set_volume (AudioPlaybackHandle handle, float volume) override
	Updates the playback volume for an active handle.
virtual void	set_looping (AudioPlaybackHandle handle, bool loop) override
	Updates whether an active playback loops.
virtual void	set_listener_transform (glm::vec3 position, glm::vec3 forward, glm::vec3 up) override
	Updates the active listener transform used by spatial sounds.
virtual void	set_spatial_settings (AudioPlaybackHandle handle, AudioSpatialSettings settings) override
	Updates spatial settings for an active playback handle.
virtual void	set_playback_position (AudioPlaybackHandle handle, glm::vec3 position) override
	Updates the world-space position of an active playback handle.
virtual void	stop_all () override
	Stops all active sounds.

Detailed Description

Implementation of the AudioBackend interface using the miniaudio engine.

Member Function Documentation

init()

bool pixelbullet::MiniaudioBackend::init ( )

overridevirtual

Initializes the backend. Returns true on success.

Implements pixelbullet::AudioBackend.

pause_sound()

void pixelbullet::MiniaudioBackend::pause_sound ( AudioPlaybackHandle handle )

overridevirtual

Pauses an active playback handle if it still exists.

Implements pixelbullet::AudioBackend.

play_sound()

void pixelbullet::MiniaudioBackend::play_sound ( AudioPlaybackHandle handle, const std::string & file_path, AudioPlaybackSettings settings )

overridevirtual

Plays the sound file at filePath using an owned playback handle.

Implements pixelbullet::AudioBackend.

resume_sound()

void pixelbullet::MiniaudioBackend::resume_sound ( AudioPlaybackHandle handle )

overridevirtual

Resumes an active playback handle if it still exists.

Implements pixelbullet::AudioBackend.

set_listener_transform()

void pixelbullet::MiniaudioBackend::set_listener_transform ( glm::vec3 position, glm::vec3 forward, glm::vec3 up )

overridevirtual

Updates the active listener transform used by spatial sounds.

Implements pixelbullet::AudioBackend.

set_looping()

void pixelbullet::MiniaudioBackend::set_looping ( AudioPlaybackHandle handle, bool loop )

overridevirtual

Updates whether an active playback loops.

Implements pixelbullet::AudioBackend.

set_playback_position()

void pixelbullet::MiniaudioBackend::set_playback_position ( AudioPlaybackHandle handle, glm::vec3 position )

overridevirtual

Updates the world-space position of an active playback handle.

Implements pixelbullet::AudioBackend.

set_spatial_settings()

void pixelbullet::MiniaudioBackend::set_spatial_settings ( AudioPlaybackHandle handle, AudioSpatialSettings settings )

overridevirtual

Updates spatial settings for an active playback handle.

Implements pixelbullet::AudioBackend.

set_volume()

void pixelbullet::MiniaudioBackend::set_volume ( AudioPlaybackHandle handle, float volume )

overridevirtual

Updates the playback volume for an active handle.

Implements pixelbullet::AudioBackend.

shutdown()

void pixelbullet::MiniaudioBackend::shutdown ( )

overridevirtual

Shuts down the backend.

Implements pixelbullet::AudioBackend.

stop_all()

void pixelbullet::MiniaudioBackend::stop_all ( )

overridevirtual

Stops all active sounds.

Implements pixelbullet::AudioBackend.

stop_sound()

void pixelbullet::MiniaudioBackend::stop_sound ( AudioPlaybackHandle handle )

overridevirtual

Stops an active playback handle if it still exists.

Implements pixelbullet::AudioBackend.

update()

void pixelbullet::MiniaudioBackend::update ( )

overridevirtual

Performs periodic backend maintenance.

Implements pixelbullet::AudioBackend.

---

The documentation for this class was generated from the following files:

• engine/src/audio/backends/miniaudio_backend.h
• engine/src/audio/backends/miniaudio_backend.cc