Yukino::Sound Class Reference

Class to store one sound. More...

#include <Sound.h>

List of all members.

Public Member Functions

 Sound ()
 Constructor of the Sound class.
 Sound (const char *file)
 Constructor of the Sound class.
 Sound (const string &file)
 Constructor of the Sound class.
 Sound (const Sound &obj)
 Copy constructor of the Sound class.
Soundoperator= (Sound &obj)
 Operator = of the Sound class.
 ~Sound ()
 Destructor of the Sound class.
UINT Load (const char *file)
 Function to load a sound from a file.
UINT Load (const string &file)
 Function to load a sound from a file.
void Free (void)
 Function to release the data of the Sound object.
UINT SetVolume (int vol)
 Function to change the actual volume of the sound.
int GetVolume (void) const
 Function to obtain the actual volume of the sound.
int GetChannel (void) const
 Function to obtain the actual channel of the sound.


Detailed Description

Class to store one sound.

The Sound class serves to store in memory a sound contained in a file. This it can be a file WAV or OGG. And the volume of the sound can be manipulated.


Constructor & Destructor Documentation

Yukino::Sound::Sound (  ) 

Constructor of the Sound class.

Constructor by defect of the Sound class.

See also:
operator=(), ~Sound().

Yukino::Sound::Sound ( const char *  file  ) 

Constructor of the Sound class.

Constructor of the Sound class, that loads a file.

Parameters:
file Path of the file.
See also:
operator=(), ~Sound().

Yukino::Sound::Sound ( const string &  file  ) 

Constructor of the Sound class.

Constructor of the Sound class, that loads a file.

Parameters:
file Path of the file.
See also:
operator=(), ~Sound().

Yukino::Sound::Sound ( const Sound obj  ) 

Copy constructor of the Sound class.

Parameters:
obj Sound object to copy.
See also:
operator=(), ~Sound().

Yukino::Sound::~Sound (  ) 

Destructor of the Sound class.

See also:
Sound(), operator=().


Member Function Documentation

void Yukino::Sound::Free ( void   ) 

Function to release the data of the Sound object.

This function serves to release the content of the Sound object.

See also:
Load().

int Yukino::Sound::GetChannel ( void   )  const [inline]

Function to obtain the actual channel of the sound.

This function serves to obtain the actual channel of the sound.

Returns:
The actual channel.

int Yukino::Sound::GetVolume ( void   )  const [inline]

Function to obtain the actual volume of the sound.

This function serves to obtain the actual volume of the sound.

See also:
SetVolume().
Returns:
The actual volume.

UINT Yukino::Sound::Load ( const string &  file  )  [inline]

Function to load a sound from a file.

This function serves to load a sound from a file.

Parameters:
file Path of the file.
See also:
Free().
Returns:
If everything goes well returns 0, on errors returns: SOUND_ERROR_LOAD.

UINT Yukino::Sound::Load ( const char *  file  ) 

Function to load a sound from a file.

This function serves to load a sound from a file.

Parameters:
file Path of the file.
See also:
Free().
Returns:
If everything goes well returns 0, on errors returns: SOUND_ERROR_LOAD.

Sound & Yukino::Sound::operator= ( Sound obj  ) 

Operator = of the Sound class.

The obj object is copied in the actual object, and this is given back.

See also:
Sound(), ~Sound().

UINT Yukino::Sound::SetVolume ( int  vol  ) 

Function to change the actual volume of the sound.

This function serves to change the actual volume of the sound.

Parameters:
vol Volume of the sound.
See also:
GetVolume().
Returns:
If everything goes well returns 0, on errors returns: SOUND_ERROR_SETVOLUME.


The documentation for this class was generated from the following files:
Generated on Sun Jun 25 03:43:36 2006 for Yukino by  doxygen 1.4.7