sound::SamplePLIB Class Reference

Sound sample (PLIB). More...

#include <_src_sound_sound_sample_plib.hh>

Inheritance diagram for sound::SamplePLIB:

List of all members.

Public Member Functions
	SamplePLIB (const Sample::Name &sampleName)
virtual	~SamplePLIB ()
virtual bool	IfPlaying (void)
virtual bool	Play (const defs::ePlayLoop loop, const fp volume)
virtual bool	Stop (void)
virtual bool	SetVolume (const fp volume)
virtual fp	GetVolume (void)
Private Attributes
fp	mVolume
	current volume (PLIB alters waveform data)
defs::ePlayLoop	mPlayLoop
	whether to repeat sample
slSample *	mSLSample
	PLIB sound object.
string	mBuf
	stored for changing volume

Detailed Description

Sound sample (PLIB).

Constructor & Destructor Documentation

sound::SamplePLIB::SamplePLIB ( const Sample::Name & sampleName )

ctor/dtor.

sound::SamplePLIB::~SamplePLIB ( ) [virtual]

Member Function Documentation

fp sound::SamplePLIB::GetVolume ( void ) [virtual]

Returns:: Volume of a sound sample.

Implements sound::Sample.

bool sound::SamplePLIB::IfPlaying ( void ) [virtual]

Returns:: True if sample is playing.

Implements sound::Sample.

bool sound::SamplePLIB::Play	(	const defs::ePlayLoop	playLoop,
		const fp	volume
	)			`[virtual]`

Play sound sample.

Parameters:

	playLoop	Play continuously or once.
	volume	Default is DEFAULT_VOLUME.

Returns:: False if error.

Implements sound::Sample.

bool sound::SamplePLIB::SetVolume ( const fp volume ) [virtual]

Set volume of a sound sample.

Returns:: False if error.

Implements sound::Sample.

bool sound::SamplePLIB::Stop ( void ) [virtual]

Stop playing a sound sample.

Returns:: False if error.

Implements sound::Sample.

Member Data Documentation

string sound::SamplePLIB::mBuf [private]

stored for changing volume

defs::ePlayLoop sound::SamplePLIB::mPlayLoop [private]

whether to repeat sample

slSample* sound::SamplePLIB::mSLSample [private]

PLIB sound object.

fp sound::SamplePLIB::mVolume [private]

current volume (PLIB alters waveform data)

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Palomino Flight Simulator documents generated by doxygen 1.7.1 on Tue May 15 2012 22:40:12