lss::CSoundLib Class Reference

#include <LSSSoundLib.h>

List of all members.

Classes
struct	LSS_CHANNEL_ARRANGEMENT
Public Types
enum	LSS_CHANNELS {   LSS_C_MONO8, LSS_C_MONO16, LSS_C_MONO_FLOAT32, LSS_C_STEREO8,   LSS_C_STEREO16, LSS_C_STEREO_FLOAT32, LSS_C_MONO_IMA4, LSS_C_STEREO_IMA4,   LSS_C_QUAD8_LOKI, LSS_C_QUAD16_LOKI, LSS_C_QUAD8, LSS_C_QUAD16,   LSS_C_QUAD32, LSS_C_51CHN8, LSS_C_51CHN16, LSS_C_51CHN32,   LSS_C_61CHN8, LSS_C_61CHN16, LSS_C_61CHN32, LSS_C_71CHN8,   LSS_C_71CHN16, LSS_C_71CHN32, LSS_C_REAR8, LSS_C_REAR16,   LSS_C_REAR32, LSS_C_TOTAL }
Static Public Member Functions
static LSVOID LSE_CALL	InitSoundLibrary ()
static LSVOID LSE_CALL	PostInitSoundLibrary ()
static LSVOID LSE_CALL	ShutDownSoundLibrary ()
static LSUINT32 LSE_CALL	GetTotalDevices ()
static LSUINT32 LSE_CALL	GetLongestDeviceName ()
static LSBOOL LSE_CALL	GetDeviceNameByIndex (LSUINT32 _ui32Index, LSCHAR *_pcNameReturn, LSUINT32 _ui32MaxLen)
static LSBOOL LSE_CALL	ChannelArrangementSupported (LSS_CHANNELS _cArrangement)
static LSUINT32 LSE_CALL	GetOsChannelEnum (LSS_CHANNELS _cArrangement)
static LSUINT32 LSE_CALL	GetBitsPerChannel (LSS_CHANNELS _cArrangement)
static LSUINT32 LSE_CALL	GetChannels (LSS_CHANNELS _cArrangement)
Protected Types
typedef struct lss::CSoundLib::LSS_CHANNEL_ARRANGEMENT *	LPLSS_CHANNEL_ARRANGEMENT
typedef struct lss::CSoundLib::LSS_CHANNEL_ARRANGEMENT	LPCLSS_CHANNEL_ARRANGEMENT
Static Protected Attributes
static LSBOOL	m_bEnumDevices
static const ALCchar *	m_pcDevices
static LSUINT32	m_ui32Devices
static LSUINT32	m_ui32MaxDeviceNameLength
static LSS_CHANNEL_ARRANGEMENT	m_caChannels [LSS_C_TOTAL]

---

Detailed Description

Class CSoundLib

Description: The core of the sound library.

---

Member Typedef Documentation

typedef struct lss::CSoundLib::LSS_CHANNEL_ARRANGEMENT * lss::CSoundLib::LPLSS_CHANNEL_ARRANGEMENT [protected]

A type that holds channel/bit-depth/enum strings/etc. we will need.

---

Member Enumeration Documentation

enum lss::CSoundLib::LSS_CHANNELS

Channel types and arrangements.

---

Member Function Documentation

static LSBOOL LSE_CALL lss::CSoundLib::ChannelArrangementSupported

(

LSS_CHANNELS

_cArrangement

)

[static]

Is the given speaker arrangement supported? Use a LSS_C_* to check.

Parameters:

_cArrangement

Channel arrangement to test.

Returns:

Returns true if the given channel arrangement is supported.

static LSUINT32 LSE_CALL lss::CSoundLib::GetBitsPerChannel

(

LSS_CHANNELS

_cArrangement

)

[static]

Get the number of bits per channel given an LSS_CHANNELS value.

Parameters:

_cArrangement

Arrangement whose bit count is to be obtained.

Returns:

Returns the number of bits per channel on the given arrangement.

static LSUINT32 LSE_CALL lss::CSoundLib::GetChannels

(

LSS_CHANNELS

_cArrangement

)

[static]

Get the number of channels given an LSS_CHANNELS value.

Parameters:

_cArrangement

Arrangement whose channel count is to be obtained.

Returns:

Returns the number of channels on the given arrangement.

static LSBOOL LSE_CALL lss::CSoundLib::GetDeviceNameByIndex	(	LSUINT32	_ui32Index,
		LSCHAR *	_pcNameReturn,
		LSUINT32	_ui32MaxLen
	)		[static]

Get a device by index. The returned value is the string name of the device. _pcNameReturn should be at least GetLongestDeviceName() characters long. The actual length is given in _ui32MaxLen. Writing to _pcNameReturn will not exceed this length. The returned string is always appended with a terminating NULL unless it is of 0 length, in which case false is returned. False is also returned if the index is out of range.

Parameters:

_ui32Index	Index of the device to get.
_pcNameReturn	Returned device name.
_ui32MaxLen	Length of _pcNameReturn.

Returns:

Returns true if the index is valid.

static LSUINT32 LSE_CALL lss::CSoundLib::GetLongestDeviceName

(

)

[static]

Get the length of the longest name among the devices. The length includes the terminating NULL. Allocating a string of this length guarantees it is long enough to contain any device name along with its terminating NULL.

Returns:

Returns the length of the longest name among the devices.

static LSUINT32 LSE_CALL lss::CSoundLib::GetOsChannelEnum

(

LSS_CHANNELS

_cArrangement

)

[static]

Get the OS-specific enumeration value for the given channel arrangement.

Parameters:

_cArrangement

Channel arrangement to convert to the library-specific value.

Returns:

Returns the library-specific channel enumeration.

static LSUINT32 LSE_CALL lss::CSoundLib::GetTotalDevices

(

)

[static]

Get the total number of sound devices. Always 1 on consoles.

Returns:

Returns the total number of sound devices.

static LSVOID LSE_CALL lss::CSoundLib::InitSoundLibrary

(

)

[static]

Initialize the sound library.

static LSVOID LSE_CALL lss::CSoundLib::PostInitSoundLibrary

(

)

[static]

Post-initialization of the sound library, after the game object has been created.

static LSVOID LSE_CALL lss::CSoundLib::ShutDownSoundLibrary

(

)

[static]

Destroy the sound library.

---

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

• F:/My Projects/LSEngine/Modules/LSSoundLib/Src/LSSSoundLib.h