Class TBaSystemSoundType

TBaSystemSoundType

Support

Supported from 6.0

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.

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

TBaSystemSoundType();

Description

Constructs a TBaSystemSoundType object with a null category and instance.

TBaSystemSoundType(TBaSystemSoundUid aMajor,TUid aMinor);

Description

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

Parameters

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

TBool IsNull() const;

Description

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

Return value

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

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

Description

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

Parameters

const TBaSystemSoundType& aType The category and instance to test.

Return value

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

TBaSystemSoundUid iMajor

Description

Specifies a sound's category.

TUid iMinor

Description

Specifies an instance of a sound's category.