Colobot
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
CSoundInterface Class Reference

Sound plugin interface. More...

#include <sound.h>

Inheritance diagram for CSoundInterface:
Inheritance graph
[legend]

Public Member Functions

virtual bool Create (bool b3D)
 
void CacheAll (std::string path)
 
void AddMusicFiles (std::string path)
 
virtual bool Cache (Sound bSound, std::string bFile)
 
virtual bool CacheMusic (std::string bFile)
 
virtual bool GetEnable ()
 
virtual void SetSound3D (bool bMode)
 
virtual bool GetSound3D ()
 
virtual bool GetSound3DCap ()
 
virtual void SetAudioVolume (int volume)
 
virtual int GetAudioVolume ()
 
virtual void SetMusicVolume (int volume)
 
virtual int GetMusicVolume ()
 
virtual void SetListener (Math::Vector eye, Math::Vector lookat)
 
virtual void FrameMove (float rTime)
 
virtual int Play (Sound sound, float amplitude=1.0f, float frequency=1.0f, bool bLoop=false)
 
virtual int Play (Sound sound, Math::Vector pos, float amplitude=1.0f, float frequency=1.0f, bool bLoop=false)
 
virtual bool FlushEnvelope (int channel)
 
virtual bool AddEnvelope (int channel, float amplitude, float frequency, float time, SoundNext oper)
 
virtual bool Position (int channel, Math::Vector pos)
 
virtual bool Frequency (int channel, float frequency)
 
virtual bool Stop (int channel)
 
virtual bool StopAll ()
 
virtual bool MuteAll (bool bMute)
 
virtual bool PlayMusic (int rank, bool bRepeat)
 
virtual bool PlayMusic (std::string filename, bool bRepeat)
 
virtual bool RestartMusic ()
 
virtual void SuspendMusic ()
 
virtual void StopMusic ()
 
virtual bool IsPlayingMusic ()
 

Protected Attributes

std::string m_soundPath
 

Detailed Description

Sound plugin interface.

Member Function Documentation

bool CSoundInterface::AddEnvelope ( int  channel,
float  amplitude,
float  frequency,
float  time,
SoundNext  oper 
)
virtual

Add envelope to sound. Envelope is a operatino that will be performend on sound in future like changing frequency

Parameters
channel- channel to work on
amplitude- change amplitude
frequency- change frequency
time- when to change (sample time)
oper- operation to perform
Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::AddMusicFiles ( std::string  path)

Function called to add all music files to list

bool CSoundInterface::Cache ( Sound  bSound,
std::string  bFile 
)
virtual

Function called to cache sound effect file. This function is called by plugin interface for each file.

Parameters
bSound- id of a file, will be used to identify sound files
bFile- file to load
Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::CacheAll ( std::string  path)

Function called to cache all sound effect files. Function calls CSoundInterface::Cache() for each file

bool CSoundInterface::CacheMusic ( std::string  bFile)
virtual

Function called to cache music file. This function is called by CRobotMain for each file used in the mission.

Parameters
bFile- file to load
Returns
return true on success

Reimplemented in ALSound.

bool CSoundInterface::Create ( bool  b3D)
virtual

Function to initialize sound device

Parameters
b3D- enable support for 3D sound

Reimplemented in ALSound.

bool CSoundInterface::FlushEnvelope ( int  channel)
virtual

Remove all operations that would be made on sound in channel.

Parameters
channel- channel to work on
Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::FrameMove ( float  rTime)
virtual

Update data each frame

Parameters
rTime- time since last update

Reimplemented in ALSound.

bool CSoundInterface::Frequency ( int  channel,
float  frequency 
)
virtual

Set sound frequency

Parameters
channel- channel to work on
frequency- change sound frequency
Returns
return true on success

Reimplemented in ALSound.

int CSoundInterface::GetAudioVolume ( )
virtual

Return global sound volume

Returns
global volume as int in range from 0 to MAXVOLUME

Reimplemented in ALSound.

