ScummVM API documentation
TwinE::Sound Class Reference

Public Member Functions

 Sound (TwinEEngine *engine)
 
void playFlaSample (int32 index, int32 repeat, uint8 balance, int32 volumeLeft, int32 volumeRight)
 
void setSamplePosition (int32 channelIdx, int32 x, int32 y, int32 z)
 
void setSamplePosition (int32 channelIdx, const IVec3 &pos)
 
void playSample (int32 index, int32 repeat=1, int32 x=128, int32 y=128, int32 z=128, int32 actorIdx=-1)
 
void playSample (int32 index, int32 repeat, const IVec3 &pos, int32 actorIdx=-1)
 
void pauseSamples ()
 
void resumeSamples ()
 
void startRainSample ()
 
void stopSamples ()
 
int32 getActorChannel (int32 index)
 
void stopSample (int32 index)
 
int32 isSamplePlaying (int32 index)
 
bool playVoxSample (const TextEntry *text)
 

Member Function Documentation

◆ playFlaSample()

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

Play FLA movie samples

Parameters
indexsample index under flasamp.hqr file
repeatnumber of times to repeat the sample

◆ setSamplePosition()

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

Update sample position in channel

◆ playSample()

void TwinE::Sound::playSample ( int32  index,
int32  repeat = 1,
int32  x = 128,
int32  y = 128,
int32  z = 128,
int32  actorIdx = -1 
)

Play samples

Parameters
indexsample index under flasamp.hqr file
repeatnumber of times to repeat the sample
xsound generating entity x position
ysound generating entity y position
zsound generating entity z 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  index)

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: