1.1 --- a/epoc32/include/listenerorientationbase.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/listenerorientationbase.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,191 @@
1.4 -listenerorientationbase.h
1.5 +/*
1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* 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
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: This is the definition of the listener orientation effect class.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef CLISTENERORIENTATION_H
1.24 +#define CLISTENERORIENTATION_H
1.25 +
1.26 +// INCLUDES
1.27 +
1.28 +#include <e32base.h>
1.29 +#include <OrientationBase.h>
1.30 +#include <MCustomInterface.h>
1.31 +
1.32 +const TUid KUidListenerOrientationEffect = {0x1020382E};
1.33 +
1.34 +// FORWARD DELCARATION
1.35 +class CMdaAudioConvertUtility;
1.36 +class CMdaAudioPlayerUtility;
1.37 +class CMdaAudioRecorderUtility;
1.38 +class CMdaAudioInputStream;
1.39 +class CMdaAudioOutputStream;
1.40 +class CMdaAudioToneUtility;
1.41 +class CCustomCommandUtility;
1.42 +class CCustomInterfaceUtility;
1.43 +class CMMFDevSound;
1.44 +class CMidiClientUtility;
1.45 +class CDrmPlayerUtility;
1.46 +class CVideoPlayerUtility;
1.47 +
1.48 +// CLASS DECLARATION
1.49 +
1.50 +/**
1.51 +* This is the listener orientation effect class for managing audio orientation settings.
1.52 +*
1.53 +* @lib ListenerOrientationEffect.lib
1.54 +* @since 3.0
1.55 +*/
1.56 +
1.57 +class CListenerOrientation : public COrientation
1.58 + {
1.59 +
1.60 + public: // Constructors and Destructor
1.61 +
1.62 + /**
1.63 + * Factory function for creating the listener orientation object.
1.64 + * @since 3.0
1.65 + * @param aUtility A reference to a convert utility
1.66 + * @return pointer to CListenerOrientation object
1.67 + */
1.68 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioConvertUtility& aUtility );
1.69 +
1.70 + /**
1.71 + * Factory function for creating the listener orientation object.
1.72 + * @since 3.0
1.73 + * @param aUtility A reference to an audio input stream utility
1.74 + * @return pointer to CListenerOrientation object
1.75 + */
1.76 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioInputStream& aUtility );
1.77 +
1.78 + /**
1.79 + * Factory function for creating the listener orientation object.
1.80 + * @since 3.0
1.81 + * @param aUtility A reference to an audio output stream utility
1.82 + * @return pointer to CListenerOrientation object
1.83 + */
1.84 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioOutputStream& aUtility );
1.85 +
1.86 + /**
1.87 + * Factory function for creating the listener orientation object.
1.88 + * @since 3.0
1.89 + * @param aUtility A reference to an audio player utility
1.90 + * @return pointer to CListenerOrientation object
1.91 + */
1.92 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioPlayerUtility& aUtility );
1.93 +
1.94 + /**
1.95 + * Factory function for creating the listener orientation object.
1.96 + * @since 3.0
1.97 + * @param aUtility A reference to an audio record utility
1.98 + * @param aRecordStream ETrue if the effect is to be applied to the recording,
1.99 + * EFalse if the effect is to be applied only to the playback
1.100 + * @return pointer to CListenerOrientation object
1.101 + */
1.102 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );
1.103 +
1.104 + /**
1.105 + * Factory function for creating the listener orientation object.
1.106 + * @since 3.0
1.107 + * @param aUtility A reference to an audio tone utility
1.108 + * @return pointer to CListenerOrientation object
1.109 + */
1.110 + IMPORT_C static CListenerOrientation* NewL( CMdaAudioToneUtility& aUtility );
1.111 +
1.112 + /**
1.113 + * Factory function for creating the listener orientation object.
1.114 + * @since 3.0
1.115 + * @param aDevSound A reference to a DevSound instance
1.116 + * @return pointer to CListenerOrientation object
1.117 + */
1.118 + IMPORT_C static CListenerOrientation* NewL( CMMFDevSound& aDevSound );
1.119 +
1.120 + /**
1.121 + * Factory function for creating the listener orientation object.
1.122 + * @since 3.0
1.123 + * @param aUtility A reference to a custom command utility
1.124 + * @return pointer to CListenerOrientation object
1.125 + */
1.126 + IMPORT_C static CListenerOrientation* NewL( CCustomCommandUtility* aUtility );
1.127 +
1.128 + /**
1.129 + * Factory function for creating the listener orientation object.
1.130 + * @since 3.0
1.131 + * @param aCustomInterface A reference to a custom interface
1.132 + * @return pointer to CListenerOrientation object
1.133 + */
1.134 + IMPORT_C static CListenerOrientation* NewL( MCustomInterface& aCustomInterface );
1.135 +
1.136 + /**
1.137 + * Factory function for creating the listener orientation object.
1.138 + * @since 3.0
1.139 + * @param aUtility A reference to a CMidiClientUtility
1.140 + * @return pointer to CListenerOrientation object
1.141 + */
1.142 + IMPORT_C static CListenerOrientation* NewL( CMidiClientUtility& aUtility );
1.143 +
1.144 +
1.145 + /**
1.146 + * Factory function for creating the listener orientation object.
1.147 + * @since 3.0
1.148 + * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
1.149 + * @return pointer to CListenerOrientation object
1.150 + */
1.151 + IMPORT_C static CListenerOrientation* NewL( CDrmPlayerUtility& aUtility );
1.152 +
1.153 + /**
1.154 + * Factory function for creating the listener orientation object.
1.155 + * @since 3.2
1.156 + * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
1.157 + * @return pointer to CListenerOrientation object
1.158 + */
1.159 + IMPORT_C static CListenerOrientation* NewL( CVideoPlayerUtility& aUtility );
1.160 +
1.161 + /**
1.162 + *
1.163 + * Destructor
1.164 + */
1.165 + IMPORT_C virtual ~CListenerOrientation();
1.166 +
1.167 + public: // functions from base class
1.168 +
1.169 + /*
1.170 + * From CAudioEffect
1.171 + * Get the unique identifier of the audio effect
1.172 + * @since 3.0
1.173 + * @return Unique identifier
1.174 + */
1.175 + IMPORT_C TUid Uid() const;
1.176 +
1.177 + protected:
1.178 +
1.179 + /**
1.180 + * Private C++ constructor for this class.
1.181 + * @since 3.0
1.182 + * @param aEffectObserver reference to event observer object
1.183 + * @return -
1.184 + */
1.185 + IMPORT_C CListenerOrientation();
1.186 +
1.187 + protected: // Friend classes
1.188 +
1.189 + friend class CListenerOrientationMessageHandler;
1.190 +
1.191 + };
1.192 +
1.193 +#endif // of CLISTENERORIENTATION_H
1.194 +
1.195 +// End of File