openalpp Namespace Reference

Classes
class	AudioBase
class	AudioConvert
struct	_acAudioCVT
struct	Chunk
struct	MS_ADPCM_decodestate_FULL
struct	WaveFMT
struct	IMA_ADPCM_decodestate_s
struct	IMA_ADPCM_decoder
class	AudioEnvironment
class	Error
class	FatalError
class	FileError
class	MemoryError
class	NameError
class	ValueError
class	InitError
class	FileStream
class	FileStreamUpdater
class	GroupSource
class	InputDevice
class	Listener
class	NetStream
class	NetUpdater
class	PositionedObject
class	ref_ptr
class	Referenced
class	DeleteHandler
class	Sample
class	SoundData
class	Source
class	SourceBase
class	Stream
class	StreamUpdater
Typedefs
typedef openalpp::_acAudioCVT	acAudioCVT
typedef openalpp::Chunk	Chunk
typedef openalpp::WaveFMT	alWaveFMT_LOKI
typedef openalpp::IMA_ADPCM_decodestate_s	alIMAADPCM_decodestate_LOKI
typedef openalpp::IMA_ADPCM_decoder	alIMAADPCM_state_LOKI
Enumerations
enum	SampleFormat { Mono8, Stereo8, Mono16, Stereo16 }
enum	DistanceModel { None, InverseDistance, InverseDistanceClamped }
enum	SourceState { Initial, Playing, Paused, Stopped }
Functions
OPENALPP_API std::ostream &	operator<< (std::ostream &stream, const Error &error)
unsigned int	sampleSize (SampleFormat format)
unsigned int	sampleSize (ALenum format)

---

Detailed Description

Namespace for OpenAL++.

---

Typedef Documentation

typedef struct openalpp::_acAudioCVT openalpp::acAudioCVT

typedef struct openalpp::Chunk openalpp::Chunk

typedef struct openalpp::WaveFMT openalpp::alWaveFMT_LOKI

typedef struct openalpp::IMA_ADPCM_decodestate_s openalpp::alIMAADPCM_decodestate_LOKI

typedef struct openalpp::IMA_ADPCM_decoder openalpp::alIMAADPCM_state_LOKI

---

Enumeration Type Documentation

enum openalpp::SampleFormat

Format for sound data. Mono/Stereo, 8 or 16 bits.

Enumerator:

Mono8
Stereo8
Mono16
Stereo16

enum openalpp::DistanceModel

Enum for setting/getting the current distance model. None means no model is in use, i.e. no attenuation.
InverseDistance:

• 
• 
• 

InverseDistanceClamped:

• 
• 
• And then the calculations in InverseDistance... This is equivalent to the <a href="http://www.iasig.org>IASIG I3DL2 distance model.
  

In the above calculations, the variables have the following meanings:

• dist is the distance from the listener to the source.
  
• REFERENCE_DISTANCE are the distance at which the listener will experience GAIN. Both are set per source.
  
• ROLLOFF is a source specific factor of attenuation. If it's set to one, the InverseDistance model will describe a "physically correct" inverse square behaviour.
  
• MIN_GAIN, MAX_GAIN and MAX_DISTANCE are values used for clamping gain and distance, respectively.

Enumerator:

None
InverseDistance
InverseDistanceClamped

enum openalpp::SourceState

Enum for the different states of a source. When a source is created, it is in the Initial state. Rewind will return a source to this state. The other states should be obvious.

Enumerator:

Initial
Playing
Paused
Stopped

---

Function Documentation

OPENALPP_API std::ostream& openalpp::operator<<	(	std::ostream &	stream,
		const Error &	error
	)

Out stream operator. Used to print error messages to a stream (i.e. "cerr << error;").

Parameters:

	stream	is the stream to print to.
	error	is the error to print.

Returns:

the stream.

unsigned int openalpp::sampleSize

(

SampleFormat

format

)

Check how large a sample is in the given format.

unsigned int openalpp::sampleSize

(

ALenum

format

)

---