Audio Scol plugin 1.0
Audio Scol plugin based on CAudio library
Public Member Functions | Public Attributes | List of all members
SAudioSound Class Reference
Inheritance diagram for SAudioSound:

Public Member Functions

 SAudioSound (std::string name, std::string path, bool stream)
 
 SAudioSound (std::string name, unsigned int frequency, cAudio::AudioFormats format)
 
bool IsValid ()
 
std::string GetName ()
 
bool Play (bool loop)
 
bool Play3d (float attenuation, bool loop)
 
void Stop ()
 
void Pause ()
 
void SetVolume (float volume)
 
float GetVolume ()
 
bool IsPlaying ()
 
bool Is3d ()
 
bool IsLoop ()
 
bool FillBuffer (const char *&data, const unsigned int &size)
 
bool GetLoopOnResume ()
 
void SetLoopOnResume (bool state)
 
bool GetPlayOnResume ()
 
void SetPlayOnResume (bool playOnResume)
 
float Get3DAttenuation ()
 
float GetTime ()
 
float GetTotalTime ()
 
void SetPitch (float pitch)
 
float GetPitch ()
 
void Seek (float pos, bool relative)
 
void SetPositionAndDirection (cAudio::cVector3 pos, cAudio::cVector3 dir)
 
cAudio::cVector3 GetPosition ()
 
cAudio::cVector3 GetDirection ()
 
void SetCone (float inner, float outer, float outvol)
 
float GetInnerCone ()
 
float GetOuterCone ()
 
float GetOuterConeVolume ()
 
void SetRolloffFactor (float rolloff)
 
float GetRolloffFactor ()
 
virtual void onUpdate ()
 
virtual void onRelease ()
 This function is called when a source is released and soon to be deleted.
 
virtual void onPlay ()
 This function is called when a source starts playing.
 
virtual void onStop ()
 This function is called when a source stopped playback.
 
virtual void onPause ()
 This function is called when a source is paused.
 

Public Attributes

bool mEffectState
 
bool mFilterState
 

Detailed Description

Definition at line 212 of file audio.h.

Constructor & Destructor Documentation

◆ SAudioSound() [1/2]

SAudioSound::SAudioSound ( std::string  name,
std::string  path,
bool  stream 
)

Definition at line 1065 of file audio.cpp.

◆ SAudioSound() [2/2]

SAudioSound::SAudioSound ( std::string  name,
unsigned int  frequency,
cAudio::AudioFormats  format 
)

Definition at line 1088 of file audio.cpp.

◆ ~SAudioSound()

SAudioSound::~SAudioSound ( )

Definition at line 1111 of file audio.cpp.

Member Function Documentation

◆ FillBuffer()

bool SAudioSound::FillBuffer ( const char *&  data,
const unsigned int &  size 
)

Definition at line 1368 of file audio.cpp.

◆ Get3DAttenuation()

float SAudioSound::Get3DAttenuation ( )

Definition at line 1253 of file audio.cpp.

◆ GetDirection()

cAudio::cVector3 SAudioSound::GetDirection ( )

Definition at line 1312 of file audio.cpp.

◆ GetInnerCone()

float SAudioSound::GetInnerCone ( )

Definition at line 1330 of file audio.cpp.

◆ GetLoopOnResume()

bool SAudioSound::GetLoopOnResume ( )

Definition at line 1233 of file audio.cpp.

◆ GetName()

std::string SAudioSound::GetName ( )

Definition at line 1135 of file audio.cpp.

◆ GetOuterCone()

float SAudioSound::GetOuterCone ( )

Definition at line 1338 of file audio.cpp.

◆ GetOuterConeVolume()

float SAudioSound::GetOuterConeVolume ( )

Definition at line 1346 of file audio.cpp.

◆ GetPitch()

float SAudioSound::GetPitch ( )

Definition at line 1280 of file audio.cpp.

◆ GetPlayOnResume()

