OpenAL Class Reference

3D audio setup and playback. More...

#include <util/util.hh>

Inherits SingletonT< OpenAL >.

Public Member Functions
OpenALSinkPtr	CreateSink (sdf::ElementPtr _sdf)
	Create an audio listener. More...
OpenALSourcePtr	CreateSource (sdf::ElementPtr _sdf)
	Create an OpenALSource object. More...
std::set< std::string >	DeviceList () const
	Get a list of available audio devices. More...
void	Fini ()
	Finalize. More...
bool	Load (sdf::ElementPtr _sdf=sdf::ElementPtr())
	Load the OpenAL server. More...

Static Public Member Functions
static OpenAL *	Instance ()
	Get an instance of the singleton. More...

Detailed Description

3D audio setup and playback.

Member Function Documentation

CreateSink()

OpenALSinkPtr CreateSink

(

sdf::ElementPtr

_sdf

)

Create an audio listener.

Currenly, only one listener may be created.

Parameters

[in]

_sdf

SDF element parameters for an audio_source.

Returns

A pointer to an OpenALSink object.

CreateSource()

OpenALSourcePtr CreateSource

(

sdf::ElementPtr

_sdf

)

Create an OpenALSource object.

Parameters

[in]

_sdf

SDF element parameters for an audio_source.

Returns

A pointer to an OpenALSource object.

DeviceList()

std::set<std::string> DeviceList

(

)

const

Get a list of available audio devices.

Returns

A list of audio device names

Fini()

void Fini

(

)

Finalize.

Instance()

static OpenAL * Instance ( )

inlinestaticinherited

Get an instance of the singleton.

Load()

bool Load

(

sdf::ElementPtr

_sdf = sdf::ElementPtr()

)

Load the OpenAL server.

Returns

True on success.

---

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

• OpenAL.hh