Nsound::AudioBackend Class Reference

#include <Nsound/AudioBackend.h>

Inheritance diagram for Nsound::AudioBackend:

Public Types
enum	State { BACKEND_NOT_INITIALIZED, BACKEND_READY, BACKEND_ERROR }

Public Member Functions
	AudioBackend (uint32 sample_rate=44100, uint32 channels=1, uint32 bits_per_sample=16)
virtual	~AudioBackend ()
virtual AudioBackendType	getBackendType ()=0
uint32	getBitsPerSample ()
uint32	getChannels ()
virtual std::string	getError ()=0
virtual std::string	getInfo ()=0
uint32	getSampleRate ()
State	getState ()
std::string	getStateString ()
	Returns the backend state. More...
virtual void	initialize ()=0
virtual void	play (void *data, uint32 n_bytes)=0
virtual void	scanDevices (AudioPlayback &pb, const AudioStream &test_clip)=0
virtual void	setOption (const std::string &key, const std::string &value)=0
virtual void	shutdown ()=0

Static Public Member Functions
static std::string	getStateString (const AudioBackend::State &state)
	Returns the backend state string. More...

Protected Attributes
uint32	sample_rate_
uint32	channels_
uint32	bits_per_sample_
State	state_

Detailed Description

Definition at line 48 of file AudioBackend.h.

Member Enumeration Documentation

enum Nsound::AudioBackend::State

Enumerator
BACKEND_NOT_INITIALIZED
BACKEND_READY
BACKEND_ERROR

Definition at line 52 of file AudioBackend.h.

    {
        BACKEND_NOT_INITIALIZED,
        BACKEND_READY,
        BACKEND_ERROR,
    };

Constructor & Destructor Documentation

Nsound::AudioBackend::AudioBackend ( uint32  sample_rate = 44100, uint32  channels = 1, uint32  bits_per_sample = 16  )

inline

Definition at line 59 of file AudioBackend.h.

        :
        sample_rate_(sample_rate),
        channels_(channels),
        bits_per_sample_(bits_per_sample),
        state_(BACKEND_NOT_INITIALIZED){};

virtual Nsound::AudioBackend::~AudioBackend ( )

inlinevirtual

Definition at line 70 of file AudioBackend.h.

{};

Member Function Documentation

virtual AudioBackendType Nsound::AudioBackend::getBackendType ( )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

uint32 Nsound::AudioBackend::getBitsPerSample ( )

inline

Definition at line 77 of file AudioBackend.h.

References bits_per_sample_.

Referenced by Nsound::AudioPlayback::getBitsPerSample().

{return bits_per_sample_;};

uint32 Nsound::AudioBackend::getChannels ( )

inline

Definition at line 80 of file AudioBackend.h.

References channels_.

Referenced by Nsound::AudioPlayback::getChannels(), and play_int().

{return channels_;};

virtual std::string Nsound::AudioBackend::getError ( )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::getError(), Nsound::AudioPlayback::initialize(), and Nsound::AudioPlayback::scanDevices().

virtual std::string Nsound::AudioBackend::getInfo ( )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::getInfo().

uint32 Nsound::AudioBackend::getSampleRate ( )

inline

Definition at line 91 of file AudioBackend.h.

References sample_rate_.

Referenced by Nsound::AudioPlayback::getSampleRate().

{return sample_rate_;};

State Nsound::AudioBackend::getState ( )

inline

Definition at line 94 of file AudioBackend.h.

References state_.

Referenced by Nsound::AudioPlayback::getState(), Nsound::AudioPlayback::initialize(), Nsound::AudioPlayback::scanDevices(), and Nsound::AudioPlayback::setOption().

{return state_;};

std::string AudioBackend::getStateString

(

)

Returns the backend state.

Definition at line 43 of file AudioBackend.cc.

References state_, and state_strings.

Referenced by Nsound::AudioPlayback::getStateString().

{
    return state_strings[state_];
}

std::string AudioBackend::getStateString ( const AudioBackend::State &  state )

static

Returns the backend state string.

Definition at line 51 of file AudioBackend.cc.

References BACKEND_ERROR, BACKEND_NOT_INITIALIZED, and state_strings.

{
    if( state >= BACKEND_NOT_INITIALIZED &&
        state <= BACKEND_ERROR)
    {
        return state_strings[state];
    }

    return "Unknown Backend State";
}

virtual void Nsound::AudioBackend::initialize ( )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::initialize().

virtual void Nsound::AudioBackend::play ( void *  data, uint32  n_bytes  )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by play_int().

virtual void Nsound::AudioBackend::scanDevices ( AudioPlayback &  pb, const AudioStream &  test_clip  )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::scanDevices().

virtual void Nsound::AudioBackend::setOption ( const std::string &  key, const std::string &  value  )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::setOption().

virtual void Nsound::AudioBackend::shutdown ( )

pure virtual

Implemented in Nsound::AudioBackendLibportaudio, and Nsound::AudioBackendLibao.

Referenced by Nsound::AudioPlayback::shutdown(), and Nsound::AudioPlayback::~AudioPlayback().

Member Data Documentation

uint32 Nsound::AudioBackend::sample_rate_

protected

Definition at line 127 of file AudioBackend.h.

Referenced by getSampleRate(), Nsound::AudioBackendLibao::initialize(), and Nsound::AudioBackendLibportaudio::initialize().

uint32 Nsound::AudioBackend::channels_

protected

Definition at line 128 of file AudioBackend.h.

Referenced by getChannels(), Nsound::AudioBackendLibao::initialize(), and Nsound::AudioBackendLibportaudio::initialize().

uint32 Nsound::AudioBackend::bits_per_sample_

protected

Definition at line 129 of file AudioBackend.h.

Referenced by getBitsPerSample(), Nsound::AudioBackendLibao::initialize(), and Nsound::AudioBackendLibportaudio::initialize().

State Nsound::AudioBackend::state_

protected

Definition at line 130 of file AudioBackend.h.

Referenced by Nsound::AudioBackendLibao::getInfo(), Nsound::AudioBackendLibportaudio::getInfo(), getState(), getStateString(), Nsound::AudioBackendLibao::initialize(), Nsound::AudioBackendLibportaudio::initialize(), Nsound::AudioBackendLibao::play(), Nsound::AudioBackendLibportaudio::play(), Nsound::AudioBackendLibao::setOption(), Nsound::AudioBackendLibportaudio::setOption(), Nsound::AudioBackendLibao::shutdown(), Nsound::AudioBackendLibportaudio::shutdown(), and Nsound::AudioBackendLibportaudio::~AudioBackendLibportaudio().

---

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

• Nsound/AudioBackend.h
• Nsound/AudioBackend.cc