epoc32/include/mw/aknsoundinfo.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/aknsoundinfo.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/aknsoundinfo.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,103 @@
     1.4 -aknsoundinfo.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Provides API for sound info delivery.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +#ifndef AKNSOUNDINFO_H
    1.23 +#define AKNSOUNDINFO_H
    1.24 +
    1.25 +// INCLUDES
    1.26 +#include <e32base.h>
    1.27 +
    1.28 +// DATA TYPES
    1.29 +enum TSoundType
    1.30 +    {
    1.31 +    ESoundTone = 1,
    1.32 +    ESoundFile = 2,
    1.33 +    ESoundSequence = 3
    1.34 +    };
    1.35 +
    1.36 +// FORWARD DECLARATIONS
    1.37 +class RWriteStream;
    1.38 +
    1.39 +// CLASS DECLARATION
    1.40 +/**
    1.41 +*  Provides structure needed for passing the sound information for applications that create own
    1.42 +*  instances to Media Server.
    1.43 +*
    1.44 +*  @lib Avkon.lib
    1.45 +*  @since S60 2.0
    1.46 +*/
    1.47 +NONSHARABLE_CLASS(CAknSoundInfo) : public CBase
    1.48 +    {
    1.49 +public:
    1.50 +    /**
    1.51 +    * Constructor.
    1.52 +    *
    1.53 +    * @return Pointer to the new instance.
    1.54 +    */
    1.55 +    IMPORT_C static CAknSoundInfo* NewL();
    1.56 +
    1.57 +    /**
    1.58 +    * Destructor.
    1.59 +    */
    1.60 +    IMPORT_C ~CAknSoundInfo();
    1.61 +
    1.62 +public: // New functions
    1.63 +    /**
    1.64 +    * Not currently implemented.
    1.65 +    */
    1.66 +    IMPORT_C void InternalizeL(RReadStream& aStream);
    1.67 +
    1.68 +    /**
    1.69 +    * Not currently implemented.
    1.70 +    */
    1.71 +    IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
    1.72 +
    1.73 +public: // Data
    1.74 +    /** Priority of the sound. */
    1.75 +    TInt16 iPriority;
    1.76 +
    1.77 +    /** Frequency of the sound. */
    1.78 +    TInt16 iFrequency;
    1.79 +
    1.80 +    /** Preference of the sound. */
    1.81 +    TInt iPreference;
    1.82 +
    1.83 +    /** Sound file, used with ESoundFile type only. */
    1.84 +    HBufC* iFile;
    1.85 +
    1.86 +    /** Duration of the sound. */
    1.87 +    TInt iDuration;
    1.88 +
    1.89 +    /** Sequence of the sound, used with ESoundSequence type only. */
    1.90 +    HBufC8* iSequence;
    1.91 +
    1.92 +    /** Default volume of the sound. */
    1.93 +    TUint8 iVolume;
    1.94 +
    1.95 +    /** Sound type. */
    1.96 +    TSoundType iType;
    1.97 +
    1.98 +private:
    1.99 +    /**
   1.100 +    * Default Constructor
   1.101 +    */
   1.102 +    CAknSoundInfo();
   1.103 +    };
   1.104 +
   1.105 +#endif // AKNSOUNDINFO_H
   1.106 +
   1.107 +// End of file