TwinE::Sound Class Reference

Public Member Functions
	Sound (TwinEEngine *engine)
int32	getSampleChannel (int32 index)
void	playFlaSample (int32 index, int16 rate, int32 repeat, uint8 volumeLeft, uint8 volumeRight)
void	setChannelBalance (int32 channelIdx, uint8 volumeLeft, uint8 volumeRight)
void	setChannelRate (int32 channelIdx, uint32 rate)
void	setChannelPosition (int32 channelIdx, int32 x, int32 y, int32 z)
void	setChannelPosition (int32 channelIdx, const IVec3 &pos)
void	mixSample3D (int32 index, uint16 pitchbend, int32 repeat, const IVec3 &pos, int32 actorIdx)
void	mixSample (int32 index, uint16 pitchbend, int32 repeat, uint8 volumeLeft, uint8 volumeRight)
void	pauseSamples ()
void	resumeSamples ()
void	startRainSample ()
void	stopSamples ()
int32	getActorChannel (int32 actorIdx)
void	stopSample (int32 index)
int32	isSamplePlaying (int32 index)
bool	playVoxSample (const TextEntry *text)

Member Function Documentation

getSampleChannel()

int32 TwinE::Sound::getSampleChannel

(

int32

index

)

Get the channel where the sample is playing

playFlaSample()

void TwinE::Sound::playFlaSample	(	int32	index,
		int16	rate,
		int32	repeat,
		uint8	volumeLeft,
		uint8	volumeRight
	)

Play FLA movie samples

Parameters

index	sample index under flasamp.hqr file
repeat	number of times to repeat the sample

setChannelPosition()

void TwinE::Sound::setChannelPosition	(	int32	channelIdx,
		int32	x,
		int32	y,
		int32	z
	)

Update sample position in channel

mixSample3D()

void TwinE::Sound::mixSample3D	(	int32	index,
		uint16	pitchbend,
		int32	repeat,
		const IVec3 &	pos,
		int32	actorIdx
	)

Play samples

Parameters

index	sample index under flasamp.hqr file
repeat	number of times to repeat the sample
pos	sound generating entity position
actorIdx

pauseSamples()

void TwinE::Sound::pauseSamples

(

)

Pause samples

resumeSamples()

void TwinE::Sound::resumeSamples

(

)

Resume samples

stopSamples()

void TwinE::Sound::stopSamples

(

)

Stop samples

getActorChannel()

int32 TwinE::Sound::getActorChannel

(

int32

actorIdx

)

Get the channel where the actor sample is playing

stopSample()

void TwinE::Sound::stopSample

(

int32

index

)

Stops a specific sample

isSamplePlaying()

int32 TwinE::Sound::isSamplePlaying

(

int32

index

)

Check if a sample is playing

playVoxSample()

bool TwinE::Sound::playVoxSample

(

const TextEntry *

text

)

Play VOX sample

---

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

• engines/twine/audio/sound.h