CLocation Class Reference

class CLocation : public CAudioEffect

This is the base class for location effect settings.

LocationEffect.lib
Since
3.0

Inherits from

Constructor & Destructor Documentation

CLocation()

IMPORT_CCLocation()[protected]

Private C++ constructor for this class.

~CLocation()

IMPORT_C~CLocation()[protected, virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 &DoEffectData()[protected, virtual]
From CAudioEffect Create a package of the effect data
Since
3.0

LocationCartesian(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C voidLocationCartesian(TInt32 &aX,
TInt32 &aY,
TInt32 &aZ
)
Gets the cartesian coordinates for the location of the position.
Since
3.0

Parameters

TInt32 & aXThe x-coordinate of the position (in millimeters)
TInt32 & aYThe y-coordinate of the position (in millimeters)
TInt32 & aZThe z-coordinate of the position (in millimeters)

LocationSpherical(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C voidLocationSpherical(TInt32 &aAzimuth,
TInt32 &aElevation,
TInt32 &aRadius
)
Gets the spherical coordinates for the location of the position.
Since
3.0

Parameters

TInt32 & aAzimuthThe Azimuth of the position (thousandths of radians)
TInt32 & aElevationThe elevation of the position (thousandths of radians)
TInt32 & aRadiusThe radius of the position (thousandths of radians)

SetEffectData(const TDesC8 &)

IMPORT_C voidSetEffectData(const TDesC8 &aEffectDataBuffer)[protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0

Parameters

const TDesC8 & aEffectDataBufferDescriptor containing packed effect data

SetLocationCartesianL(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C voidSetLocationCartesianL(TInt32 &aX,
TInt32 &aY,
TInt32 &aZ
)
Sets the cartesian coordinates for the location of the position.
Since
3.0

Parameters

TInt32 & aXThe x-coordinate of the position
TInt32 & aYThe y-coordinate of the position
TInt32 & aZThe z-coordinate of the position

SetLocationSphericalL(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C voidSetLocationSphericalL(TInt32 &aAzimuth,
TInt32 &aElevation,
TInt32 &aRadius
)
Sets the spherical coordinates for the location of the position.
Since
3.0

Parameters

TInt32 & aAzimuthThe Azimuth of the position (thousandths of radians)
TInt32 & aElevationThe elevation of the position (thousandths of radians)
TInt32 & aRadiusThe radius of the position (thousandths of radians)

Member Data Documentation

TEfLocationDataPckg iDataPckgFrom

TEfLocationDataPckg iDataPckgFrom[protected]

TEfLocationDataPckg iDataPckgTo

TEfLocationDataPckg iDataPckgTo[protected]

TEfLocation iLocationData

TEfLocation iLocationData[protected]