Symaptic: os/ossrv/lowlevellibsandfws/apputils/inc/BASSND.H@260cb5ec6c19

     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #if !defined(__EIKSSND_H__)

    17 #define __EIKSSND_H__

    19 #include <e32base.h>

    20 #include <s32file.h>

    21 #include <mmf/common/mmfbase.h>

    24 /**

    25 Specifies a system sound for a ring, alarm, message, error or event.

    26 "bafl.lib"

    27 @since 6.0

    28 @publishedAll

    29 @released

    30 */

    31 typedef TUid TBaSystemSoundUid;

    33 /**

    34 Specifies a system sound file name.

    35 "bafl.lib"

    36 @since 6.0

    37 @publishedAll

    38 @released

    39 */

    40 typedef TFileName TBaSystemSoundName;

    42 /**

    43 @publishedAll

    44 @released

    45 */

    46 #define KSystemSoundDefaultVolume	1

    47 #define KSystemSoundDefaultPriority	0

    49 /**

    50 this dll may use uids 48aa to 48ca

    51 @publishedAll

    52 @released

    53 */

    54 const TBaSystemSoundUid KSystemSoundRingUID		= {0x100048AB};

    55 const TBaSystemSoundUid KSystemSoundAlarmUID	= {0x100048AC};

    56 const TBaSystemSoundUid KSystemSoundMessageUID	= {0x100048AD};

    58 const TBaSystemSoundUid KUidSystemSoundError={0x1000609E};

    59 const TBaSystemSoundUid KUidSystemSoundEvent={0x1000609F};

    63 class TBaSystemSoundType

    64 /**

    65 Provides a logical sound wrapper. A sound is specified logically using two

    66 UIDs. The first UID specifies the sound's category which can be a file, tone

    67 or sequence; the second, which is optional, specifies an instance of that

    68 category. The pair of UIDs is encapsulated in a TBaSystemSoundType object.

    70 Once a TBaSystemSoundType object is constructed, the sound player class CoeSoundPlayer

    71 is used to play the sound.

    72 @publishedAll

    73 @released

    74 */

    75 	{

    76 public:

    77 	IMPORT_C TBaSystemSoundType();

    78 	IMPORT_C TBaSystemSoundType(TBaSystemSoundUid aMajor,TUid aMinor=KNullUid);

    79 public:

    80 	inline TBool IsNull() const;

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

    82 public:

    83 	/** Specifies a sound's category. */

    84 	TBaSystemSoundUid iMajor;

    85 	/** Specifies an instance of a sound's category. */

    86 	TUid iMinor;

    87 	};

    90 class TBaSystemSoundInfo

    91 /**

    92 Provides functions that contain the information for a system sound. A sound

    93 may be a file, a tone or a fixed sequence.

    95 The characteristics of a physical sound that corresponds to a logical sound

    96 are encapsulated in a TBaSystemSoundInfo object. You can get and set the physical

    97 sound for a logical sound through the functions provided by the BaSystemSound

    98 class.

    99 @publishedAll

   100 @released

   101 */

   102 	{

   103 public:

   105 	class TTone

   106 /**

   107 Provides functions to define a tone. Once defined, the tone can be encapsulated

   108 using the TBaSystemSoundInfo class and subsequently played.

   109 @publishedAll

   110 @released

   112 */

   113 		{

   114 	public:

   116 		inline TTone();

   117 		inline TTone(TInt aFrequency,TTimeIntervalMicroSeconds32 aDuration);

   118 	public:

   120 		TBool IsNull() const;

   121 	public:

   123 		void InternalizeL(RReadStream& aStream);

   125 		void ExternalizeL(RWriteStream& aStream) const;

   126 	public:

   127 	/** Frequency of the tone. */

   128 		TInt iFrequency;

   129 	/** Duration of the tone. */

   130 		TTimeIntervalMicroSeconds32 iDuration;

   131 		};

   132 public:

   133 	/** Specifies the category of the system sound. */

   134 	enum TSoundCategory

   135 		{

   136 		/** Specifies no system sound. */

   137 		ENull,

   139 		/** Specifies a file as the system sound. */

   140 		EFile,

   142 		/** Specifies a sequence as the system sound. */

   143 		ESequence,

   145 		/** Specifies a tone as the system sound. */

   146 		ETone

   147 		};

   148 public:

   149 	IMPORT_C TBaSystemSoundInfo();

   150 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,const TBaSystemSoundName& aName,

   151 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);

   152 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,TInt aFixedSequence,

   153 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);

   154 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,TTone aTone,

   155 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);

   156 public:

   157 	IMPORT_C TSoundCategory SoundCategory() const;

   158 	inline TInt FixedSequenceNumber() const;

   159 	inline TBaSystemSoundName FileName() const;

   160 	inline TTone Tone() const;

   161 	IMPORT_C void SetFixedSequenceNumber(TInt aNumber);

   162 	IMPORT_C void SetFileName(const TBaSystemSoundName& aFileName);

   163 	IMPORT_C void SetTone(const TTone& aTone);

   165 	void InternalizeL(RReadStream& aStream);

   166 	void ExternalizeL(RWriteStream& aStream) const;

   167 public:

   168 	TBaSystemSoundType iType;

   169 	TInt iVolume;

   170 	TInt iPriority;

   171 private:

   172 	TBaSystemSoundName iName;

   173 	TInt iFixedSequence;

   174 	TTone iTone;

   175 	};

   178 /**

   179 API class to retrieve and modify the system sounds settings.

   181 Note that SystemSoundFile() is now deprecated and will be removed in a future

   182 release. The filename it returns is no longer valid but is kept for backwards

   183 compatibility. The system sounds settings are no longer stored in a data file.

   185 @see BaSystemSound::SystemSoundFile

   186 @see KSystemSoundRepositoryUID

   187 @publishedAll

   188 @released

   189 */

   190 class BaSystemSound

   191 	{

   192 public:

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

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

   195     IMPORT_C static TFileName SystemSoundFile(); // Deprecated

   196 private:

   197 	TBaSystemSoundName static DefaultSound(TBaSystemSoundUid aSSUid);

   198 	};

   201 class CBaSystemSoundArray: public CBase

   202 /**

   203  * An array to contain the set of system sounds for a TBaSystemSoundUid

   204 @publishedAll

   205 @released

   206  */

   207  	{

   208 public:

   209 	CBaSystemSoundArray();

   210 	~CBaSystemSoundArray();

   211 public:

   212 	IMPORT_C static CBaSystemSoundArray* NewL();

   213 	IMPORT_C static CBaSystemSoundArray* NewLC();

   214 	IMPORT_C void RestoreL(RFs& aFsSession,TBaSystemSoundUid aSSUid);

   215 	IMPORT_C TInt Count() ;

   216 	IMPORT_C TBaSystemSoundInfo At(TInt aIndex);

   218 private:

   219 	TBaSystemSoundUid iUid;

   220 	CArrayFixFlat<TBaSystemSoundInfo> iSystemSounds;

   221 	};

   224 class TBaSoundPriorityBase

   225 /**

   226 Utility class to bundle up priority, priority preference and device specific data

   227 Only intended to be used in conjunction with TBaSystemSoundInfo::iPriority

   229 Layout of class is

   230 bits 31 -> 16:	Device specific priority preference data

   231 bits 15 -> 8:	Standard Epoc TMdaPriorityPreference setting

   232 bits 7 -> 0:		Priority value stored as a TInt8.  Maximum range possible is -256 -> +255

   233 					Note that MediaSvr currently defines a narrower range than this

   234 @publishedAll

   235 @released

   236 */

   237 	{

   238 public:

   239 	inline TInt Int() const;

   240 	inline TInt Priority() const;

   241 	IMPORT_C TMdaPriorityPreference PriorityPreference() const;

   242 protected:

   243 	inline TBaSoundPriorityBase();

   244 	void Set(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);

   245 protected:

   246 	TInt iPriority;

   247 	};

   250 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS

   251 #include <bassnduid.h>

   252 #endif

   254 class TBaSoundPriorityEncoder : public TBaSoundPriorityBase

   255 /**

   256 Encode TBaSystemSoundInfo::iPriority before persisting a sound preference

   257 @publishedAll

   258 @released

   259 */

   260 	{

   261 public:

   262 	IMPORT_C TBaSoundPriorityEncoder(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);

   263 	};

   267 inline TBool TBaSystemSoundType::IsNull() const

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

   270 	@return ETrue if the sound's category and instance are null, EFalse otherwise. */

   271 	{return iMajor==KNullUid && iMinor==KNullUid;}

   274 inline TBaSystemSoundInfo::TTone::TTone()

   275 	: iFrequency(0), iDuration(0)

   276 	/** Default constructor. Sets up a TTone object with null frequency and duration. */

   277 	{}

   278 inline TBaSystemSoundInfo::TTone::TTone(TInt aFrequency,TTimeIntervalMicroSeconds32 aDuration)

   279 	: iFrequency(aFrequency), iDuration(aDuration)

   280 	/** Constructor which sets up a TTone object with specified frequency and duration.

   282 	@param aFrequency The tone's frequency.

   283 	@param aDuration The tone's duration. */

   284 	{}

   286 inline TInt TBaSystemSoundInfo::FixedSequenceNumber() const

   287 	/** Gets the current sound's sequence.

   289 	@return The current sound's sequence. */

   290 	{return iFixedSequence;}

   292 inline TBaSystemSoundName TBaSystemSoundInfo::FileName() const

   293 	/** Gets the current sound's file.

   295 	@return The current sound's file. */

   296 	{return iName;}

   298 inline TBaSystemSoundInfo::TTone TBaSystemSoundInfo::Tone() const

   299 	/** Gets the current system sound's tone.

   301 	@return The current sound's tone. */

   302 	{return iTone;}

   304 inline TBaSoundPriorityBase::TBaSoundPriorityBase()

   305 	{}

   306 inline TInt TBaSoundPriorityBase::Int() const

   307 	{return iPriority;}

   308 inline TInt TBaSoundPriorityBase::Priority() const

   309 	{return (TInt8)iPriority;}

   312 #endif

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--