bool SAudioSound::GetPlayOnResume ( )

Definition at line 1243 of file audio.cpp.

◆ GetPosition()

cAudio::cVector3 SAudioSound::GetPosition ( )

Definition at line 1304 of file audio.cpp.

◆ GetRolloffFactor()

float SAudioSound::GetRolloffFactor ( )

Definition at line 1360 of file audio.cpp.

◆ GetTime()

float SAudioSound::GetTime ( )

Definition at line 1258 of file audio.cpp.

◆ GetTotalTime()

float SAudioSound::GetTotalTime ( )

Definition at line 1266 of file audio.cpp.

◆ GetVolume()

float SAudioSound::GetVolume ( )

Definition at line 1204 of file audio.cpp.

◆ Is3d()

bool SAudioSound::Is3d ( )

Definition at line 1220 of file audio.cpp.

◆ IsLoop()

bool SAudioSound::IsLoop ( )

Definition at line 1225 of file audio.cpp.

◆ IsPlaying()

bool SAudioSound::IsPlaying ( )

Definition at line 1212 of file audio.cpp.

◆ IsValid()

bool SAudioSound::IsValid ( )

Definition at line 1127 of file audio.cpp.

◆ onPause()

void SAudioSound::onPause ( )
virtual

This function is called when a source is paused.

Definition at line 1421 of file audio.cpp.

◆ onPlay()

void SAudioSound::onPlay ( )
virtual

This function is called when a source starts playing.

Definition at line 1411 of file audio.cpp.

◆ onRelease()

void SAudioSound::onRelease ( )
virtual

This function is called when a source is released and soon to be deleted.

Definition at line 1407 of file audio.cpp.

◆ onStop()

void SAudioSound::onStop ( )
virtual

This function is called when a source stopped playback.

Definition at line 1415 of file audio.cpp.

◆ onUpdate()

void SAudioSound::onUpdate ( )
virtual

Definition at line 1403 of file audio.cpp.

◆ Pause()

void SAudioSound::Pause ( )

Definition at line 1190 of file audio.cpp.

◆ Play()

bool SAudioSound::Play ( bool  loop)

Definition at line 1140 of file audio.cpp.

◆ Play3d()

bool SAudioSound::Play3d ( float  attenuation,
bool  loop 
)

Definition at line 1160 of file audio.cpp.

◆ Seek()

void SAudioSound::Seek ( float  pos,
bool  relative 
)

Definition at line 1288 of file audio.cpp.

◆ SetCone()

void SAudioSound::SetCone ( float  inner,
float  outer,
float  outvol 
)

Definition at line 1320 of file audio.cpp.

◆ SetLoopOnResume()

void SAudioSound::SetLoopOnResume ( bool  state)

Definition at line 1238 of file audio.cpp.

◆ SetPitch()

void SAudioSound::SetPitch ( float  pitch)

Definition at line 1274 of file audio.cpp.

◆ SetPlayOnResume()

void SAudioSound::SetPlayOnResume ( bool  playOnResume)

Definition at line 1248 of file audio.cpp.

◆ SetPositionAndDirection()

void SAudioSound::SetPositionAndDirection ( cAudio::cVector3  pos,
cAudio::cVector3  dir 
)

Definition at line 1295 of file audio.cpp.

◆ SetRolloffFactor()

void SAudioSound::SetRolloffFactor ( float  rolloff)

Definition at line 1354 of file audio.cpp.

◆ SetVolume()

void SAudioSound::SetVolume ( float  volume)

Definition at line 1198 of file audio.cpp.

◆ Stop()

void SAudioSound::Stop ( )

Definition at line 1181 of file audio.cpp.

Member Data Documentation

◆ mEffectState

bool SAudioSound::mEffectState

Definition at line 219 of file audio.h.

◆ mFilterState

bool SAudioSound::mFilterState

Definition at line 220 of file audio.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8