1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mm_pub/audio_effects_api/inc/LocationBase.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,127 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004 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 base class for location effect.
    1.18 +*
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef CLOCATION_H
    1.24 +#define CLOCATION_H
    1.25 +
    1.26 +// INCLUDES
    1.27 +
    1.28 +#include <e32base.h>
    1.29 +#include <AudioEffectBase.h>
    1.30 +#include <LocationData.h>
    1.31 +
    1.32 +// CLASS DECLARATION
    1.33 +
    1.34 +/**
    1.35 +*  This is the base class for location effect settings.
    1.36 +*
    1.37 +*  @lib LocationEffect.lib
    1.38 +*  @since 3.0
    1.39 +*/
    1.40 +
    1.41 +class CLocation : public CAudioEffect
    1.42 +	{
    1.43 +
    1.44 +	protected:	// Constructors and destructor
    1.45 +
    1.46 +		/**
    1.47 +        *
    1.48 +        * Destructor
    1.49 +        */
    1.50 +		IMPORT_C virtual ~CLocation();
    1.51 +
    1.52 +		/**
    1.53 +		* Private C++ constructor for this class.
    1.54 +        */
    1.55 +		IMPORT_C CLocation();
    1.56 +
    1.57 +	public: // New Functions
    1.58 +
    1.59 +		/**
    1.60 +        * Gets the cartesian coordinates for the location of the position.
    1.61 +        * @since 3.0
    1.62 +        * @param aX The x-coordinate of the position (in millimeters)
    1.63 +        * @param aY The y-coordinate of the position (in millimeters)
    1.64 +        * @param aZ The z-coordinate of the position (in millimeters)
    1.65 +        * @return -
    1.66 +        */
    1.67 +		IMPORT_C void LocationCartesian( TInt32& aX, TInt32& aY, TInt32& aZ );
    1.68 +
    1.69 +		/**
    1.70 +        * Gets the spherical coordinates for the location of the position.
    1.71 +        * @since 3.0
    1.72 +        * @param aAzimuth The Azimuth of the position (thousandths of radians)
    1.73 +        * @param aElevation The elevation of the position (thousandths of radians)
    1.74 +        * @param aRadius The radius of the position (thousandths of radians)
    1.75 +        * @return -
    1.76 +        */
    1.77 +		IMPORT_C void LocationSpherical( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius );
    1.78 +
    1.79 +		/**
    1.80 +        * Sets the cartesian coordinates for the location of the position.
    1.81 +        * @since 3.0
    1.82 +        * @param aX The x-coordinate of the position
    1.83 +        * @param aY The y-coordinate of the position
    1.84 +        * @param aZ The z-coordinate of the position
    1.85 +        * @return -
    1.86 +        */
    1.87 +		IMPORT_C void SetLocationCartesianL( TInt32& aX, TInt32& aY, TInt32& aZ );
    1.88 +
    1.89 +		/**
    1.90 +        * Sets the spherical coordinates for the location of the position.
    1.91 +        * @since 3.0
    1.92 +        * @param aAzimuth The Azimuth of the position (thousandths of radians)
    1.93 +        * @param aElevation The elevation of the position (thousandths of radians)
    1.94 +        * @param aRadius The radius of the position (thousandths of radians)
    1.95 +        * @return -
    1.96 +        */
    1.97 +		IMPORT_C void SetLocationSphericalL( TInt32& aAzimuth, TInt32& aElevation, TInt32& aRadius );
    1.98 +
    1.99 +    protected:  // Functions from base classes
   1.100 +
   1.101 +		/**
   1.102 +		* From CAudioEffect
   1.103 +		* Create a package of the effect data
   1.104 +        * @since 3.0
   1.105 +        * @return A descriptor containing the effect data.
   1.106 +        */
   1.107 +		IMPORT_C const TDesC8& DoEffectData();
   1.108 +
   1.109 +		/**
   1.110 +		* From CAudioEffect
   1.111 +		* Internal function to unpack effect data
   1.112 +        * @since 3.0
   1.113 +        * @param aEffectDataBuffer Descriptor containing packed effect data
   1.114 +        * @return -
   1.115 +        */
   1.116 +        IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
   1.117 +
   1.118 +	protected:
   1.119 +
   1.120 +		// Location data structure
   1.121 +		TEfLocation iLocationData;
   1.122 +		// Data package sent to server
   1.123 +		TEfLocationDataPckg iDataPckgTo;
   1.124 +		// Data package received from server
   1.125 +		TEfLocationDataPckg iDataPckgFrom;
   1.126 +	};
   1.127 +
   1.128 +#endif	// of CLOCATION_H
   1.129 +
   1.130 +// End of File