bool CSoundInterface::GetEnable ( )
virtual

Return if plugin is enabled

Returns
return true if plugin is enabled

Reimplemented in ALSound.

int CSoundInterface::GetMusicVolume ( )
virtual

Return music volume

Returns
music volume as int in range from 0 to MAXVOLUME

Reimplemented in ALSound.

bool CSoundInterface::GetSound3D ( )
virtual

Return if we use 3D sound

Returns
true if we have 3D sound enabled

Reimplemented in ALSound.

bool CSoundInterface::GetSound3DCap ( )
virtual

Return if we have 3D sound capable card

Returns
true for 3D sound support

Reimplemented in ALSound.

bool CSoundInterface::IsPlayingMusic ( )
virtual

Check if music if playing

Returns
return true if music is playing

Reimplemented in ALSound.

bool CSoundInterface::MuteAll ( bool  bMute)
virtual

Mute/unmute all sounds

Parameters
bMute
Returns
return true on success

Reimplemented in ALSound.

int CSoundInterface::Play ( Sound  sound,
float  amplitude = 1.0f,
float  frequency = 1.0f,
bool  bLoop = false 
)
virtual

Play specific sound

Parameters
sound- sound to play
amplitude- change amplitude of sound before playing
frequency- change sound frequency before playing (0.5 octave down, 2.0 octave up)
bLoop- loop sound
Returns
identifier of channel that sound will be played on

Reimplemented in ALSound.

int CSoundInterface::Play ( Sound  sound,
Math::Vector  pos,
float  amplitude = 1.0f,
float  frequency = 1.0f,
bool  bLoop = false 
)
virtual

Play specific sound

Parameters
sound- sound to play
pos- position of sound in space
amplitude- change amplitude of sound before playing
frequency- change sound frequency before playing (0.5 octave down, 2.0 octave up)
bLoop- loop sound
Returns
identifier of channel that sound will be played on

Reimplemented in ALSound.

bool CSoundInterface::PlayMusic ( int  rank,
bool  bRepeat 
)
virtual

Start playing music

Parameters
rank- track number
bRepeat- repeat playing
Returns
return true on success

Reimplemented in ALSound.

bool CSoundInterface::PlayMusic ( std::string  filename,
bool  bRepeat 
)
virtual

Start playing music

Parameters
filename- name of file to play
bRepeat- repeat playing
Returns
return true on success

Reimplemented in ALSound.

bool CSoundInterface::Position ( int  channel,
Math::Vector  pos 
)
virtual

Set sound position in space

Parameters
channel- channel to work on
pos- new positino of a sound
Returns
return true on success

Reimplemented in ALSound.

bool CSoundInterface::RestartMusic ( )
virtual

Restart music

Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::SetAudioVolume ( int  volume)
virtual

Change global sound volume

Parameters
volume- range from 0 to MAXVOLUME

Reimplemented in ALSound.

void CSoundInterface::SetListener ( Math::Vector  eye,
Math::Vector  lookat 
)
virtual

Set listener position

Parameters
eye- position of listener
lookat- direction listener is looking at

Reimplemented in ALSound.

void CSoundInterface::SetMusicVolume ( int  volume)
virtual

Set music volume

Parameters
volume- range from 0 to MAXVOLUME

Reimplemented in ALSound.

void CSoundInterface::SetSound3D ( bool  bMode)
virtual

Change sound mode to 2D/3D

Parameters
bMode- true to enable 3D sound

Reimplemented in ALSound.

bool CSoundInterface::Stop ( int  channel)
virtual

Stop playing sound

Parameters
channel- channel to work on
Returns
return true on success

Reimplemented in ALSound.

bool CSoundInterface::StopAll ( )
virtual

Stop playing all sounds

Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::StopMusic ( )
virtual

Stop playing music

Returns
return true on success

Reimplemented in ALSound.

void CSoundInterface::SuspendMusic ( )
virtual

Susspend paying music

Returns
return true on success

Reimplemented in ALSound.


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