WWAudioClass Class Reference

#include <WWAudio.h>

Classes
struct	_DRIVER_INFO_STRUCT

Public Types
enum	DRIVER_TYPE_2D { DRIVER2D_ERROR = 0 , DRIVER2D_DSOUND , DRIVER2D_WAVEOUT , DRIVER2D_COUNT }
enum	DRIVER_TYPE_3D {   DRIVER3D_ERROR = 0 , DRIVER3D_D3DSOUND , DRIVER3D_EAX , DRIVER3D_A3D ,   DRIVER3D_RSX , DRIVER3D_PSEUDO , DRIVER3D_DOLBY , DRIVER3D_COUNT }
typedef struct WWAudioClass::_DRIVER_INFO_STRUCT	DRIVER_INFO_STRUCT

Public Member Functions
	WWAudioClass (void)
virtual	~WWAudioClass (void)
void	Initialize (bool stereo=true, int bits=16, int hertz=44100)
void	Initialize (const char *registry_subkey_name)
void	Shutdown (void)
HDIGDRIVER	Get_2D_Driver (void) const
HPROVIDER	Get_3D_Driver (void) const
HPROVIDER	Get_Reverb_Filter (void) const
DRIVER_TYPE_2D	Open_2D_Device (LPWAVEFORMAT format=NULL)
DRIVER_TYPE_2D	Open_2D_Device (bool stereo, int bits, int hertz)
bool	Close_2D_Device (void)
int	Get_Playback_Rate (void) const
int	Get_Playback_Bits (void) const
bool	Get_Playback_Stereo (void) const
int	Get_3D_Device_Count (void) const
bool	Get_3D_Device (int index, DRIVER_INFO_STRUCT **info)
bool	Is_3D_Device_Available (DRIVER_TYPE_3D type)
int	Find_3D_Device (DRIVER_TYPE_3D type)
bool	Select_3D_Device (int index)
bool	Select_3D_Device (const char *device_name, HPROVIDER provider)
bool	Select_3D_Device (DRIVER_TYPE_3D type)
bool	Select_3D_Device (const char *device_name)
bool	Load_From_Registry (const char *subkey_name)
bool	Load_From_Registry (const char *subkey_name, StringClass &device_name, bool &is_stereo, int &bits, int &hertz, bool &sound_enabled, bool &music_enabled, float &sound_volume, float &music_volume)
bool	Save_To_Registry (const char *subkey_name)
bool	Save_To_Registry (const char *subkey_name, const StringClass &device_name, bool is_stereo, int bits, int hertz, bool sound_enabled, bool music_enabled, float sound_volume, float music_volume)
void	Set_File_Factory (FileFactoryClass *ffactory)
bool	Set_Max_2D_Sample_Count (int count=DEF_2D_SAMPLE_COUNT)
int	Get_Max_2D_Sample_Count (void) const
int	Get_Avail_2D_Sample_Count (void) const
bool	Set_Max_3D_Sample_Count (int count=DEF_3D_SAMPLE_COUNT)
int	Get_Max_3D_Sample_Count (void) const
int	Get_Avail_3D_Sample_Count (void) const
float	Get_Effects_Level (void)
int	Get_Reverb_Room_Type (void)
void	Set_Reverb_Room_Type (int type)
void	Set_Sound_Effects_Volume (float volume=DEF_SFX_VOL)
float	Get_Sound_Effects_Volume (void) const
void	Set_Music_Volume (float volume=DEF_MUSIC_VOL)
float	Get_Music_Volume (void) const
void	Allow_Sound_Effects (bool onoff=true)
bool	Are_Sound_Effects_On (void) const
void	Allow_Music (bool onoff=true)
bool	Is_Music_On (void) const
void	On_Frame_Update (unsigned int milliseconds=0)
void	Register_EOS_Callback (LPFNEOSCALLBACK callback, DWORD user_param)
void	UnRegister_EOS_Callback (LPFNEOSCALLBACK callback)
void	Register_Text_Callback (LPFNTEXTCALLBACK callback, DWORD user_param)
void	UnRegister_Text_Callback (LPFNTEXTCALLBACK callback)
void	Fire_Text_Callback (AudibleSoundClass *sound_obj, const StringClass &text)
bool	Is_Sound_Cached (const char *string_id)
AudibleSoundClass *	Create_Sound_Effect (FileClass &file, const char *string_id)
AudibleSoundClass *	Create_Sound_Effect (const char *filename)
AudibleSoundClass *	Create_Sound_Effect (const char *string_id, unsigned char *raw_wave_data, unsigned long bytes)
Sound3DClass *	Create_3D_Sound (FileClass &file, const char *string_id, int classid_hint=CLASSID_3D)
Sound3DClass *	Create_3D_Sound (const char *filename, int classid_hint=CLASSID_3D)
Sound3DClass *	Create_3D_Sound (const char *string_id, unsigned char *raw_wave_data, unsigned long bytes, int classid_hint=CLASSID_3D)
LogicalSoundClass *	Create_Logical_Sound (void)
LogicalListenerClass *	Create_Logical_Listener (void)
void	Add_Logical_Type (int id, LPCTSTR display_name)
void	Reset_Logical_Types (void)
int	Get_Logical_Type_Count (void) const
int	Get_Logical_Type (int index, StringClass &name)
int	Create_Instant_Sound (int definition_id, const Matrix3D &tm, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
int	Create_Instant_Sound (const char *def_name, const Matrix3D &tm, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
AudibleSoundClass *	Create_Continuous_Sound (int definition_id, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
AudibleSoundClass *	Create_Continuous_Sound (const char *def_name, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
AudibleSoundClass *	Create_Sound (int definition_id, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
AudibleSoundClass *	Create_Sound (const char *def_name, RefCountClass *user_obj=NULL, uint32 user_data=0, int classid_hint=CLASSID_3D)
SoundSceneObjClass *	Find_Sound_Object (uint32 sound_obj_id)
SoundSceneClass *	Get_Sound_Scene (void) const
bool	Set_Cache_Size (int kbytes=DEF_CACHE_SIZE)
int	Get_Cache_Size (void) const
int	Get_Current_Cache_Size (void) const
void	Set_Max_2D_Sound_Buffer (int bytes=DEF_MAX_2D_BUFFER_SIZE)
void	Set_Max_3D_Sound_Buffer (int bytes=DEF_MAX_3D_BUFFER_SIZE)
bool	Simple_Play_2D_Sound_Effect (const char *filename, float priority=1.0F, float volume=DEF_SFX_VOL)
bool	Simple_Play_2D_Sound_Effect (FileClass &file, float priority=1.0F, float volume=DEF_SFX_VOL)
bool	Add_To_Playlist (AudibleSoundClass *sound)
bool	Remove_From_Playlist (AudibleSoundClass *sound)
int	Get_Playlist_Count (void) const
AudibleSoundClass *	Get_Playlist_Entry (int index) const
AudibleSoundClass *	Peek_Playlist_Entry (int index) const
void	Flush_Playlist (void)
bool	Is_Sound_In_Playlist (AudibleSoundClass *sound_obj)
float	Get_Digital_CPU_Percent (void) const
bool	Is_Disabled (void) const
void	Free_Completed_Sounds (void)

Static Public Member Functions
static WWAudioClass *	Get_Instance (void)

Protected Member Functions
void	Build_3D_Driver_List (void)
void	Free_3D_Driver_List (void)
void	Reprioritize_Playlist (void)
bool	Validate_3D_Sound_Buffer (SoundBufferClass *buffer)
FileClass *	Get_File (LPCTSTR filename)
void	Return_File (FileClass *file)
void	Allocate_2D_Handles (void)
void	Release_2D_Handles (void)
void	Allocate_3D_Handles (void)
void	Release_3D_Handles (void)
HSAMPLE	Get_2D_Sample (const AudibleSoundClass &sound_obj)
H3DSAMPLE	Get_3D_Sample (const Sound3DClass &sound_obj)
H3DPOBJECT	Get_Listener_Handle (void)
void	ReAssign_2D_Handles (void)
void	ReAssign_3D_Handles (void)
void	Remove_2D_Sound_Handles (void)
void	Remove_3D_Sound_Handles (void)
bool	Is_OK_To_Give_Handle (const AudibleSoundClass &sound_obj)
SoundBufferClass *	Get_Sound_Buffer (FileClass &file, const char *string_id, bool is_3d)
SoundBufferClass *	Get_Sound_Buffer (const char *filename, bool is_3d)
SoundBufferClass *	Find_Cached_Buffer (const char *string_id)
SoundBufferClass *	Create_Sound_Buffer (FileClass &file, const char *string_id, bool is_3d)
SoundBufferClass *	Create_Sound_Buffer (unsigned char *file_image, unsigned long bytes, const char *string_id, bool is_3d)
bool	Cache_Buffer (SoundBufferClass *buffer, const char *string_id)
bool	Free_Cache_Space (int bytes)
void	Flush_Cache (void)

Static Protected Member Functions
static U32 AILCALLBACK	File_Open_Callback (char const *filename, U32 *file_handle)
static void AILCALLBACK	File_Close_Callback (U32 file_handle)
static S32 AILCALLBACK	File_Seek_Callback (U32 file_handle, S32 offset, U32 type)
static U32 AILCALLBACK	File_Read_Callback (U32 file_handle, void *buffer, U32 bytes)

Friends
class	AudibleSoundClass
class	Sound3DClass
class	Listener3DClass

Detailed Description

Definition at line 125 of file WWAudio.h.

Member Typedef Documentation

DRIVER_INFO_STRUCT

typedef struct WWAudioClass::_DRIVER_INFO_STRUCT WWAudioClass::DRIVER_INFO_STRUCT

Member Enumeration Documentation

DRIVER_TYPE_2D

enum WWAudioClass::DRIVER_TYPE_2D

Enumerator
DRIVER2D_ERROR
DRIVER2D_DSOUND
DRIVER2D_WAVEOUT
DRIVER2D_COUNT

Definition at line 132 of file WWAudio.h.

DRIVER_TYPE_3D

enum WWAudioClass::DRIVER_TYPE_3D

Enumerator
DRIVER3D_ERROR
DRIVER3D_D3DSOUND
DRIVER3D_EAX
DRIVER3D_A3D
DRIVER3D_RSX
DRIVER3D_PSEUDO
DRIVER3D_DOLBY
DRIVER3D_COUNT

Definition at line 140 of file WWAudio.h.

Constructor & Destructor Documentation

WWAudioClass()

WWAudioClass::WWAudioClass

(

void

)

Definition at line 107 of file WWAudio.cpp.

~WWAudioClass()

WWAudioClass::~WWAudioClass ( void )

virtual

Definition at line 157 of file WWAudio.cpp.

Member Function Documentation

Add_Logical_Type()

void WWAudioClass::Add_Logical_Type	(	int	id,
		LPCTSTR	display_name )

Definition at line 2497 of file WWAudio.cpp.

Add_To_Playlist()

bool WWAudioClass::Add_To_Playlist

(

AudibleSoundClass *

sound

)

Definition at line 1182 of file WWAudio.cpp.

Allocate_2D_Handles()

void WWAudioClass::Allocate_2D_Handles ( void )

protected

Definition at line 1383 of file WWAudio.cpp.

Allocate_3D_Handles()

void WWAudioClass::Allocate_3D_Handles ( void )

protected

Definition at line 1833 of file WWAudio.cpp.

Allow_Music()

void WWAudioClass::Allow_Music

(

bool

onoff = true

)

Definition at line 2341 of file WWAudio.cpp.

Allow_Sound_Effects()

void WWAudioClass::Allow_Sound_Effects

(

bool

onoff = true

)

Definition at line 2306 of file WWAudio.cpp.

Are_Sound_Effects_On()

bool WWAudioClass::Are_Sound_Effects_On ( void ) const

inline

Definition at line 275 of file WWAudio.h.

Build_3D_Driver_List()

void WWAudioClass::Build_3D_Driver_List ( void )

protected

Definition at line 1565 of file WWAudio.cpp.

Cache_Buffer()

bool WWAudioClass::Cache_Buffer ( SoundBufferClass * buffer, const char * string_id )

protected

Definition at line 506 of file WWAudio.cpp.

Close_2D_Device()

bool WWAudioClass::Close_2D_Device

(

void

)

Definition at line 326 of file WWAudio.cpp.

Create_3D_Sound() [1/3]

Sound3DClass * WWAudioClass::Create_3D_Sound	(	const char *	filename,
		int	classid_hint = CLASSID_3D )

Definition at line 778 of file WWAudio.cpp.

Create_3D_Sound() [2/3]

Sound3DClass * WWAudioClass::Create_3D_Sound	(	const char *	string_id,
		unsigned char *	raw_wave_data,
		unsigned long	bytes,
		int	classid_hint = CLASSID_3D )

Definition at line 831 of file WWAudio.cpp.

Create_3D_Sound() [3/3]

Sound3DClass * WWAudioClass::Create_3D_Sound	(	FileClass &	file,
		const char *	string_id,
		int	classid_hint = CLASSID_3D )

Definition at line 742 of file WWAudio.cpp.

Create_Continuous_Sound() [1/2]

AudibleSoundClass * WWAudioClass::Create_Continuous_Sound	(	const char *	def_name,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 1030 of file WWAudio.cpp.

Create_Continuous_Sound() [2/2]

AudibleSoundClass * WWAudioClass::Create_Continuous_Sound	(	int	definition_id,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 964 of file WWAudio.cpp.

Create_Instant_Sound() [1/2]

int WWAudioClass::Create_Instant_Sound	(	const char *	def_name,
		const Matrix3D &	tm,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 1060 of file WWAudio.cpp.

Create_Instant_Sound() [2/2]

int WWAudioClass::Create_Instant_Sound	(	int	definition_id,
		const Matrix3D &	tm,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 993 of file WWAudio.cpp.

Create_Logical_Listener()

LogicalListenerClass * WWAudioClass::Create_Logical_Listener

(

void

)

Definition at line 2485 of file WWAudio.cpp.

Create_Logical_Sound()

LogicalSoundClass * WWAudioClass::Create_Logical_Sound

(

void

)

Definition at line 2473 of file WWAudio.cpp.

Create_Sound() [1/2]

AudibleSoundClass * WWAudioClass::Create_Sound	(	const char *	def_name,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 921 of file WWAudio.cpp.

Create_Sound() [2/2]

AudibleSoundClass * WWAudioClass::Create_Sound	(	int	definition_id,
		RefCountClass *	user_obj = NULL,
		uint32	user_data = 0,
		int	classid_hint = CLASSID_3D )

Definition at line 878 of file WWAudio.cpp.

Create_Sound_Buffer() [1/2]

SoundBufferClass * WWAudioClass::Create_Sound_Buffer ( FileClass & file, const char * string_id, bool is_3d )

protected

Definition at line 562 of file WWAudio.cpp.

Create_Sound_Buffer() [2/2]

SoundBufferClass * WWAudioClass::Create_Sound_Buffer ( unsigned char * file_image, unsigned long bytes, const char * string_id, bool is_3d )

protected

Definition at line 613 of file WWAudio.cpp.

Create_Sound_Effect() [1/3]

AudibleSoundClass * WWAudioClass::Create_Sound_Effect

(

const char *

filename

)

Definition at line 676 of file WWAudio.cpp.

Create_Sound_Effect() [2/3]

AudibleSoundClass * WWAudioClass::Create_Sound_Effect	(	const char *	string_id,
		unsigned char *	raw_wave_data,
		unsigned long	bytes )

Definition at line 709 of file WWAudio.cpp.

Create_Sound_Effect() [3/3]

AudibleSoundClass * WWAudioClass::Create_Sound_Effect	(	FileClass &	file,
		const char *	string_id )

Definition at line 651 of file WWAudio.cpp.

File_Close_Callback()

void AILCALLBACK WWAudioClass::File_Close_Callback ( U32 file_handle )

staticprotected

Definition at line 2777 of file WWAudio.cpp.

File_Open_Callback()

U32 AILCALLBACK WWAudioClass::File_Open_Callback ( char const * filename, U32 * file_handle )

staticprotected

Definition at line 2751 of file WWAudio.cpp.

File_Read_Callback()

U32 AILCALLBACK WWAudioClass::File_Read_Callback ( U32 file_handle, void * buffer, U32 bytes )

staticprotected

Definition at line 2845 of file WWAudio.cpp.

File_Seek_Callback()

S32 AILCALLBACK WWAudioClass::File_Seek_Callback ( U32 file_handle, S32 offset, U32 type )

staticprotected

Definition at line 2800 of file WWAudio.cpp.

Find_3D_Device()

int WWAudioClass::Find_3D_Device

(

DRIVER_TYPE_3D

type

)

Definition at line 1782 of file WWAudio.cpp.

Find_Cached_Buffer()

SoundBufferClass * WWAudioClass::Find_Cached_Buffer ( const char * string_id )

protected

Definition at line 415 of file WWAudio.cpp.

Find_Sound_Object()

SoundSceneObjClass * WWAudioClass::Find_Sound_Object

(

uint32

sound_obj_id

)

Definition at line 2543 of file WWAudio.cpp.

Fire_Text_Callback()

void WWAudioClass::Fire_Text_Callback	(	AudibleSoundClass *	sound_obj,
		const StringClass &	text )

Definition at line 2276 of file WWAudio.cpp.

Flush_Cache()

void WWAudioClass::Flush_Cache ( void )

protected

Definition at line 186 of file WWAudio.cpp.

Flush_Playlist()

void WWAudioClass::Flush_Playlist

(

void

)

Definition at line 1097 of file WWAudio.cpp.

Free_3D_Driver_List()

void WWAudioClass::Free_3D_Driver_List ( void )

protected

Definition at line 1612 of file WWAudio.cpp.

Free_Cache_Space()

bool WWAudioClass::Free_Cache_Space ( int bytes )

protected

Definition at line 459 of file WWAudio.cpp.

Free_Completed_Sounds()

void WWAudioClass::Free_Completed_Sounds

(

void

)

Definition at line 1120 of file WWAudio.cpp.

Get_2D_Driver()

HDIGDRIVER WWAudioClass::Get_2D_Driver ( void ) const

inline

Definition at line 196 of file WWAudio.h.

Get_2D_Sample()

HSAMPLE WWAudioClass::Get_2D_Sample ( const AudibleSoundClass & sound_obj )

protected

Definition at line 1415 of file WWAudio.cpp.

Get_3D_Device()

bool WWAudioClass::Get_3D_Device ( int index, DRIVER_INFO_STRUCT ** info )

inline

Definition at line 216 of file WWAudio.h.

Get_3D_Device_Count()

int WWAudioClass::Get_3D_Device_Count ( void ) const

inline

Definition at line 215 of file WWAudio.h.

Get_3D_Driver()

HPROVIDER WWAudioClass::Get_3D_Driver ( void ) const

inline

Definition at line 197 of file WWAudio.h.

Get_3D_Sample()

H3DSAMPLE WWAudioClass::Get_3D_Sample ( const Sound3DClass & sound_obj )

protected

Definition at line 1483 of file WWAudio.cpp.

Get_Avail_2D_Sample_Count()

int WWAudioClass::Get_Avail_2D_Sample_Count

(

void

)

const

Get_Avail_3D_Sample_Count()

int WWAudioClass::Get_Avail_3D_Sample_Count

(

void

)

const

Get_Cache_Size()

int WWAudioClass::Get_Cache_Size ( void ) const

inline

Definition at line 390 of file WWAudio.h.

Get_Current_Cache_Size()

int WWAudioClass::Get_Current_Cache_Size ( void ) const

inline

Definition at line 391 of file WWAudio.h.

Get_Digital_CPU_Percent()

float WWAudioClass::Get_Digital_CPU_Percent

(

void

)

const

Get_Effects_Level()

float WWAudioClass::Get_Effects_Level ( void )

inline

Definition at line 259 of file WWAudio.h.

Get_File()

FileClass * WWAudioClass::Get_File ( LPCTSTR filename )

protected

Definition at line 2435 of file WWAudio.cpp.

Get_Instance()

static WWAudioClass * WWAudioClass::Get_Instance ( void )

inlinestatic

Definition at line 174 of file WWAudio.h.

Get_Listener_Handle()

H3DPOBJECT WWAudioClass::Get_Listener_Handle ( void )

protected

Definition at line 1552 of file WWAudio.cpp.

Get_Logical_Type()

int WWAudioClass::Get_Logical_Type	(	int	index,
		StringClass &	name )

Definition at line 2523 of file WWAudio.cpp.

Get_Logical_Type_Count()

int WWAudioClass::Get_Logical_Type_Count ( void ) const

inline

Definition at line 354 of file WWAudio.h.

Get_Max_2D_Sample_Count()

int WWAudioClass::Get_Max_2D_Sample_Count

(

void

)

const

Get_Max_3D_Sample_Count()

int WWAudioClass::Get_Max_3D_Sample_Count

(

void

)

const

Get_Music_Volume()

float WWAudioClass::Get_Music_Volume ( void ) const

inline

Definition at line 272 of file WWAudio.h.

Get_Playback_Bits()

int WWAudioClass::Get_Playback_Bits ( void ) const

inline

Definition at line 207 of file WWAudio.h.

Get_Playback_Rate()

int WWAudioClass::Get_Playback_Rate ( void ) const

inline

Definition at line 206 of file WWAudio.h.

Get_Playback_Stereo()

bool WWAudioClass::Get_Playback_Stereo ( void ) const

inline

Definition at line 208 of file WWAudio.h.

Get_Playlist_Count()

int WWAudioClass::Get_Playlist_Count ( void ) const

inline

Definition at line 415 of file WWAudio.h.

Get_Playlist_Entry()

AudibleSoundClass * WWAudioClass::Get_Playlist_Entry

(

int

index

)

const

Definition at line 1160 of file WWAudio.cpp.

Get_Reverb_Filter()

HPROVIDER WWAudioClass::Get_Reverb_Filter ( void ) const

inline

Definition at line 198 of file WWAudio.h.

Get_Reverb_Room_Type()

int WWAudioClass::Get_Reverb_Room_Type ( void )

inline

Definition at line 262 of file WWAudio.h.

Get_Sound_Buffer() [1/2]

SoundBufferClass * WWAudioClass::Get_Sound_Buffer ( const char * filename, bool is_3d )

protected

Definition at line 364 of file WWAudio.cpp.

Get_Sound_Buffer() [2/2]

SoundBufferClass * WWAudioClass::Get_Sound_Buffer ( FileClass & file, const char * string_id, bool is_3d )

protected

Definition at line 393 of file WWAudio.cpp.

Get_Sound_Effects_Volume()

float WWAudioClass::Get_Sound_Effects_Volume ( void ) const

inline

Definition at line 269 of file WWAudio.h.

Get_Sound_Scene()

SoundSceneClass * WWAudioClass::Get_Sound_Scene ( void ) const

inline

Definition at line 379 of file WWAudio.h.

Initialize() [1/2]

void WWAudioClass::Initialize	(	bool	stereo = true,
		int	bits = 16,
		int	hertz = 44100 )

Definition at line 2134 of file WWAudio.cpp.

Initialize() [2/2]

void WWAudioClass::Initialize

(

const char *

registry_subkey_name

)

Definition at line 2098 of file WWAudio.cpp.

Is_3D_Device_Available()

bool WWAudioClass::Is_3D_Device_Available ( DRIVER_TYPE_3D type )

inline

Definition at line 217 of file WWAudio.h.

Is_Disabled()

bool WWAudioClass::Is_Disabled

(

void

)

const

Definition at line 2058 of file WWAudio.cpp.

Is_Music_On()

bool WWAudioClass::Is_Music_On ( void ) const

inline

Definition at line 278 of file WWAudio.h.

Is_OK_To_Give_Handle()

__inline bool WWAudioClass::Is_OK_To_Give_Handle ( const AudibleSoundClass & sound_obj )

protected

Definition at line 90 of file WWAudio.cpp.

Is_Sound_Cached()

bool WWAudioClass::Is_Sound_Cached

(

const char *

string_id

)

Is_Sound_In_Playlist()

bool WWAudioClass::Is_Sound_In_Playlist

(

AudibleSoundClass *

sound_obj

)

Definition at line 1259 of file WWAudio.cpp.

Load_From_Registry() [1/2]

bool WWAudioClass::Load_From_Registry

(

const char *

subkey_name

)

Definition at line 2565 of file WWAudio.cpp.

Load_From_Registry() [2/2]

bool WWAudioClass::Load_From_Registry	(	const char *	subkey_name,
		StringClass &	device_name,
		bool &	is_stereo,
		int &	bits,
		int &	hertz,
		bool &	sound_enabled,
		bool &	music_enabled,
		float &	sound_volume,
		float &	music_volume )

Definition at line 2609 of file WWAudio.cpp.

On_Frame_Update()

void WWAudioClass::On_Frame_Update

(

unsigned int

milliseconds = 0

)

Definition at line 1318 of file WWAudio.cpp.

Open_2D_Device() [1/2]

WWAudioClass::DRIVER_TYPE_2D WWAudioClass::Open_2D_Device	(	bool	stereo,
		int	bits,
		int	hertz )

Definition at line 287 of file WWAudio.cpp.

Open_2D_Device() [2/2]

WWAudioClass::DRIVER_TYPE_2D WWAudioClass::Open_2D_Device

(

LPWAVEFORMAT

format = NULL

)

Definition at line 215 of file WWAudio.cpp.

Peek_Playlist_Entry()

AudibleSoundClass * WWAudioClass::Peek_Playlist_Entry ( int index ) const

inline

Definition at line 417 of file WWAudio.h.

ReAssign_2D_Handles()

void WWAudioClass::ReAssign_2D_Handles ( void )

protected

Definition at line 1913 of file WWAudio.cpp.

ReAssign_3D_Handles()

void WWAudioClass::ReAssign_3D_Handles ( void )

protected

Definition at line 1940 of file WWAudio.cpp.

Register_EOS_Callback()

void WWAudioClass::Register_EOS_Callback	(	LPFNEOSCALLBACK	callback,
		DWORD	user_param )

Definition at line 2224 of file WWAudio.cpp.

Register_Text_Callback()

void WWAudioClass::Register_Text_Callback	(	LPFNTEXTCALLBACK	callback,
		DWORD	user_param )

Definition at line 2250 of file WWAudio.cpp.

Release_2D_Handles()

void WWAudioClass::Release_2D_Handles ( void )

protected

Definition at line 1360 of file WWAudio.cpp.

Release_3D_Handles()

void WWAudioClass::Release_3D_Handles ( void )

protected

Definition at line 1862 of file WWAudio.cpp.

Remove_2D_Sound_Handles()

void WWAudioClass::Remove_2D_Sound_Handles ( void )

protected

Definition at line 1964 of file WWAudio.cpp.

Remove_3D_Sound_Handles()

void WWAudioClass::Remove_3D_Sound_Handles ( void )

protected

Definition at line 1986 of file WWAudio.cpp.

Remove_From_Playlist()

bool WWAudioClass::Remove_From_Playlist

(

AudibleSoundClass *

sound

)

Definition at line 1214 of file WWAudio.cpp.

Reprioritize_Playlist()

void WWAudioClass::Reprioritize_Playlist ( void )

protected

Definition at line 1282 of file WWAudio.cpp.

Reset_Logical_Types()

void WWAudioClass::Reset_Logical_Types

(

void

)

Definition at line 2510 of file WWAudio.cpp.

Return_File()

void WWAudioClass::Return_File ( FileClass * file )

protected

Definition at line 2455 of file WWAudio.cpp.

Save_To_Registry() [1/2]

bool WWAudioClass::Save_To_Registry

(

const char *

subkey_name

)

Definition at line 2671 of file WWAudio.cpp.

Save_To_Registry() [2/2]

bool WWAudioClass::Save_To_Registry	(	const char *	subkey_name,
		const StringClass &	device_name,
		bool	is_stereo,
		int	bits,
		int	hertz,
		bool	sound_enabled,
		bool	music_enabled,
		float	sound_volume,
		float	music_volume )

Definition at line 2704 of file WWAudio.cpp.

Select_3D_Device() [1/4]

bool WWAudioClass::Select_3D_Device

(

const char *

device_name

)

Definition at line 1658 of file WWAudio.cpp.

Select_3D_Device() [2/4]

bool WWAudioClass::Select_3D_Device	(	const char *	device_name,
		HPROVIDER	provider )

Definition at line 1689 of file WWAudio.cpp.

Select_3D_Device() [3/4]

bool WWAudioClass::Select_3D_Device

(

DRIVER_TYPE_3D

type

)

Definition at line 1769 of file WWAudio.cpp.

Select_3D_Device() [4/4]

bool WWAudioClass::Select_3D_Device

(

int

index

)

Definition at line 1743 of file WWAudio.cpp.

Set_Cache_Size()

bool WWAudioClass::Set_Cache_Size ( int kbytes = DEF_CACHE_SIZE )

inline

Definition at line 389 of file WWAudio.h.

Set_File_Factory()

void WWAudioClass::Set_File_Factory ( FileFactoryClass * ffactory )

inline

Definition at line 243 of file WWAudio.h.

Set_Max_2D_Sample_Count()

bool WWAudioClass::Set_Max_2D_Sample_Count

(

int

count = DEF_2D_SAMPLE_COUNT

)

Set_Max_2D_Sound_Buffer()

void WWAudioClass::Set_Max_2D_Sound_Buffer ( int bytes = DEF_MAX_2D_BUFFER_SIZE )

inline

Definition at line 401 of file WWAudio.h.

Set_Max_3D_Sample_Count()

bool WWAudioClass::Set_Max_3D_Sample_Count

(

int

count = DEF_3D_SAMPLE_COUNT

)

Set_Max_3D_Sound_Buffer()

void WWAudioClass::Set_Max_3D_Sound_Buffer ( int bytes = DEF_MAX_3D_BUFFER_SIZE )

inline

Definition at line 402 of file WWAudio.h.

Set_Music_Volume()

void WWAudioClass::Set_Music_Volume

(

float

volume = DEF_MUSIC_VOL

)

Definition at line 2033 of file WWAudio.cpp.

Set_Reverb_Room_Type()

void WWAudioClass::Set_Reverb_Room_Type

(

int

type

)

Set_Sound_Effects_Volume()

void WWAudioClass::Set_Sound_Effects_Volume

(

float

volume = DEF_SFX_VOL

)

Definition at line 2008 of file WWAudio.cpp.

Shutdown()

void WWAudioClass::Shutdown

(

void

)

Definition at line 2168 of file WWAudio.cpp.

Simple_Play_2D_Sound_Effect() [1/2]

bool WWAudioClass::Simple_Play_2D_Sound_Effect	(	const char *	filename,
		float	priority = 1.0F,
		float	volume = DEF_SFX_VOL )

Definition at line 2377 of file WWAudio.cpp.

Simple_Play_2D_Sound_Effect() [2/2]

bool WWAudioClass::Simple_Play_2D_Sound_Effect	(	FileClass &	file,
		float	priority = 1.0F,
		float	volume = DEF_SFX_VOL )

Definition at line 2406 of file WWAudio.cpp.

UnRegister_EOS_Callback()

void WWAudioClass::UnRegister_EOS_Callback

(

LPFNEOSCALLBACK

callback

)

Definition at line 2237 of file WWAudio.cpp.

UnRegister_Text_Callback()

void WWAudioClass::UnRegister_Text_Callback

(

LPFNTEXTCALLBACK

callback

)

Definition at line 2263 of file WWAudio.cpp.

Validate_3D_Sound_Buffer()

bool WWAudioClass::Validate_3D_Sound_Buffer ( SoundBufferClass * buffer )

protected

Definition at line 1887 of file WWAudio.cpp.

Friends And Related Symbol Documentation

AudibleSoundClass

friend class AudibleSoundClass

friend

Definition at line 161 of file WWAudio.h.

Listener3DClass

friend class Listener3DClass

friend

Definition at line 163 of file WWAudio.h.

Sound3DClass

friend class Sound3DClass

friend

Definition at line 162 of file WWAudio.h.

---

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

• Code/Libraries/Source/WWVegas/WWAudio/WWAudio.h
• Code/Libraries/Source/WWVegas/WWAudio/WWAudio.cpp