CDoppler Class Reference
| class CDoppler : public CAudioEffect |
This is the Doppler effect class for managing doppler settings.
DopplerEffect.lib
- Since
- 3.0
Constructor & Destructor Documentation
CDoppler()
| IMPORT_C | CDoppler | ( | ) | [protected] |
Private C++ constructor for this class.
~CDoppler()
| IMPORT_C | ~CDoppler | ( | ) | [protected, virtual] |
Member Functions Documentation
CartesianVelocity(TInt32 &, TInt32 &, TInt32 &)
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()
Get the current multiplier factor
- Since
- 3.0
FactorMax()
Get the maximum multiplier factor
- Since
- 3.0
SetCartesianVelocityL(TInt32, TInt32, TInt32)
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)
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 &)
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
iDataPckgTo
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.