CeresEngine::ALAudioAPI Class Reference

#include <CeresEngine/Audio/API/OpenAL/ALAudioAPI.hpp>

Inheritance diagram for CeresEngine::ALAudioAPI:

Public Member Functions
	ALAudioAPI ()
	Creates a new OpenAL renderer.
	~ALAudioAPI () final
	Virtual destructor.
AudioAPIDevicePtr	getDefaultDevice () const final
Public Member Functions inherited from CeresEngine::AudioAPI
	AudioAPI ()=default
	The default constructor.
	AudioAPI (const AudioAPI &)=delete
	Deleted copy constructor.
AudioAPI &	operator= (const AudioAPI &)=delete
	Deleted copy assignment operator.
virtual	~AudioAPI ()=default
	Virtual destructor.
Public Member Functions inherited from CeresEngine::RefCounted< AudioAPI >
	RefCounted (Args &&... args)
	Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Static Public Member Functions
static bool	available () noexcept
	Checks if the OpenAL renderer is available for loading.

Private Attributes
DynamicLibrary	library
	The loaded OpenAL library.
AudioAPIDevicePtr	defaultDevice
	The default OpenAL device.

Constructor & Destructor Documentation

ALAudioAPI()

CeresEngine::ALAudioAPI::ALAudioAPI

(

)

Creates a new OpenAL renderer.

~ALAudioAPI()

CeresEngine::ALAudioAPI::~ALAudioAPI ( )

final

Virtual destructor.

Member Function Documentation

available()

static bool CeresEngine::ALAudioAPI::available ( )

staticnoexcept

Checks if the OpenAL renderer is available for loading.

Returns

true if an ALRenderer can be instantiated and is available on the system.

getDefaultDevice()

AudioAPIDevicePtr CeresEngine::ALAudioAPI::getDefaultDevice ( ) const

finalvirtual

Implements CeresEngine::AudioAPI.

Member Data Documentation

defaultDevice

AudioAPIDevicePtr CeresEngine::ALAudioAPI::defaultDevice

private

The default OpenAL device.

library

DynamicLibrary CeresEngine::ALAudioAPI::library

private

The loaded OpenAL library.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/API/OpenAL/ALAudioAPI.hpp