TBaSystemSoundInfo Class Reference

#include <bassnd.h>

class TBaSystemSoundInfo

Nested Classes and Structures

TBaSystemSoundInfo::TTone

Public Attributes
TInt	iPriority
TBaSystemSoundType	iType
TInt	iVolume

Public Member Enumerations
enum	TSoundCategory { ENull, EFile, ESequence, ETone }

Public Member Functions
	TBaSystemSoundInfo()
	TBaSystemSoundInfo(const TBaSystemSoundType &, const TBaSystemSoundName &, TInt, TInt)
	TBaSystemSoundInfo(const TBaSystemSoundType &, TInt, TInt, TInt)
	TBaSystemSoundInfo(const TBaSystemSoundType &, TTone, TInt, TInt)
void	ExternalizeL(RWriteStream &)
TBaSystemSoundName	FileName()
TInt	FixedSequenceNumber()
void	InternalizeL(RReadStream &)
IMPORT_C void	SetFileName(const TBaSystemSoundName &)
IMPORT_C void	SetFixedSequenceNumber(TInt)
IMPORT_C void	SetTone(const TTone &)
IMPORT_C TSoundCategory	SoundCategory()
TTone	Tone()

Detailed Description

Provides functions that contain the information for a system sound. A sound may be a file, a tone or a fixed sequence.

The characteristics of a physical sound that corresponds to a logical sound are encapsulated in a TBaSystemSoundInfo object. You can get and set the physical sound for a logical sound through the functions provided by the BaSystemSound class.

Member Attribute Documentation

iPriority

TInt

iPriority

iType

TBaSystemSoundType

iType

iVolume

TInt

iVolume

Member Enumeration Documentation

Enum TSoundCategory

Specifies the category of the system sound.

Enumerator	Value	Description
ENull		Specifies no system sound.
EFile		Specifies a file as the system sound.
ESequence		Specifies a sequence as the system sound.
ETone		Specifies a tone as the system sound.

Constructor & Destructor Documentation

TBaSystemSoundInfo ( )

IMPORT_C

TBaSystemSoundInfo

(

)

Constructs a default TBaSystemSoundInfo object. This object has a null type, default volume, default priority, null name, null fixed sequence, and tone of TTone.

TBaSystemSoundInfo ( const TBaSystemSoundType &, const TBaSystemSoundName &, TInt, TInt )

IMPORT_C	TBaSystemSoundInfo	(	const TBaSystemSoundType &	aType,
			const TBaSystemSoundName &	aName,
			TInt	aVolume = 1,
			TInt	aPriority = 0
		)

Constructs a TBaSystemSoundInfo object with the specified type and file name. The sound has default volume and priority.

Parameters
aType	Sound type
aName	Sound name
aVolume	Sound volume
aPriority	Sound priority

TBaSystemSoundInfo ( const TBaSystemSoundType &, TInt, TInt, TInt )

IMPORT_C	TBaSystemSoundInfo	(	const TBaSystemSoundType &	aType,
			TInt	aFixedSequence,
			TInt	aVolume = 1,
			TInt	aPriority = 0
		)

Constructs a TBaSystemSoundInfo object with the specified type and sequence. The sound has default volume and priority.

Parameters
aType	Sound type
aFixedSequence	Sound sequence
aVolume	Sound volume
aPriority	Sound priority

TBaSystemSoundInfo ( const TBaSystemSoundType &, TTone, TInt, TInt )

IMPORT_C	TBaSystemSoundInfo	(	const TBaSystemSoundType &	aType,
			TTone	aTone,
			TInt	aVolume = 1,
			TInt	aPriority = 0
		)

Constructs a TBaSystemSoundInfo object with the specified type and tone. The sound has default volume and priority.

Parameters
aType	Sound type
aTone	Sound tone
aVolume	Sound volume
aPriority	Sound priority

Member Function Documentation

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises an object of this class to a write stream. The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters
aStream	Stream to which the object should be externalised.

FileName ( )

TBaSystemSoundName

FileName

(

)

const [inline]

Gets the current sound's file.

Return Value: The current sound's file.

FixedSequenceNumber ( )

TInt

FixedSequenceNumber

(

)

const [inline]

Gets the current sound's sequence.

Return Value: The current sound's sequence.

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Internalises an object of this class from a read stream. Presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Parameters
aStream	The stream from which the object is to be internalised.

SetFileName ( const TBaSystemSoundName & )

IMPORT_C void

SetFileName

(

const TBaSystemSoundName &

aFileName

)

Replaces the current sound with the specified file.

Parameters
aFileName	The file with which to replace the current sound.

SetFixedSequenceNumber ( TInt )

IMPORT_C void

SetFixedSequenceNumber

(

TInt

aNumber

)

Replaces the current sound with the specified sequence number.

Parameters
aNumber	The sequence number with which to replace the current sound.

SetTone ( const TTone & )

IMPORT_C void

SetTone

(

const TTone &

aTone

)

Replaces the current sound with the specified tone.

Parameters
aTone	The tone with which to replace the current sound.

SoundCategory ( )

IMPORT_C TSoundCategory

SoundCategory

(

)

const

Gets the sound's category.

Return Value: The system sound's category, or NULL if the sound is not a file, sequence, or tone.

Tone ( )

TTone

Tone

(

)

const [inline]

Gets the current system sound's tone.

Return Value: The current sound's tone.