epoc32/include/listenerdopplerbase.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
--- a/epoc32/include/listenerdopplerbase.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/listenerdopplerbase.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,190 @@
-listenerdopplerbase.h
+/*
+* 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 Doppler effect class.
+*
+*/
+
+
+#ifndef CLISTENERDOPPLER_H
+#define CLISTENERDOPPLER_H
+
+// INCLUDES
+
+#include <e32base.h>
+#include <DopplerBase.h>
+#include <MCustomInterface.h>
+
+const TUid KUidListenerDopplerEffect = {0x10207B16};
+
+// 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 Doppler effect class for managing Listener Doppler settings.
+*
+*  @lib ListenerDopplerEffect.lib
+*  @since 3.0
+*/
+
+class CListenerDoppler : public CDoppler
+    {
+
+    public:     // Constructors and Destructor
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to a convert utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioConvertUtility& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to an audio input stream utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioInputStream& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to an audio output stream utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioOutputStream& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to an audio player utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioPlayerUtility& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler 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 CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to an audio tone utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMdaAudioToneUtility& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aDevSound A reference to a DevSound instance
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMMFDevSound& aDevSound );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to a custom command utility
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CCustomCommandUtility* aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aCustomInterface A reference to a custom interface
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( MCustomInterface& aCustomInterface );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param aUtility A reference to a CMidiClientUtility Object
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CMidiClientUtility& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.0
+        * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CDrmPlayerUtility& aUtility );
+
+        /**
+        * Factory function for creating the listener Doppler object.
+        * @since 3.2
+        * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
+        * @return pointer to CListenerDoppler object
+        */
+        IMPORT_C static CListenerDoppler* NewL( CVideoPlayerUtility& aUtility );
+
+        /**
+        *
+        * Destructor
+        */
+        IMPORT_C virtual ~CListenerDoppler();
+
+    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 CListenerDoppler();
+
+    protected:    // Friend classes
+
+        friend class CListenerDopplerMessageHandler;
+
+    };
+
+#endif  // of CLISTENERDOPPLER_H
+
+// End of File