CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iSoundSource Struct Reference

The sound source is an instance of a sound. More...

#include <source.h>

Inheritance diagram for iSoundSource:

iBase List of all members.

Public Methods

virtual void Play (unsigned long playMethod=0)=0
 Play the sound. PlayMethod can be set to any combination of SOUND_*.

virtual void Stop ()=0
 Stop the sound.

virtual void SetVolume (float volume)=0
 Set volume (range from 0.0 to 1.0).

virtual float GetVolume ()=0
 Get volume (range from 0.0 to 1.0).

virtual void SetFrequencyFactor (float factor)=0
 Set frequency factor : 1 = normal, >1 faster, 0-1 slower.

virtual float GetFrequencyFactor ()=0
 Get frequency factor.

virtual int GetMode3D ()=0
 return 3d mode

virtual void SetMode3D (int m)=0
 set 3d mode

virtual void SetPosition (csVector3 pos)=0
 set position of this source

virtual csVector3 GetPosition ()=0
 get position of this source

virtual void SetVelocity (csVector3 spd)=0
 set velocity of this source

virtual csVector3 GetVelocity ()=0
 get velocity of this source


Detailed Description

The sound source is an instance of a sound.

It can be a non-3d source, in which case it plays the sound as it was recorded, or a 3d source, in which case it represents an object in 3d space and adjusts L/R volume for 3d sound.

Definition at line 50 of file source.h.


Member Function Documentation

virtual float iSoundSource::GetFrequencyFactor   [pure virtual]
 

Get frequency factor.

virtual int iSoundSource::GetMode3D   [pure virtual]
 

return 3d mode

virtual csVector3 iSoundSource::GetPosition   [pure virtual]
 

get position of this source

virtual csVector3 iSoundSource::GetVelocity   [pure virtual]
 

get velocity of this source

virtual float iSoundSource::GetVolume   [pure virtual]
 

Get volume (range from 0.0 to 1.0).

virtual void iSoundSource::Play unsigned long    playMethod = 0 [pure virtual]
 

Play the sound. PlayMethod can be set to any combination of SOUND_*.

virtual void iSoundSource::SetFrequencyFactor float    factor [pure virtual]
 

Set frequency factor : 1 = normal, >1 faster, 0-1 slower.

virtual void iSoundSource::SetMode3D int    m [pure virtual]
 

set 3d mode

virtual void iSoundSource::SetPosition csVector3    pos [pure virtual]
 

set position of this source

virtual void iSoundSource::SetVelocity csVector3    spd [pure virtual]
 

set velocity of this source

virtual void iSoundSource::SetVolume float    volume [pure virtual]
 

Set volume (range from 0.0 to 1.0).

virtual void iSoundSource::Stop   [pure virtual]
 

Stop the sound.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18