CSound Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CSound class handles

The structure used for this class is CSound

Quick Reference¶

Quick Ref

void CSound::CSound(CResRef cNewRef, int nNewRange, int nNewChannel, int nNewLooping, int nNewPriority, int bNewPositionedSound)

void CSound::CSound()

virtual void CSound::~CSound()

int CSound::ExclusivePlay(int bReplay)

unsigned int CSound::GetArea()

unsigned int CSound::GetBuffer()

int CSound::GetChannel()

int CSound::GetLooping()

unsigned long CSound::GetPlayTime()

int CSound::GetPriority()

int CSound::GetRangeVolume()

CResWave* CSound::GetRes()

CResRef& CSound::GetResRef()

int CSound::GetSource()

long CSound::GetVolume()

int CSound::IsSoundPlaying(unsigned char bInSoundUpdate)

virtual int __cdecl CSound::IsSourcePlaying(int source)

int CSound::Play(int bReplay)

int CSound::Play(int nNewXCoordinate, int nNewYCoordinate, int nNewZCoordinate, int bReplay)

int CSound::PlayWaiting()

void CSound::ReleaseSound()

virtual void __cdecl CSound::ReleaseSound(int source, int buffer)

int CSound::ResetVolume()

int CSound::SetChannel(int nNewChannel, unsigned int nArea)

void CSound::SetCoordinates(int nNewXCoordinate, int nNewYCoordinate, int nNewZCoordinate)

int CSound::SetFireForget(int bNewFireForget)

int CSound::SetFrequency(unsigned long dwNewFrequency)

int CSound::SetLoopingFlag(int nNewLooping)

void CSound::SetPitchVariance(long nPitchVar)

void CSound::SetPriority(unsigned char nPriority)

void CSound::SetRange(int nNewRange)

void CSound::SetResRef(CResRef& cNewResRef, int bSetAutoRequest, int bWarningIfMissing)

int CSound::SetVolume(long nNewVolume)

void CSound::SetVolumeVariance(long nVolVar)

unsigned char CSound::SoundDuckedOthers()

int CSound::Stop()

virtual void __cdecl CSound::StopSource(int source)

Constructors¶

Name	Description
CSound::CSound	Constructs a `CSound` object
CSound::CSound	Destroys a `CSound` object

CSound::CSound¶

Constructs a CSound object

void CSound::CSound(
   CResRef cNewRef,
       int nNewRange,
       int nNewChannel,
       int nNewLooping,
       int nNewPriority,
       int bNewPositionedSound);

Parameters

CResRef cNewRef -
int nNewRange -
int nNewChannel -
int nNewLooping -
int nNewPriority -
int bNewPositionedSound -

Remarks

Constructs a CSound object

CSound::CSound¶

Constructs a CSound object

void CSound::CSound();

Remarks

Constructs a CSound object

CSound::~CSound¶

Destroys the CSound object

virtual void CSound::~CSound();

Remarks

Destroys the CSound object

Methods¶

CSound::ExclusivePlay¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetArea¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetBuffer¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetChannel¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetLooping¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetPlayTime¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetPriority¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetRangeVolume¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetRes¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetResRef¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetSource¶

x;

Parameters

Return Value

Returns

Remarks

CSound::GetVolume¶

x;

Parameters

Return Value

Returns

Remarks

CSound::IsSoundPlaying¶

x;

Parameters

Return Value

Returns

Remarks

CSound::IsSourcePlaying¶

x;

Parameters

Return Value

Returns

Remarks

CSound::Play¶

int **CSound\:\:Play**\(int bReplay);

Parameters

Return Value

Returns

Remarks

CSound::Play¶

int **CSound\:\:Play**\(int nNewXCoordinate, int nNewYCoordinate, int nNewZCoordinate, int bReplay);

Parameters

Return Value

Returns

Remarks

CSound::PlayWaiting¶

x;

Parameters

Return Value

Returns

Remarks

CSound::ReleaseSound¶

void **CSound\:\:ReleaseSound**\();

Parameters

Return Value

Returns

Remarks

CSound::ReleaseSound¶

virtual void __cdecl **CSound\:\:ReleaseSound**\(int source, int buffer);

Parameters

Return Value

Returns

Remarks

CSound::ResetVolume¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetChannel¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetCoordinates¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetFireForget¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetFrequency¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetLoopingFlag¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetPitchVariance¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetPriority¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetRange¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetResRef¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetVolume¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SetVolumeVariance¶

x;

Parameters

Return Value

Returns

Remarks

CSound::SoundDuckedOthers¶

x;

Parameters

Return Value

Returns

Remarks

CSound::Stop¶

x;

Parameters

Return Value

Returns

Remarks

CSound::StopSource¶

x;

Parameters

Return Value

Returns

Remarks