Inheritance diagram for ALSound:

Public Member Functions
bool	Create (bool b3D)

bool	Cache (Sound, std::string)

bool	CacheMusic (std::string)

bool	GetEnable ()

void	SetSound3D (bool bMode)

bool	GetSound3D ()

bool	GetSound3DCap ()

void	SetAudioVolume (int volume)

int	GetAudioVolume ()

void	SetMusicVolume (int volume)

int	GetMusicVolume ()

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

void	FrameMove (float rTime)

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

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

bool	FlushEnvelope (int channel)

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

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

bool	Frequency (int channel, float frequency)

bool	Stop (int channel)

bool	StopAll ()

bool	MuteAll (bool bMute)

bool	PlayMusic (int rank, bool bRepeat)

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

bool	RestartMusic ()

void	SuspendMusic ()

void	StopMusic ()

bool	IsPlayingMusic ()

std::string	PluginName ()

int	PluginVersion ()

void	InstallPlugin ()

bool	UninstallPlugin (std::string &)

Public Member Functions inherited from CSoundInterface
void	CacheAll (std::string path)

void	AddMusicFiles (std::string path)

Additional Inherited Members
Protected Attributes inherited from CSoundInterface
std::string	m_soundPath

Member Function Documentation

bool ALSound::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 from CSoundInterface.

bool ALSound::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 from CSoundInterface.

bool ALSound::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 from CSoundInterface.

bool ALSound::Create ( bool b3D )

virtual

Function to initialize sound device

Parameters

b3D	- enable support for 3D sound

Reimplemented from CSoundInterface.

bool ALSound::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 from CSoundInterface.

void ALSound::FrameMove ( float rTime )

virtual

Update data each frame

Parameters

rTime - time since last update

Reimplemented from CSoundInterface.

bool ALSound::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 from CSoundInterface.

int ALSound::GetAudioVolume ( )

virtual

Return global sound volume

Returns: global volume as int in range from 0 to MAXVOLUME

Reimplemented from CSoundInterface.

bool ALSound::GetEnable ( )

virtual

Return if plugin is enabled

Returns: return true if plugin is enabled

Reimplemented from CSoundInterface.

int ALSound::GetMusicVolume ( )

virtual

Return music volume

Returns: music volume as int in range from 0 to MAXVOLUME

Reimplemented from CSoundInterface.

bool ALSound::GetSound3D ( )

virtual

Return if we use 3D sound

Returns: true if we have 3D sound enabled

Reimplemented from CSoundInterface.

bool ALSound::GetSound3DCap ( )

virtual

Return if we have 3D sound capable card

Returns: true for 3D sound support

Reimplemented from CSoundInterface.

bool ALSound::IsPlayingMusic ( )

virtual

Check if music if playing

Returns: return true if music is playing

Reimplemented from CSoundInterface.

bool ALSound::MuteAll ( bool bMute )

virtual

Mute/unmute all sounds

Parameters

bMute

Returns: return true on success

Reimplemented from CSoundInterface.

int ALSound::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 from CSoundInterface.

int ALSound::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 from CSoundInterface.

bool ALSound::PlayMusic	(	int	rank,
		bool	bRepeat
	)

virtual

Start playing music

Parameters

rank	- track number
bRepeat	- repeat playing

Returns: return true on success

Reimplemented from CSoundInterface.

bool ALSound::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 from CSoundInterface.

bool ALSound::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 from CSoundInterface.

bool ALSound::RestartMusic ( )

virtual

Restart music

Returns: return true on success

Reimplemented from CSoundInterface.

void ALSound::SetAudioVolume ( int volume )

virtual

Change global sound volume

Parameters

volume - range from 0 to MAXVOLUME

Reimplemented from CSoundInterface.

void ALSound::SetListener	(	Math::Vector	eye,
		Math::Vector	lookat
	)

virtual

Set listener position

Parameters

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

Reimplemented from CSoundInterface.

void ALSound::SetMusicVolume ( int volume )

virtual

Set music volume

Parameters

volume - range from 0 to MAXVOLUME

Reimplemented from CSoundInterface.

void ALSound::SetSound3D ( bool bMode )

virtual

Change sound mode to 2D/3D

Parameters

bMode - true to enable 3D sound

Reimplemented from CSoundInterface.

bool ALSound::Stop ( int channel )

virtual

Stop playing sound

Parameters

channel - channel to work on

Returns: return true on success

Reimplemented from CSoundInterface.

bool ALSound::StopAll ( )

virtual

Stop playing all sounds

Returns: return true on success

Reimplemented from CSoundInterface.

void ALSound::StopMusic ( )

virtual

Stop playing music

Returns: return true on success

Reimplemented from CSoundInterface.

void ALSound::SuspendMusic ( )

virtual

Susspend paying music

Returns: return true on success

Reimplemented from CSoundInterface.

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

/build/buildd/colobot-0.1.2/src/sound/oalsound/alsound.h
/build/buildd/colobot-0.1.2/src/sound/oalsound/alsound.cpp

Public Member Functions

Additional Inherited Members

Member Function Documentation