TBaSystemSoundInfo::TTone Class Reference

#include <bassnd.h>

class TBaSystemSoundInfo::TTone

Public Attributes
TTimeIntervalMicroSeconds32	iDuration
TInt	iFrequency

Public Member Functions
	TTone()
	TTone(TInt, TTimeIntervalMicroSeconds32)
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
TBool	IsNull()

Detailed Description

Provides functions to define a tone. Once defined, the tone can be encapsulated using the TBaSystemSoundInfo class and subsequently played.

Member Attribute Documentation

iDuration

TTimeIntervalMicroSeconds32

iDuration

Duration of the tone.

iFrequency

TInt	iFrequency

Frequency of the tone.

Constructor & Destructor Documentation

TTone ( )

TTone

(

)

[inline]

Default constructor. Sets up a TTone object with null frequency and duration.

TTone ( TInt, TTimeIntervalMicroSeconds32 )

TTone	(	TInt	aFrequency,
		TTimeIntervalMicroSeconds32	aDuration
	)	[inline]

Constructor which sets up a TTone object with specified frequency and duration.

Parameter	Description
aFrequency	The tone's frequency.
aDuration	The tone's duration.

Member Function Documentation

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Saves a tone's frequency and duration.

Parameter	Description
aStream	The stream to which the tone's frequency and duration is written.

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Gets a tone's frequency and duration.

Parameter	Description
aStream	The stream from which the tone's frequency and duration is read.

IsNull ( )

TBool

IsNull

(

)

const

Tests whether the sound's category and instance are null.

Returns: ETrue if the sound's category and instance are null, EFalse otherwise.