/*

* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* 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

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  This is the definition of the listener location effect class.

*

*/

#ifndef CLISTENERLOCATION_H

#define CLISTENERLOCATION_H

// INCLUDES

#include <e32base.h>

#include <LocationBase.h>

#include <MCustomInterface.h>

const TUid KUidListenerLocationEffect = {0x1020382D};

// FORWARD DELCARATION

class CMdaAudioConvertUtility;

class CMdaAudioPlayerUtility;

class CMdaAudioRecorderUtility;

class CMdaAudioInputStream;

class CMdaAudioOutputStream;

class CMdaAudioToneUtility;

class CCustomCommandUtility;

class CCustomInterfaceUtility;

class CMMFDevSound;

class CMidiClientUtility;

class CDrmPlayerUtility;

class CVideoPlayerUtility;

// CLASS DECLARATION

/**

*  This is the listener location effect class for managing audio location settings.

*

*  @lib ListenerLocationEffect.lib

*  @since 3.0

*/

class CListenerLocation : public CLocation

    {

    public:     // Constructors and Destructor

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to a convert utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioConvertUtility& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to an audio input stream utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioInputStream& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to an audio output stream utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioOutputStream& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to an audio player utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioPlayerUtility& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to an audio record utility

        * @param aRecordStream ETrue if the effect is to be applied to the recording,

        *                      EFalse if the effect is to be applied only to the playback

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to an audio tone utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMdaAudioToneUtility& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aDevSound A reference to a DevSound instance

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMMFDevSound& aDevSound );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to a custom command utility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CCustomCommandUtility* aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aCustomInterface A reference to a custom interface

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( MCustomInterface& aCustomInterface );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param aUtility A reference to a CMidiClientUtility

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CMidiClientUtility& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.0

        * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CDrmPlayerUtility& aUtility );

        /**

        * Factory function for creating the listener location object.

        * @since 3.2

        * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object

        * @return pointer to CListenerLocation object

        */

        IMPORT_C static CListenerLocation* NewL( CVideoPlayerUtility& aUtility );

        /**

        *

        * Destructor

        */

        IMPORT_C virtual ~CListenerLocation();

    public: // functions from base class

        /*

        * From CAudioEffect

        * Get the unique identifier of the audio effect

        * @since 3.0

        * @return Unique identifier

        */

        IMPORT_C TUid Uid() const;

    protected:

        /**

        * Private C++ constructor for this class.

        * @since    3.0

        * @param    aEffectObserver reference to event observer object

        * @return   -

        */

        IMPORT_C CListenerLocation();

    protected:    // Friend classes

        friend class CListenerLocationMessageHandler;

    };

#endif  // of CLISTENERLOCATION_H

// End of File