Public Member Functions | List of all members
gazebo::util::OpenAL Class Reference

3D audio setup and playback. More...

#include <util/util.hh>

Inheritance diagram for gazebo::util::OpenAL:
Inheritance graph
[legend]

Public Member Functions

OpenALSinkPtr CreateSink (sdf::ElementPtr _sdf)
 Create an audio listener. More...
 
OpenALSourcePtr CreateSource (sdf::ElementPtr _sdf)
 Create an OpenALSource object. More...
 
void Fini ()
 Finalize. More...
 
bool Load (sdf::ElementPtr _sdf=sdf::ElementPtr())
 Load the OpenAL server. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< OpenAL >
static OpenAL * Instance ()
 Get an instance of the singleton. More...
 
- Protected Member Functions inherited from SingletonT< OpenAL >
 SingletonT ()
 Constructor. More...
 
virtual ~SingletonT ()
 Destructor. More...
 

Detailed Description

3D audio setup and playback.

Member Function Documentation

OpenALSinkPtr gazebo::util::OpenAL::CreateSink ( sdf::ElementPtr  _sdf)

Create an audio listener.

Currenly, only one listener may be created.

Parameters
[in]_sdfSDF element parameters for an audio_source.
Returns
A pointer to an OpenALSink object.
OpenALSourcePtr gazebo::util::OpenAL::CreateSource ( sdf::ElementPtr  _sdf)

Create an OpenALSource object.

Parameters
[in]_sdfSDF element parameters for an audio_source.
Returns
A pointer to an OpenALSource object.
void gazebo::util::OpenAL::Fini ( )

Finalize.

bool gazebo::util::OpenAL::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: