Class TBaSystemSoundType

class TBaSystemSoundType;

Description

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.

Members

Defined in TBaSystemSoundType:
IsNull(), TBaSystemSoundType(), TBaSystemSoundType(), iMajor, iMinor, operator==()

IMPORT_C TBaSystemSoundType();

Description

Constructs a TBaSystemSoundType object with a null category and instance.

IMPORT_C TBaSystemSoundType(TBaSystemSoundUid aMajor, TUid aMinor=TUid::Null());

Description

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

Parameters

inline TBool IsNull() const;

Description

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

Return value

IMPORT_C TBool operator==(const TBaSystemSoundType &aType) const;

Description

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

Parameters

Return value

TBaSystemSoundUid iMajor;

Description

Specifies a sound's category.

TUid iMinor;

Description

Specifies an instance of a sound's category.