HPL3/Amnesia: Rebirth/Scripting/iSoundChannel

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

iSoundChannel has no public fields.

Functions

Return Type Function And Description
iSoundData GetData()
float GetElapsedTime()
float GetMaxDistance()
float GetMinDistance()
float GetPan()
bool GetPaused()
cVector3f GetPosition()
bool GetPostionIsHeadRelative()
int GetPriority()
bool GetReverbActive()
float GetReverbAmount()
float GetSpeakerSpread()
float GetSpeed()
float GetTotalTime()
cVector3f GetVelocity()
float GetVolume()
bool Is3D()
bool IsPlaying()
bool IsPriorityReleased()
bool IsVirtual()
void Play()
void SetElapsedTime(float afTime)
void SetMaxDistance(float fMax)
void SetMinDistance(float fMin)
void SetPan(float afPan)
void SetPaused(bool abX)
void SetPosition(const cVector3f &in avPos)
void SetPostionIsHeadRelative(bool abX)
void SetPriority(int alX)
void SetReverbActive(bool abX)
void SetReverbAmount(float afX)
void SetSpeakerSpread(float afX)
void SetSpeed(float afSpeed)
void SetVelocity(const cVector3f &in avVel)
void SetVolume(float afVolume)
void Stop()

Details

GetData

iSoundData@ GetData()

Returns:

  • iSoundData@

GetElapsedTime

float GetElapsedTime()

Returns:

  • float

GetMaxDistance

float GetMaxDistance()

Returns:

  • float

GetMinDistance

float GetMinDistance()

Returns:

  • float

GetPan

float GetPan()

Returns:

  • float

GetPaused

bool GetPaused()

Returns:

  • bool

GetPosition

const cVector3f& GetPosition()

Returns:

  • const cVector3f&

GetPostionIsHeadRelative

bool GetPostionIsHeadRelative()

Returns:

  • bool

GetPriority

int GetPriority()

Returns:

  • int

GetReverbActive

bool GetReverbActive()

Returns:

  • bool

GetReverbAmount

float GetReverbAmount()

Returns:

  • float

GetSpeakerSpread

float GetSpeakerSpread()

Returns:

  • float

GetSpeed

float GetSpeed()

Returns:

  • float

GetTotalTime

float GetTotalTime()

Returns:

  • float

GetVelocity

const cVector3f& GetVelocity()

Returns:

  • const cVector3f&

GetVolume

float GetVolume()

Returns:

  • float

Is3D

bool Is3D()

Returns:

  • bool

IsPlaying

bool IsPlaying()

Returns:

  • bool

IsPriorityReleased

bool IsPriorityReleased()

Returns:

  • bool

IsVirtual

bool IsVirtual()

Returns:

  • bool

Play

void Play()

Returns:

  • void

SetElapsedTime

void SetElapsedTime(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

SetMaxDistance

void SetMaxDistance(float fMax)


Parameters

  • fMax (float) —

Returns:

  • void

SetMinDistance

void SetMinDistance(float fMin)


Parameters

  • fMin (float) —

Returns:

  • void

SetPan

void SetPan(float afPan)


Parameters

  • afPan (float) —

Returns:

  • void

SetPaused

void SetPaused(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetPostionIsHeadRelative

void SetPostionIsHeadRelative(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPriority

void SetPriority(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetReverbActive

void SetReverbActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetReverbAmount

void SetReverbAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpeakerSpread

void SetSpeakerSpread(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpeed

void SetSpeed(float afSpeed)


Parameters

  • afSpeed (float) —

Returns:

  • void

SetVelocity

void SetVelocity(const cVector3f &in avVel)


Parameters

Returns:

  • void

SetVolume

void SetVolume(float afVolume)


Parameters

  • afVolume (float) —

Returns:

  • void

Stop

void Stop()

Returns:

  • void

References


See all references...