Jopnal Engine  alpha 0.4
Simple Component Based 2D/3D Game Engine
Public Member Functions | Static Public Member Functions | List of all members
jop::AudioDevice Class Referencefinal

#include <AudioDevice.hpp>

Inheritance diagram for jop::AudioDevice:
jop::Subsystem

Public Member Functions

 AudioDevice ()
 Default constructor. More...
 
 ~AudioDevice () override
 Destructor. More...
 
- Public Member Functions inherited from jop::Subsystem
 Subsystem (const uint32 ID)
 Constructor. More...
 
virtual ~Subsystem ()=0
 Virtual destructor. More...
 
virtual void preUpdate (const float deltaTime)
 Pre-update. More...
 
virtual void postUpdate (const float deltaTime)
 Post-update. More...
 
virtual void draw ()
 Draw. More...
 
Message::Result sendMessage (const Message &message)
 Function to handle messages. More...
 
SubsystemsetActive (const bool active)
 Set this sub system active. More...
 
bool isActive () const
 Check if this sub system is active. More...
 
uint32 getID () const
 Get the ID. More...
 

Static Public Member Functions

static void setDevice (const std::string &device)
 Set new device for audio output. More...
 
static std::string getDeviceName ()
 
static std::string getAllDeviceNames ()
 
static ALCdevice_struct & getDevice ()
 
static ALCcontext_struct & getContext ()
 

Additional Inherited Members

- Protected Member Functions inherited from jop::Subsystem
virtual Message::Result receiveMessage (const Message &message)
 Receive a message. More...
 

Detailed Description

Handle to operating system's audio management application

Definition at line 38 of file AudioDevice.hpp.

Constructor & Destructor Documentation

jop::AudioDevice::AudioDevice ( )

Default constructor.

Initializes preferred device for output audio

jop::AudioDevice::~AudioDevice ( )
override

Destructor.

Member Function Documentation

static std::string jop::AudioDevice::getAllDeviceNames ( )
static
Returns
All audio device names
static ALCcontext_struct& jop::AudioDevice::getContext ( )
static
Returns
Audio context
static ALCdevice_struct& jop::AudioDevice::getDevice ( )
static
Returns
Audio device
static std::string jop::AudioDevice::getDeviceName ( )
static
Returns
Default audio device's name
static void jop::AudioDevice::setDevice ( const std::string &  device)
static

Set new device for audio output.

Parameters
deviceAudio device's name

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