CDoppler Class Reference

#include <DopplerBase.h>

Link against: DopplerEffect.lib

class CDoppler : public CAudioEffect

Inherits from

Protected Attributes
TEfDopplerDataPckg iDataPckgFrom
TEfDopplerDataPckg iDataPckgTo
TEfDoppler iDopplerData
Public Member Functions
IMPORT_C voidCartesianVelocity(TInt32 &, TInt32 &, TInt32 &)
IMPORT_C TUint32Factor()
IMPORT_C TUint32FactorMax()
IMPORT_C voidSetCartesianVelocityL(TInt32, TInt32, TInt32)
IMPORT_C voidSetFactorL(TUint32)
IMPORT_C voidSetSphericalVelocityL(TInt32, TInt32, TInt32)
IMPORT_C voidSphericalVelocity(TInt32 &, TInt32 &, TInt32 &)
Protected Member Functions
CDoppler()
virtual ~CDoppler()
virtual IMPORT_C const TDesC8 &DoEffectData()
virtual IMPORT_C voidSetEffectData(const TDesC8 &)
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers
Inherited Functions
CAudioEffect::ApplyL()
CAudioEffect::CAudioEffect()
CAudioEffect::DisableL()
CAudioEffect::EnableL()
CAudioEffect::EnforceL(TBool)
CAudioEffect::HaveUpdateRights()const
CAudioEffect::IsEnabled()const
CAudioEffect::IsEnforced()const
CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
CAudioEffect::Uid()const
CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
CAudioEffect::~CAudioEffect()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Detailed Description

This is the Doppler effect class for managing doppler settings.

Since
3.0

Member Attribute Documentation

iDataPckgFrom

TEfDopplerDataPckg iDataPckgFrom[protected]

iDataPckgTo

TEfDopplerDataPckg iDataPckgTo[protected]

iDopplerData

TEfDoppler iDopplerData[protected]

Constructor & Destructor Documentation

CDoppler ( )

IMPORT_CCDoppler()[protected]

Private C++ constructor for this class.

~CDoppler ( )

IMPORT_C~CDoppler()[protected, virtual]

Destructor

Member Function Documentation

CartesianVelocity ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C voidCartesianVelocity(TInt32 &aX,
TInt32 &aY,
TInt32 &aZ
)
Get the velocity's cartesian settings
Since
3.0
ParameterDescription
aXVelocity in X direction (mm/s)
aYVelocity in Y direction (mm/s)
aZVelocity in Z direction (mm/s)

DoEffectData ( )

IMPORT_C const TDesC8 &DoEffectData()[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data
Since
3.0

Returns: A descriptor containing the effect data.

Factor ( )

IMPORT_C TUint32Factor()const
Get the current multiplier factor
Since
3.0

Returns: multiplier factor

FactorMax ( )

IMPORT_C TUint32FactorMax()const
Get the maximum multiplier factor
Since
3.0

Returns: multiplier factor

SetCartesianVelocityL ( TInt32, TInt32, TInt32 )

IMPORT_C voidSetCartesianVelocityL(TInt32aX,
TInt32aY,
TInt32aZ
)
Sets the velocity in Cartesian coordinates of the sound source with respect to the listener.
Since
3.0
ParameterDescription
aXVelocity in X direction (mm/s)
aYVelocity in Y direction (mm/s)
aZVelocity in Z direction (mm/s)

Returns: -

SetEffectData ( const TDesC8 & )

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

Returns: -

SetFactorL ( TUint32 )

IMPORT_C voidSetFactorL(TUint32aFactor)
Sets the multiplier factor.
Since
3.0
ParameterDescription
aFactorFactor value in hundredths that ranges from 0 to FactorMax(), where 100 corresponds to 1.00, 200 corresponds to 2.00, etc.

Returns: -

SetSphericalVelocityL ( TInt32, TInt32, TInt32 )

IMPORT_C voidSetSphericalVelocityL(TInt32aAzimuth,
TInt32aElevation,
TInt32aRadius
)
Sets the velocity in spherical coordinates of the sound source with respect to the listener.
Since
3.0
ParameterDescription
aAzimuththe Azimuth (thousandths of radians)
aElevationthe elevation (thousandths of radians)
aRadiusthe radius (thousandths of radians)

Returns: -

SphericalVelocity ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C voidSphericalVelocity(TInt32 &aAzimuth,
TInt32 &aElevation,
TInt32 &aRadius
)
Gets the velocity's spherical coordinates settings.
Since
3.0
ParameterDescription
aAzimuththe Azimuth (thousandths of radians)
aElevationthe elevation (thousandths of radians)
aRadiusthe radius (thousandths of radians)

Returns: -

© Nokia 2011.