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