SoundDriver_XAudio2 Class Reference

Implementation of the XAudio2 sound driver. More...

#include <xaudio2_s.h>

Inheritance diagram for SoundDriver_XAudio2:

Public Member Functions
std::optional< std::string_view >	Start (const StringList &param) override
	Initialises the XAudio2 driver.
void	Stop () override
	Terminates the XAudio2 driver.
std::string_view	GetName () const override
	Get the name of this driver.
Public Member Functions inherited from SoundDriver
virtual void	MainLoop ()
	Called once every tick.
virtual bool	HasOutput () const
	Whether the driver has an output from which the user can hear sound.

Additional Inherited Members
Public Types inherited from Driver
enum	Type : uint8_t {   DT_BEGIN = 0 , DT_MUSIC = 0 , DT_SOUND , DT_VIDEO ,   DT_END }
	The type of driver. More...
Static Public Member Functions inherited from SoundDriver
static SoundDriver *	GetInstance ()
	Get the currently active instance of the sound driver.

Detailed Description

Implementation of the XAudio2 sound driver.

Definition at line 16 of file xaudio2_s.h.

Member Function Documentation

GetName()

std::string_view SoundDriver_XAudio2::GetName ( ) const

inlineoverridevirtual

Get the name of this driver.

Returns

The name of the driver.

Implements Driver.

Definition at line 21 of file xaudio2_s.h.

Start()

std::optional< std::string_view > SoundDriver_XAudio2::Start ( const StringList &  parm )

overridevirtual

Initialises the XAudio2 driver.

Parameters

parm	Driver parameters.

Returns

An error message if unsuccessful, or std::nullopt otherwise.

Implements Driver.

Definition at line 134 of file xaudio2_s.cpp.

References CreateXAudio(), Debug, GetDriverParamInt(), and Stop().

Stop()

void SoundDriver_XAudio2::Stop ( )

overridevirtual

Terminates the XAudio2 driver.

Implements Driver.

Definition at line 250 of file xaudio2_s.cpp.

Referenced by Start().

---

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

• src/sound/xaudio2_s.h
• src/sound/xaudio2_s.cpp