#include <songhandle.h>

Public Member Functions
virtual bool	Init (const char resname, bool loop, float volume_preset, int type, SoundControl &ctrl, bool dopplerEffect)
	Initialize this Handle.
	SongHandle (csRef< iDocument > musicalSheet, Instrument *instrument)
	Constructor.
virtual	~SongHandle ()
	Destructor.

Detailed Description

Definition at line 34 of file songhandle.h.

Constructor & Destructor Documentation

Constructor.

Parameters:

musicalSheet	the XML musical sheet.
instrument	the instrument that the player use to play the song.

virtual SongHandle::~SongHandle ( ) [virtual]

Destructor.

virtual bool SongHandle::Init	(	const char *	resname,
		bool	loop,
		float	volume_preset,
		int	type,
		SoundControl *&	ctrl,
		bool	dopplerEffect
	)		`[virtual]`

Initialize this Handle.

Done within this because its not failsave. Returns true or false.

Parameters:

resname	name of the resource
loop	LOOP or DONT_LOOP
volume_preset	volume which all calculation are based upon
type	3d type: can be CS_SND3D_DISABLE=0. CS_SND3D_RELATIVE=1 or CS_SND3D_ABSOLUTE=2
ctrl	SoundControl which controls this Handle
dopplerEffect	true to apply the doppler effect to this sound, false otherwise.

Reimplemented from SoundHandle.

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