Class CoeSoundPlayer

class CoeSoundPlayer;

Description

Utility class for simple sound playing.

Must be used in the same thread as an active UI Control Framework environment (CCoeEnv).

This class plays the sound specified by a TBaSystemSoundType object. The caller can request the sound to be repeated, and the time between repeats. If the exact sound cannot be found on a particular device, a match only by category (first UID) is used. No sound will play if a match is not found.

Members

Defined in CoeSoundPlayer:
CancelSound(), ENoRepeat, ERepeatForever, PlaySound(), PlaySound(), PlaySoundNow(), PlaySoundNow(), anonymous

static inline void PlaySound(const TBaSystemSoundType &aType);

Description

Plays the specified sound.

This function only interrupts another, currently playing, sound if the new sound has a higher priority than the currently playing sound. If you wish to interrupt any currently playing sound and play a new one, use PlaySoundNow() instead of PlaySound().

Parameters

const TBaSystemSoundType &aType The sound to play.

static inline void PlaySound(const TBaSystemSoundType &aType, TInt aPlayCount, const TTimeIntervalMicroSeconds32 &aGap);

Description

Plays the specified sound for the specifed number of times with the specified interval.

This function only interrupts another, currently playing, sound if the new sound has a higher priority than the current one. If you wish to interrupt any currently playing sound and play a new one, use PlaySoundNow() instead of PlaySound().

Parameters

const TBaSystemSoundType &aType The sound to play. TInt aPlayCount The number of times the sound is played. const TTimeIntervalMicroSeconds32 &aGap The interval in microseconds between each time the sound is played.

static inline void PlaySoundNow(const TBaSystemSoundType &aType);

Description

Plays the specified sound, interrupting any other sound that is currently playing.

Parameters

const TBaSystemSoundType &aType The sound to play.

static inline void PlaySoundNow(const TBaSystemSoundType &aType, TInt aPlayCount, const TTimeIntervalMicroSeconds32 &aGap);

Description

Plays the specified sound the specifed number of times with the specified interval, interrupting any other sound that is currently playing.

Parameters

const TBaSystemSoundType &aType The sound to play. TInt aPlayCount The number of times the sound is played. const TTimeIntervalMicroSeconds32 &aGap The interval in microseconds between each time the sound is played.

static IMPORT_C void CancelSound(const TBaSystemSoundType &aType);

Description

Stops playing the specified sound.

Parameters

const TBaSystemSoundType &aType The sound to stop playing.

n/a

Description

ENoRepeat ERepeatForever