TBaSystemSoundType Class Reference

class TBaSystemSoundType

Provides a logical sound wrapper. A sound is specified logically using two UIDs. The first UID specifies the sound's category which can be a file, tone or sequence; the second, which is optional, specifies an instance of that category. The pair of UIDs is encapsulated in a TBaSystemSoundType object.

Once a TBaSystemSoundType object is constructed, the sound player class CoeSoundPlayer is used to play the sound.

Constructor & Destructor Documentation

TBaSystemSoundType()

IMPORT_CTBaSystemSoundType()

Constructs a TBaSystemSoundType object with a null category and instance.

TBaSystemSoundType(TBaSystemSoundUid, TUid)

IMPORT_CTBaSystemSoundType(TBaSystemSoundUidaMajor,
TUidaMinor = KNullUid
)

Constructs a TBaSystemSoundType object with the specified category and, optionally, instance.

Parameters

TBaSystemSoundUid aMajorThe category, this can be a file, tone or sequence.
TUid aMinor = KNullUidThe instance of the category. This is optional.

Member Functions Documentation

IsNull()

TBool IsNull()const [inline]

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

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

operator==(const TBaSystemSoundType &)

IMPORT_C TBooloperator==(const TBaSystemSoundType &aType)const

Tests whether the sound's category and instance are the same as that specified.

ETrue if the sound's category and instance is the same as aType, EFalse otherwise.

Parameters

const TBaSystemSoundType & aTypeThe category and instance to test.

Member Data Documentation

TBaSystemSoundUid iMajor

TBaSystemSoundUid iMajor

Specifies a sound's category.

TUid iMinor

TUid iMinor

Specifies an instance of a sound's category.