Collapse all Symbian^3 Application Developer Library

TBaSystemSoundInfo::TTone Class Reference

class TBaSystemSoundInfo::TTone

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

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

Public Attributes
TTimeIntervalMicroSeconds32	iDuration
TInt	iFrequency

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.

Parameters

TInt aFrequency	The tone's frequency.
TTimeIntervalMicroSeconds32 aDuration	The tone's duration.

Member Functions Documentation

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Saves a tone's frequency and duration.

Parameters

RWriteStream & 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.

Parameters

RReadStream & 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.

Member Data Documentation

TTimeIntervalMicroSeconds32 iDuration

TTimeIntervalMicroSeconds32

iDuration

Duration of the tone.

TInt iFrequency

TInt	iFrequency

Frequency of the tone.