Symbian
Symbian OS Library

SYMBIAN OS V9.2

[Index] [Spacer] [Previous] [Next]

Location: BASSND.H
Link against: bafl.lib

Class BaSystemSound

class BaSystemSound;

Description

Utility class to handle system sounds.

Members

Defined in BaSystemSound:
GetSound(), SetSoundL(), SystemSoundFile()

Member functions

GetSound()

static IMPORT_C 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

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

SetSoundL()

Capability: WriteDeviceDataNote only clients with WriteDeviceData capability can sucessfully call this API.

static IMPORT_C 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.

SystemSoundFile()

static IMPORT_C TFileName SystemSoundFile();

Description

Returns the name of the system sound table. This interface will be deprecated in a future release and eventually removed. A new API will be provided to allow clients to monitor for changes to System Sounds.

Return value

TFileName

The name of the system sound table.

[Previous] [Top] [Next]