mm_pub/audio_effects_api/inc/SourceLocationBase.h
changeset 0 40261b775718
child 14 cd271b19d824
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mm_pub/audio_effects_api/inc/SourceLocationBase.h	Tue Feb 02 01:56:55 2010 +0200
@@ -0,0 +1,190 @@
+/*
+* 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 "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  This is the definition of the source location effect class.
+*
+*/
+
+
+#ifndef CSOURCELOCATION_H
+#define CSOURCELOCATION_H
+
+// INCLUDES
+
+#include <e32base.h>
+#include <LocationBase.h>
+#include <MCustomInterface.h>
+
+const TUid KUidSourceLocationEffect = {0x10203835};
+
+// 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 source location effect class for managing source location settings.
+*
+*  @lib SourceLocationEffect.lib
+*  @since 3.0
+*/
+
+class CSourceLocation : public CLocation
+    {
+
+    public:     // Constructors and Destructor
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to a convert utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioConvertUtility& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to an audio input stream utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioInputStream& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to an audio output stream utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioOutputStream& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to an audio player utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioPlayerUtility& aUtility );
+
+        /**
+        * Factory function for creating the Source 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 CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to an audio tone utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMdaAudioToneUtility& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aDevSound A reference to a DevSound instance
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMMFDevSound& aDevSound );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to a custom command utility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CCustomCommandUtility* aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aCustomInterface A reference to a custom interface
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( MCustomInterface& aCustomInterface );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param aUtility A reference to a CMidiClientUtility
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CMidiClientUtility& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.0
+        * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CDrmPlayerUtility& aUtility );
+
+        /**
+        * Factory function for creating the Source location object.
+        * @since 3.2
+        * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
+        * @return pointer to CSourceLocation object
+        */
+        IMPORT_C static CSourceLocation* NewL( CVideoPlayerUtility& aUtility );
+
+        /**
+        *
+        * Destructor
+        */
+        IMPORT_C virtual ~CSourceLocation();
+
+    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 CSourceLocation();
+
+    protected:    // Friend classes
+
+        friend class CSourceLocationMessageHandler;
+
+    };
+
+#endif  // of CSOURCELOCATION_H
+
+// End of File