diff -r f9bb0fca356a -r 0fd27995241b javauis/amms_qt/mmacontrol/inc/cammsdistanceattenuationcontrol.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/javauis/amms_qt/mmacontrol/inc/cammsdistanceattenuationcontrol.h Tue May 11 16:07:20 2010 +0300 @@ -0,0 +1,121 @@ +/* +* Copyright (c) 2005 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: Controls how the sound is attenuated with its distance. +* +*/ + + +#ifndef CAMMSDISTANCEATTENUATIONCONTROL_H +#define CAMMSDISTANCEATTENUATIONCONTROL_H + +// INCLUDES +#include +#include +#include +#include "cammsbasedistanceattenuationcontrol.h" + +// CONSTANTS +_LIT(KAMMSDistanceAttenuationControl, "DistanceAttenuationControl"); + +// CLASS DECLARATION + +/** +* +* Controls for the Distance Attenuation effect. +* This class delegates Distance Attenuation effect method calls to +* CDistanceAttenuation. +* +* +* @since 3.0 +*/ +NONSHARABLE_CLASS(CAMMSDistanceAttenuationControl): public CAMMSBaseDistanceAttenuationControl +{ +public: // Constructors and destructor + + /** + * Two-phased constructor. + * @param aPlayer Player that has this control. + */ + static CAMMSDistanceAttenuationControl* NewLC(CMMAPlayer* aPlayer); + + /** + * Destructor. + */ + ~CAMMSDistanceAttenuationControl(); + +public: // override base class functions + + /** + * Sets all the 3D audio distance attenuation parameters simultaneously. + * Distances are specified in units defined by + * "GlobalManager.getUnitsPerMeter()" + * + * @param aMinDistance The minimum distance, below which the distance + * gain is clipped to its maximum value of 1.0. + * @param aMaxDistance The maximum distance, beyond which the distance + * gain does not decrease any more. The exact behaviour of the gain at + * distances beyond the maximum distance depends on the value of the + * muteAfterMax. + * @param aMuteAfterMax A boolean determining how the distance gain + * behaves at distances greater than maxDistance: true if beyond the + * maximum distance the source is silent; false if beyond the maximum + * distance the source's gain is held constant at the level at the + * maximum distance. + * @param aRolloffFactor The rolloff factor, specified in thousandths + * (1000 representing a rolloff factor of 1.0, 2000 representing 2.0 and + * 500 representing 0.5). Higher values cause the distance gain to + * attenuate more quickly. + * @return The value that was actually set. + * + * @par Leaving: + * @li \c KErrArgument - \a aMaxDistance <= \a aMinDistance, + * \a aMinDistance <= 0, \a aMaxDistance <= 0 or \a aRolloffFactor < 0 + */ + void SetParametersL( + TInt aMinDistance, + TInt aMaxDistance, + TBool aMuteAfterMax, + TInt aRolloffFactor); + +public: // Functions from base classes + const TDesC& ClassName() const; + + /** + * Prepares the Control. + */ + void PrepareControlL(); + + /** + * Deallocates the Control. + */ + void DeallocateControl(); + +private: + /** + * C++ constructor. + * @param aPlayer Player that has this control. + */ + CAMMSDistanceAttenuationControl(CMMAPlayer* aPlayer); + +private: // Data + + /** Native distance attenuation */ + CDistanceAttenuation* iDistanceAttenuation; + + +}; + +#endif // CAMMSDISTANCEATTENUATIONCONTROL_H + +