williamr@2: /* williamr@2: * Copyright (c) 2006 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: This is the definition of the listener location effect class. williamr@2: * williamr@2: */ williamr@2: williamr@2: williamr@2: #ifndef CLISTENERLOCATION_H williamr@2: #define CLISTENERLOCATION_H williamr@2: williamr@2: // INCLUDES williamr@2: williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: williamr@2: const TUid KUidListenerLocationEffect = {0x1020382D}; williamr@2: williamr@2: // FORWARD DELCARATION williamr@2: class CMdaAudioConvertUtility; williamr@2: class CMdaAudioPlayerUtility; williamr@2: class CMdaAudioRecorderUtility; williamr@2: class CMdaAudioInputStream; williamr@2: class CMdaAudioOutputStream; williamr@2: class CMdaAudioToneUtility; williamr@2: class CCustomCommandUtility; williamr@2: class CCustomInterfaceUtility; williamr@2: class CMMFDevSound; williamr@2: class CMidiClientUtility; williamr@2: class CDrmPlayerUtility; williamr@2: class CVideoPlayerUtility; williamr@2: williamr@2: // CLASS DECLARATION williamr@2: williamr@2: /** williamr@2: * This is the listener location effect class for managing audio location settings. williamr@2: * williamr@2: * @lib ListenerLocationEffect.lib williamr@2: * @since 3.0 williamr@2: */ williamr@2: williamr@2: class CListenerLocation : public CLocation williamr@2: { williamr@2: williamr@2: public: // Constructors and Destructor williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a convert utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioConvertUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio input stream utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioInputStream& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio output stream utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioOutputStream& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio player utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio record utility williamr@2: * @param aRecordStream ETrue if the effect is to be applied to the recording, williamr@2: * EFalse if the effect is to be applied only to the playback williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio tone utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMdaAudioToneUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aDevSound A reference to a DevSound instance williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CMMFDevSound& aDevSound ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a custom command utility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CCustomCommandUtility* aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aCustomInterface A reference to a custom interface williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( MCustomInterface& aCustomInterface ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a CMidiClientUtility williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: williamr@2: IMPORT_C static CListenerLocation* NewL( CMidiClientUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.0 williamr@2: * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CDrmPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the listener location object. williamr@2: * @since 3.2 williamr@2: * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object williamr@2: * @return pointer to CListenerLocation object williamr@2: */ williamr@2: IMPORT_C static CListenerLocation* NewL( CVideoPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * williamr@2: * Destructor williamr@2: */ williamr@2: IMPORT_C virtual ~CListenerLocation(); williamr@2: williamr@2: public: // functions from base class williamr@2: williamr@2: /* williamr@2: * From CAudioEffect williamr@2: * Get the unique identifier of the audio effect williamr@2: * @since 3.0 williamr@2: * @return Unique identifier williamr@2: */ williamr@2: IMPORT_C TUid Uid() const; williamr@2: williamr@2: protected: williamr@2: williamr@2: /** williamr@2: * Private C++ constructor for this class. williamr@2: * @since 3.0 williamr@2: * @param aEffectObserver reference to event observer object williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C CListenerLocation(); williamr@2: williamr@2: protected: // Friend classes williamr@2: williamr@2: friend class CListenerLocationMessageHandler; williamr@2: williamr@2: }; williamr@2: williamr@2: #endif // of CLISTENERLOCATION_H williamr@2: williamr@2: // End of File