pixelbullet::AudioBackend Class Reference

The abstract interface for an audio backend. More...

#include <audio_backend.h>

Inheritance diagram for pixelbullet::AudioBackend:

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

Detailed Description

The abstract interface for an audio backend.

Member Function Documentation

init()

virtual bool pixelbullet::AudioBackend::init ( )

pure virtual

Initializes the backend. Returns true on success.

Implemented in pixelbullet::MiniaudioBackend.

pause_sound()

virtual void pixelbullet::AudioBackend::pause_sound ( AudioPlaybackHandle handle )

pure virtual

Pauses an active playback handle if it still exists.

Implemented in pixelbullet::MiniaudioBackend.

play_sound()

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

pure virtual

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

Implemented in pixelbullet::MiniaudioBackend.

resume_sound()

virtual void pixelbullet::AudioBackend::resume_sound ( AudioPlaybackHandle handle )

pure virtual

Resumes an active playback handle if it still exists.

Implemented in pixelbullet::MiniaudioBackend.

set_listener_transform()

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

pure virtual

Updates the active listener transform used by spatial sounds.

Implemented in pixelbullet::MiniaudioBackend.

set_looping()

virtual void pixelbullet::AudioBackend::set_looping ( AudioPlaybackHandle handle, bool loop )

pure virtual

Updates whether an active playback loops.

Implemented in pixelbullet::MiniaudioBackend.

set_playback_position()

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

pure virtual

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

Implemented in pixelbullet::MiniaudioBackend.

set_spatial_settings()

virtual void pixelbullet::AudioBackend::set_spatial_settings ( AudioPlaybackHandle handle, AudioSpatialSettings settings )

pure virtual

Updates spatial settings for an active playback handle.

Implemented in pixelbullet::MiniaudioBackend.

set_volume()

virtual void pixelbullet::AudioBackend::set_volume ( AudioPlaybackHandle handle, float volume )

pure virtual

Updates the playback volume for an active handle.

Implemented in pixelbullet::MiniaudioBackend.

shutdown()

virtual void pixelbullet::AudioBackend::shutdown ( )

pure virtual

Shuts down the backend.

Implemented in pixelbullet::MiniaudioBackend.

stop_all()

virtual void pixelbullet::AudioBackend::stop_all ( )

pure virtual

Stops all active sounds.

Implemented in pixelbullet::MiniaudioBackend.

stop_sound()

virtual void pixelbullet::AudioBackend::stop_sound ( AudioPlaybackHandle handle )

pure virtual

Stops an active playback handle if it still exists.

Implemented in pixelbullet::MiniaudioBackend.

update()

virtual void pixelbullet::AudioBackend::update ( )

pure virtual

Performs periodic backend maintenance.

Implemented in pixelbullet::MiniaudioBackend.

---

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

• engine/src/audio/audio_backend.h