---

AllAudio Class Reference

#include <RainMusic.h>

List of all members.

Public Methods
	AllAudio (void)
	~AllAudio (void)
HRESULT	Initialize (FileNameContainer *fncMusicFileNames, FileNameContainer *fncSoundFileNames, char *szBasePath)
HRESULT	SetBasePath (char *szBasePath)
HRESULT	SetMusicFile (UINT uStringTableIndex)
HRESULT	PlaySoundBI (UINT uIdx, DWORD dwRepeats)
HRESULT	PlayMusic (void)
HRESULT	StopMusic (void)
HRESULT	StopAllSounds (void)
HRESULT	SetMusicVolume (DWORD dwVolume)
HRESULT	SetSoundVolume (DWORD dwVolume)
Protected Methods
int	CreateSongNameArrayFromList (FileNameContainer fncSongFileNames, char **p_szBuffer)
Protected Attributes
IDirectMusicLoader8 *	m_pLoader
RainDMPerf8 *	m_pPerfMusic
RainDMPerf8 *	m_pPerfSound

---

Detailed Description

The main audio class for the Rain engine. For all clients, only one instance of this object in needed. This class will control all sound and music to be played during menus, cinematics, and game play. While both the Music and Sound variables posess the ability to load and play an array of sound files, only one sound file at a time should be loaded into the Music RainDMPerf8 object. Only the file in the zeroth element will be available for playback and the creating of additonal files in this array may cause instability. The first file loaded by the Sound RainDMPerf8 object will control the tempo, so it is recomended that all of your sound files use the same tempo to avoid garbled playback. You must create and load the appropriate file names into two FileNameContainer objects before calling the Initialize function. One of these objects should be declared as Type: AUDIO_TYPE_MUSIC and the other as Type: AUDIO_TYPE_SOUND.

---

Constructor & Destructor Documentation

AllAudio::AllAudio (  void    )

Default Constructor

AllAudio::~AllAudio (  void    )

Default Destructor

---

Member Function Documentation

int AllAudio::CreateSongNameArrayFromList (  FileNameContainer    fncSongFileNames, char **    p_szBuffer )  [protected]

HRESULT AllAudio::Initialize (  FileNameContainer *    fncMusicFileNames, FileNameContainer *    fncSoundFileNames, char *    szBasePath )

Default Constructor

HRESULT AllAudio::PlayMusic (  void    )

Default Constructor

HRESULT AllAudio::PlaySoundBI (  UINT    uIdx, DWORD    dwRepeats )

Default Constructor

HRESULT AllAudio::SetBasePath (  char *    szBasePath )

Default Constructor

HRESULT AllAudio::SetMusicFile (  UINT    uStringTableIndex )

Default Constructor

HRESULT AllAudio::SetMusicVolume (  DWORD    dwVolume )

Default Constructor

HRESULT AllAudio::SetSoundVolume (  DWORD    dwVolume )

Default Constructor

HRESULT AllAudio::StopAllSounds (  void    )

Default Constructor

HRESULT AllAudio::StopMusic (  void    )

Default Constructor

---

Member Data Documentation

IDirectMusicLoader8* AllAudio::m_pLoader [protected]

RainDMPerf8* AllAudio::m_pPerfMusic [protected]

RainDMPerf8* AllAudio::m_pPerfSound [protected]

---

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

• RainMusic.h
• RainMusic.cpp

---