williamr@2: /*
williamr@2: * Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Provides API for sound info delivery.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: #ifndef AKNSOUNDINFO_H
williamr@2: #define AKNSOUNDINFO_H
williamr@2: 
williamr@2: // INCLUDES
williamr@2: #include <e32base.h>
williamr@2: 
williamr@2: // DATA TYPES
williamr@2: enum TSoundType
williamr@2:     {
williamr@2:     ESoundTone = 1,
williamr@2:     ESoundFile = 2,
williamr@2:     ESoundSequence = 3
williamr@2:     };
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class RWriteStream;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: *  Provides structure needed for passing the sound information for applications that create own
williamr@2: *  instances to Media Server.
williamr@2: *
williamr@2: *  @lib Avkon.lib
williamr@2: *  @since S60 2.0
williamr@2: */
williamr@2: NONSHARABLE_CLASS(CAknSoundInfo) : public CBase
williamr@2:     {
williamr@2: public:
williamr@2:     /**
williamr@2:     * Constructor.
williamr@2:     *
williamr@2:     * @return Pointer to the new instance.
williamr@2:     */
williamr@2:     IMPORT_C static CAknSoundInfo* NewL();
williamr@2: 
williamr@2:     /**
williamr@2:     * Destructor.
williamr@2:     */
williamr@2:     IMPORT_C ~CAknSoundInfo();
williamr@2: 
williamr@2: public: // New functions
williamr@2:     /**
williamr@2:     * Not currently implemented.
williamr@2:     */
williamr@2:     IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2: 
williamr@2:     /**
williamr@2:     * Not currently implemented.
williamr@2:     */
williamr@2:     IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@2: 
williamr@2: public: // Data
williamr@2:     /** Priority of the sound. */
williamr@2:     TInt16 iPriority;
williamr@2: 
williamr@2:     /** Frequency of the sound. */
williamr@2:     TInt16 iFrequency;
williamr@2: 
williamr@2:     /** Preference of the sound. */
williamr@2:     TInt iPreference;
williamr@2: 
williamr@2:     /** Sound file, used with ESoundFile type only. */
williamr@2:     HBufC* iFile;
williamr@2: 
williamr@2:     /** Duration of the sound. */
williamr@2:     TInt iDuration;
williamr@2: 
williamr@2:     /** Sequence of the sound, used with ESoundSequence type only. */
williamr@2:     HBufC8* iSequence;
williamr@2: 
williamr@2:     /** Default volume of the sound. */
williamr@2:     TUint8 iVolume;
williamr@2: 
williamr@2:     /** Sound type. */
williamr@2:     TSoundType iType;
williamr@2: 
williamr@2: private:
williamr@2:     /**
williamr@2:     * Default Constructor
williamr@2:     */
williamr@2:     CAknSoundInfo();
williamr@2:     };
williamr@2: 
williamr@2: #endif // AKNSOUNDINFO_H
williamr@2: 
williamr@2: // End of file