Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: bassnd.h
Link against: bafl.lib

Class BaSystemSound

BaSystemSound

Support

Supported from 6.0

Description

Utility class to handle system sounds.

Defined in BaSystemSound:
GetSound(), SetSoundL()


Member functions


GetSound()

static TInt GetSound(RFs& aFsSession,const TBaSystemSoundType& aType,TBaSystemSoundInfo& aInfo);

Description

Gets sound information from the specified file.

Parameters

RFs& aFsSession

The file server session.

const TBaSystemSoundType& aType

The system sound file from which to get the characteristics of a physical sound. The file specified here encapsulates a major and optionally a minor UID. The major UID specifes the sound category while the minor UID specifies an instance of the category.

TBaSystemSoundInfo& aInfo

On return, the sound.

Return value

TInt

Returns KErrNone if successful, or one of the system wide errors if unsuccessful.


SetSoundL()

static void SetSoundL(RFs& aFsSession,const TBaSystemSoundInfo& aInfo);

Description

Adds the specified system sound to the array of system sounds if it does not already exist in the array.

Parameters

RFs& aFsSession

The file server session.

const TBaSystemSoundInfo& aInfo

The sound to add to the array.