Nebula
Loading...
Searching...
No Matches
Audio::AudioServer Class Reference

#include <audioserver.h>

Detailed Description

Front-end of the Audio subsystem.

Initializes the audio subsystem.

Inherits Core::RefCounted.

Public Member Functions

 AudioServer ()
 
 ~AudioServer ()
 
bool Open ()
 Initialize the audio subsystem.
 
bool Close ()
 Shutdown the audio subsystem.
 
bool IsOpen () const
 return true if the audio subsystem is open
 
void OnFrame ()
 called per-frame
 
- Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
 
int GetRefCount () const
 get the current refcount
 
void AddRef ()
 increment refcount by one
 
void Release ()
 decrement refcount and destroy object if refcount is zero
 
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
 
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
 
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
 
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
 
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
 
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
 
const Util::StringGetClassName () const
 get the class name
 
Util::FourCC GetClassFourCC () const
 get the class FourCC code
 

Private Member Functions

 __DeclareClass (AudioServer)
 
 __DeclareSingleton (AudioServer)
 

Private Attributes

bool isOpen
 
Ptr< AudioDevicedevice
 

Additional Inherited Members

- Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
 
- Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)
 

Constructor & Destructor Documentation

◆ AudioServer()

Audio::AudioServer::AudioServer ( )

◆ ~AudioServer()

Audio::AudioServer::~AudioServer ( )

Member Function Documentation

◆ __DeclareClass()

Audio::AudioServer::__DeclareClass ( AudioServer )
private

◆ __DeclareSingleton()

Audio::AudioServer::__DeclareSingleton ( AudioServer )
private

◆ Close()

bool Audio::AudioServer::Close ( )

Shutdown the audio subsystem.

◆ IsOpen()

bool Audio::AudioServer::IsOpen ( ) const
inline

return true if the audio subsystem is open

◆ OnFrame()

void Audio::AudioServer::OnFrame ( )

called per-frame

◆ Open()

bool Audio::AudioServer::Open ( )

Initialize the audio subsystem.

Member Data Documentation

◆ device

Ptr<AudioDevice> Audio::AudioServer::device
private

◆ isOpen

bool Audio::AudioServer::isOpen
private

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