Collapse all Symbian^3 Application Developer Library

CDoppler Class Reference

class CDoppler : public CAudioEffect

This is the Doppler effect class for managing doppler settings.

DopplerEffect.lib

Since: 3.0

Inherits from

CDoppler
- CAudioEffect
  - CBase

Public Member Functions
IMPORT_C void	CartesianVelocity ( TInt32 &, TInt32 &, TInt32 &)
IMPORT_C TUint32	Factor ()
IMPORT_C TUint32	FactorMax ()
IMPORT_C void	SetCartesianVelocityL ( TInt32 , TInt32 , TInt32 )
IMPORT_C void	SetFactorL ( TUint32 )
IMPORT_C void	SetSphericalVelocityL ( TInt32 , TInt32 , TInt32 )
IMPORT_C void	SphericalVelocity ( TInt32 &, TInt32 &, TInt32 &)

Protected Member Functions
	CDoppler ()
	~CDoppler ()
IMPORT_C const TDesC8 &	DoEffectData ()
IMPORT_C void	SetEffectData (const TDesC8 &)

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()

Protected Attributes
TEfDopplerDataPckg	iDataPckgFrom
TEfDopplerDataPckg	iDataPckgTo
TEfDoppler	iDopplerData

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

Constructor & Destructor Documentation

CDoppler()

IMPORT_C

CDoppler

(

)

[protected]

Private C++ constructor for this class.

~CDoppler()

IMPORT_C

~CDoppler

(

)

[protected, virtual]

Destructor

Member Functions Documentation

CartesianVelocity(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C void	CartesianVelocity	(	TInt32 &	aX,
			TInt32 &	aY,
			TInt32 &	aZ
		)

Get the velocity's cartesian settings

Since: 3.0

Parameters

TInt32 & aX	Velocity in X direction (mm/s)
TInt32 & aY	Velocity in Y direction (mm/s)
TInt32 & aZ	Velocity in Z direction (mm/s)

DoEffectData()

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

From CAudioEffect Create a package of the effect data

Since: 3.0

Factor()

IMPORT_C TUint32

Factor

(

)

const

Get the current multiplier factor

Since: 3.0

FactorMax()

IMPORT_C TUint32

FactorMax

(

)

const

Get the maximum multiplier factor

Since: 3.0

SetCartesianVelocityL(TInt32, TInt32, TInt32)

IMPORT_C void	SetCartesianVelocityL	(	TInt32	aX,
			TInt32	aY,
			TInt32	aZ
		)

Sets the velocity in Cartesian coordinates of the sound source with respect to the listener.

Since: 3.0

Parameters

TInt32 aX	Velocity in X direction (mm/s)
TInt32 aY	Velocity in Y direction (mm/s)
TInt32 aZ	Velocity in Z direction (mm/s)

SetEffectData(const TDesC8 &)

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameters

const TDesC8 & aEffectDataBuffer

Descriptor containing packed effect data

SetFactorL(TUint32)

IMPORT_C void

SetFactorL

(

TUint32

aFactor

)

Sets the multiplier factor.

Since: 3.0

Parameters

TUint32 aFactor

Factor value in hundredths that ranges from 0 to FactorMax(), where 100 corresponds to 1.00, 200 corresponds to 2.00, etc.

SetSphericalVelocityL(TInt32, TInt32, TInt32)

IMPORT_C void	SetSphericalVelocityL	(	TInt32	aAzimuth,
			TInt32	aElevation,
			TInt32	aRadius
		)

Sets the velocity in spherical coordinates of the sound source with respect to the listener.

Since: 3.0

Parameters

TInt32 aAzimuth	the Azimuth (thousandths of radians)
TInt32 aElevation	the elevation (thousandths of radians)
TInt32 aRadius	the radius (thousandths of radians)

SphericalVelocity(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C void	SphericalVelocity	(	TInt32 &	aAzimuth,
			TInt32 &	aElevation,
			TInt32 &	aRadius
		)

Gets the velocity's spherical coordinates settings.

Since: 3.0

Parameters

TInt32 & aAzimuth	the Azimuth (thousandths of radians)
TInt32 & aElevation	the elevation (thousandths of radians)
TInt32 & aRadius	the radius (thousandths of radians)

Member Data Documentation

TEfDopplerDataPckg iDataPckgFrom

TEfDopplerDataPckg

iDataPckgFrom

[protected]

TEfDopplerDataPckg iDataPckgTo

TEfDopplerDataPckg

iDataPckgTo

[protected]

TEfDoppler iDopplerData

TEfDoppler

iDopplerData

[protected]