epoc32/include/bassnd.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    16 #if !defined(__EIKSSND_H__)
    16 #if !defined(__EIKSSND_H__)
    17 #define __EIKSSND_H__
    17 #define __EIKSSND_H__
    18 
    18 
    19 #include <e32base.h>
    19 #include <e32base.h>
    20 #include <s32file.h>
    20 #include <s32file.h>
    21 #include <mda/common/controller.h>
    21 #include <mmf/common/mmfbase.h>
    22 
    22 
    23 
    23 
    24 /**
    24 /**
    25 Specifies a system sound for a ring, alarm, message, error or event.
    25 Specifies a system sound for a ring, alarm, message, error or event.
    26 "bafl.lib"
    26 "bafl.lib"
    56 const TBaSystemSoundUid KSystemSoundMessageUID	= {0x100048AD};
    56 const TBaSystemSoundUid KSystemSoundMessageUID	= {0x100048AD};
    57 
    57 
    58 const TBaSystemSoundUid KUidSystemSoundError={0x1000609E};
    58 const TBaSystemSoundUid KUidSystemSoundError={0x1000609E};
    59 const TBaSystemSoundUid KUidSystemSoundEvent={0x1000609F};
    59 const TBaSystemSoundUid KUidSystemSoundEvent={0x1000609F};
    60 
    60 
    61 /**
       
    62 This is the UID of the repository where the system sound data is stored.
       
    63 The UID is published to UI platforms to allow them to use the key value in 
       
    64 the CRepository::NotifyRequest() API to monitor for changes in the system
       
    65 sound data.
       
    66 
       
    67 @see CRepository
       
    68 @see BaSystemSound::SystemSoundFile
       
    69 @publishedPartner
       
    70 @released
       
    71 */
       
    72 const TUid KSystemSoundRepositoryUID = {0x100048AA};
       
    73 
    61 
    74 
    62 
    75 class TBaSystemSoundType
    63 class TBaSystemSoundType
    76 /** 
    64 /** 
    77 Provides a logical sound wrapper. A sound is specified logically using two 
    65 Provides a logical sound wrapper. A sound is specified logically using two 
   257 protected:
   245 protected:
   258 	TInt iPriority;
   246 	TInt iPriority;
   259 	};
   247 	};
   260 
   248 
   261 
   249 
       
   250 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   251 #include <bassnduid.h>
       
   252 #endif
       
   253 
   262 class TBaSoundPriorityEncoder : public TBaSoundPriorityBase
   254 class TBaSoundPriorityEncoder : public TBaSoundPriorityBase
   263 /**
   255 /**
   264 Encode TBaSystemSoundInfo::iPriority before persisting a sound preference
   256 Encode TBaSystemSoundInfo::iPriority before persisting a sound preference
   265 @publishedAll
   257 @publishedAll
   266 @released
   258 @released
   268 	{
   260 	{
   269 public:
   261 public:
   270 	IMPORT_C TBaSoundPriorityEncoder(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);
   262 	IMPORT_C TBaSoundPriorityEncoder(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);
   271 	};
   263 	};
   272 
   264 
   273 
       
   274 class TBaSoundPriorityDecoder : public TBaSoundPriorityBase
       
   275 /**
       
   276 Decode a restored TBaSystemSoundInfo::iPriority
       
   277 @internalComponent
       
   278 */
       
   279 	{
       
   280 public:
       
   281 	inline TBaSoundPriorityDecoder(TInt aVal);
       
   282 	};
       
   283 
   265 
   284 
   266 
   285 inline TBool TBaSystemSoundType::IsNull() const
   267 inline TBool TBaSystemSoundType::IsNull() const
   286 	/** Tests whether the sound's category and instance are null.
   268 	/** Tests whether the sound's category and instance are null.
   287 	
   269 	
   324 inline TInt TBaSoundPriorityBase::Int() const
   306 inline TInt TBaSoundPriorityBase::Int() const
   325 	{return iPriority;}
   307 	{return iPriority;}
   326 inline TInt TBaSoundPriorityBase::Priority() const
   308 inline TInt TBaSoundPriorityBase::Priority() const
   327 	{return (TInt8)iPriority;}
   309 	{return (TInt8)iPriority;}
   328 
   310 
   329 inline TBaSoundPriorityDecoder::TBaSoundPriorityDecoder(TInt aVal)
       
   330 	{iPriority=aVal;}
       
   331 
   311 
   332 #endif
   312 #endif