SoundFile Struct Reference

Class that contains the most important informations about a soundfile It contains the name, filename and if loaded the data. More...

#include <data.h>

List of all members.

Public Member Functions
	SoundFile (const char *newname, const char *newfilename)
	Constructs a SoundFile.
	SoundFile (SoundFile *const &copythat)
	Copy Constructor.
	SoundFile (SoundFile *const &copySoundFile)
	Copy constructor.
	SoundFile (const char *newName, const char *newFileName)
	Constructs a SoundFile.
	~SoundFile ()
	Destructor.
	~SoundFile ()
	Destructor.
Public Attributes
csString	filename
	filename in our vfs (maybe not unique)
csString	fileName
	File's name in our vfs. It doesn't need to be unique.
csTicks	lasttouch
	last time when this SoundFile was used/touched
csTicks	lastTouch
	Last time when this SoundFile was used/touched.
bool	loaded
	true if snddata is loaded, false if not
csString	name
	name of this file/resource MUST be unique
csRef< iSndSysData >	sndData
	Data in suitable format.
csRef< iSndSysData >	snddata
	data in suitable format

---

Detailed Description

Class that contains the most important informations about a soundfile It contains the name, filename and if loaded the data.

This struct keeps the information about a sound file.

its used by

See also:

SoundData to manage our SoundFile(s).

SoundDataCache, the class that uses this struct.

Definition at line 109 of file data.h.

---

Constructor & Destructor Documentation

SoundFile::SoundFile	(	const char *	newname,
		const char *	newfilename
	)

Constructs a SoundFile.

Parameters:

newname	name of this SoundFile (must be unique)
newfilename	filename this SoundFile is using

SoundFile::SoundFile

(

SoundFile *const &

copythat

)

Copy Constructor.

Copys the whole SoundFile.

SoundFile::~SoundFile

(

)

Destructor.

SoundFile::SoundFile	(	const char *	newName,
		const char *	newFileName
	)

Constructs a SoundFile.

Parameters:

newName	identifier of this SoundFile (must be unique).
newFileName	file's name this SoundFile is using.

SoundFile::SoundFile

(

SoundFile *const &

copySoundFile

)

Copy constructor.

It copies the whole SoundFile.

Parameters:

copySoundFile

SoundFile to copy.

SoundFile::~SoundFile

(

)

Destructor.

---

Member Data Documentation

csString SoundFile::filename

filename in our vfs (maybe not unique)

Definition at line 113 of file data.h.

csString SoundFile::fileName

File's name in our vfs. It doesn't need to be unique.

Definition at line 50 of file data.h.

csTicks SoundFile::lasttouch

last time when this SoundFile was used/touched

Definition at line 116 of file data.h.

csTicks SoundFile::lastTouch

Last time when this SoundFile was used/touched.

Definition at line 52 of file data.h.

bool SoundFile::loaded

true if snddata is loaded, false if not

Definition at line 115 of file data.h.

csString SoundFile::name

name of this file/resource MUST be unique

Identifier of this file/resource. MUST be unique.

Definition at line 112 of file data.h.

csRef<iSndSysData> SoundFile::sndData

Data in suitable format.

Definition at line 51 of file data.h.

csRef<iSndSysData> SoundFile::snddata

data in suitable format

Definition at line 114 of file data.h.

---

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

• common/sound/data.h
• plugins/common/soundmanager/data.h