CeresEngine::AudioAPIDevice Class Reference

#include <CeresEngine/Audio/API/Device.hpp>

Inheritance diagram for CeresEngine::AudioAPIDevice:

Public Member Functions
	AudioAPIDevice ()=default
	The default constructor.
	AudioAPIDevice (const AudioAPIDevice &)=delete
	Deleted copy constructor.
AudioAPIDevice &	operator= (const AudioAPIDevice &)=delete
	Deleted copy assignment operator.
virtual	~AudioAPIDevice ()=default
	Virtual destructor.
virtual AudioAPIBufferPtr	createBuffer (const AudioAPIBufferDescriptor &descriptor)=0
	Creates a new buffer.
virtual AudioAPIListenerPtr	createListener (const AudioAPIListenerDescriptor &descriptor)=0
	Creates a new listener.
virtual AudioAPISourcePtr	createSource (const AudioAPISourceDescriptor &descriptor)=0
	Creates a new source.
virtual AudioAPIListenerPtr	getDefaultListener ()=0
Public Member Functions inherited from CeresEngine::RefCounted< AudioAPIDevice >
	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.

Constructor & Destructor Documentation

AudioAPIDevice() [1/2]

CeresEngine::AudioAPIDevice::AudioAPIDevice ( )

default

The default constructor.

AudioAPIDevice() [2/2]

CeresEngine::AudioAPIDevice::AudioAPIDevice ( const AudioAPIDevice &  )

delete

Deleted copy constructor.

~AudioAPIDevice()

virtual CeresEngine::AudioAPIDevice::~AudioAPIDevice ( )

virtualdefault

Virtual destructor.

Member Function Documentation

createBuffer()

virtual AudioAPIBufferPtr CeresEngine::AudioAPIDevice::createBuffer ( const AudioAPIBufferDescriptor &  descriptor )

pure virtual

Creates a new buffer.

Parameters

descriptor

The description of the buffer to be created.

Returns

The newly created buffer object.

Implemented in CeresEngine::ALDevice.

createListener()

virtual AudioAPIListenerPtr CeresEngine::AudioAPIDevice::createListener ( const AudioAPIListenerDescriptor &  descriptor )

pure virtual

Creates a new listener.

Parameters

descriptor

The description of the listener to be created.

Remarks

If the implementation does not support multiple listeners, this method is allowed to return nullptr.

Returns

The newly created listener object.

Implemented in CeresEngine::ALDevice.

createSource()

virtual AudioAPISourcePtr CeresEngine::AudioAPIDevice::createSource ( const AudioAPISourceDescriptor &  descriptor )

pure virtual

Creates a new source.

Parameters

descriptor

The description of the source to be created.

Returns

The newly created source object.

Implemented in CeresEngine::ALDevice.

getDefaultListener()

virtual AudioAPIListenerPtr CeresEngine::AudioAPIDevice::getDefaultListener ( )

pure virtual

Returns

The default listener object.

Implemented in CeresEngine::ALDevice.

operator=()

AudioAPIDevice & CeresEngine::AudioAPIDevice::operator= ( const AudioAPIDevice &  )

delete

Deleted copy assignment operator.

---

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

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