CDoppler Class Reference

API published in: S60 3rd Ed

Link against: dopplerbase.lib

Capability Information

Required Capabilities

None

#include <dopplerbase.h>

Inherits CAudioEffect.

Inherited by CListenerDoppler, and CSourceDoppler.

Detailed Description

This is the Doppler effect class for managing doppler settings.

Public Member Functions
IMPORT_C void  CartesianVelocity (TInt32 &aX, TInt32 &aY, TInt32 &aZ)
  Get the velocity's cartesian settings.
IMPORT_C TUint32  Factor () const
  Get the current multiplier factor.
IMPORT_C TUint32  FactorMax () const
  Get the maximum multiplier factor.
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.
IMPORT_C void  SetFactorL (TUint32 aFactor)
  Sets the multiplier factor.
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.
IMPORT_C void  SphericalVelocity (TInt32 &aAzimuth, TInt32 &aElevation, TInt32 &aRadius)
  Gets the velocity's spherical coordinates settings.

Protected Member Functions
virtual IMPORT_C  ~CDoppler ()
  Destructor.
IMPORT_C  CDoppler ()
  Private C++ constructor for this class.
IMPORT_C const TDesC8 &  DoEffectData ()
  From CAudioEffect Create a package of the effect data.
IMPORT_C void  SetEffectData (const TDesC8 &aEffectDataBuffer)
  From CAudioEffect Internal function to unpack effect data.

Protected Attributes
TEfDoppler  iDopplerData
TEfDopplerDataPckg  iDataPckgTo
TEfDopplerDataPckg  iDataPckgFrom

Constructor & Destructor Documentation

virtual IMPORT_C CDoppler::~CDoppler (   )  [protected, virtual]
 

Destructor.

IMPORT_C CDoppler::CDoppler (   )  [protected]
 

Private C++ constructor for this class.

Member Function Documentation

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

Get the velocity's cartesian settings.

Parameters:
aX  Velocity in X direction (mm/s)
aY  Velocity in Y direction (mm/s)
aZ  Velocity in Z direction (mm/s)
IMPORT_C const TDesC8& CDoppler::DoEffectData (   )  [protected, virtual]
 

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

IMPORT_C TUint32 CDoppler::Factor (   )  const
 

Get the current multiplier factor.

Returns:
multiplier factor
IMPORT_C TUint32 CDoppler::FactorMax (   )  const
 

Get the maximum multiplier factor.

Returns:
multiplier factor
IMPORT_C void CDoppler::SetCartesianVelocityL (  TInt32  aX,
TInt32  aY,
TInt32  aZ
) 
 

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

Parameters:
aX  Velocity in X direction (mm/s)
aY  Velocity in Y direction (mm/s)
aZ  Velocity in Z direction (mm/s)
Returns:
-
IMPORT_C void CDoppler::SetEffectData (  const TDesC8 &  aEffectDataBuffer  )  [protected, virtual]
 

From CAudioEffect Internal function to unpack effect data.

Parameters:
aEffectDataBuffer  Descriptor containing packed effect data
Returns:
-

Implements CAudioEffect.

IMPORT_C void CDoppler::SetFactorL (  TUint32  aFactor  ) 
 

Sets the multiplier factor.

Parameters:
aFactor  Factor value in hundredths that ranges from 0 to FactorMax(), where 100 corresponds to 1.00, 200 corresponds to 2.00, etc.
Returns:
-
IMPORT_C void CDoppler::SetSphericalVelocityL (  TInt32  aAzimuth,
TInt32  aElevation,
TInt32  aRadius
) 
 

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

Parameters:
aAzimuth  the Azimuth (thousandths of radians)
aElevation  the elevation (thousandths of radians)
aRadius  the radius (thousandths of radians)
Returns:
-
IMPORT_C void CDoppler::SphericalVelocity (  TInt32 &  aAzimuth,
TInt32 &  aElevation,
TInt32 &  aRadius
) 
 

Gets the velocity's spherical coordinates settings.

Parameters:
aAzimuth  the Azimuth (thousandths of radians)
aElevation  the elevation (thousandths of radians)
aRadius  the radius (thousandths of radians)
Returns:
-

Field Documentation

TEfDopplerDataPckg CDoppler::iDataPckgFrom [protected]
 
TEfDopplerDataPckg CDoppler::iDataPckgTo [protected]
 
TEfDoppler CDoppler::iDopplerData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top