diff -r 666f914201fb -r 2fe1408b6811 epoc32/include/listenerorientationbase.h --- a/epoc32/include/listenerorientationbase.h Tue Nov 24 13:55:44 2009 +0000 +++ b/epoc32/include/listenerorientationbase.h Tue Mar 16 16:12:26 2010 +0000 @@ -1,1 +1,191 @@ -listenerorientationbase.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 orientation effect class. +* +*/ + + +#ifndef CLISTENERORIENTATION_H +#define CLISTENERORIENTATION_H + +// INCLUDES + +#include +#include +#include + +const TUid KUidListenerOrientationEffect = {0x1020382E}; + +// 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 orientation effect class for managing audio orientation settings. +* +* @lib ListenerOrientationEffect.lib +* @since 3.0 +*/ + +class CListenerOrientation : public COrientation + { + + public: // Constructors and Destructor + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to a convert utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioConvertUtility& aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to an audio input stream utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioInputStream& aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to an audio output stream utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioOutputStream& aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to an audio player utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioPlayerUtility& aUtility ); + + /** + * Factory function for creating the listener orientation 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 CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to an audio tone utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMdaAudioToneUtility& aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aDevSound A reference to a DevSound instance + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMMFDevSound& aDevSound ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to a custom command utility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CCustomCommandUtility* aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aCustomInterface A reference to a custom interface + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( MCustomInterface& aCustomInterface ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param aUtility A reference to a CMidiClientUtility + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CMidiClientUtility& aUtility ); + + + /** + * Factory function for creating the listener orientation object. + * @since 3.0 + * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CDrmPlayerUtility& aUtility ); + + /** + * Factory function for creating the listener orientation object. + * @since 3.2 + * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object + * @return pointer to CListenerOrientation object + */ + IMPORT_C static CListenerOrientation* NewL( CVideoPlayerUtility& aUtility ); + + /** + * + * Destructor + */ + IMPORT_C virtual ~CListenerOrientation(); + + 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 CListenerOrientation(); + + protected: // Friend classes + + friend class CListenerOrientationMessageHandler; + + }; + +#endif // of CLISTENERORIENTATION_H + +// End of File