Symbian^3 Product Developer Library >

multimedia::MListenerDopplerControl Class Reference

class multimedia::MListenerDopplerControl : public multimedia::MAudioEffectControl

Inherits from

Public Member Functions
TInt CartesianVelocity(TInt &, TInt &, TInt &)
TInt Factor(TUint &)
TInt FactorMax(TUint &)
TInt SetCartesianVelocity(TInt, TInt, TInt)
TInt SetFactor(TUint)
TInt SetSphericalVelocity(TInt, TInt, TInt)
TInt SphericalVelocity(TInt &, TInt &, TInt &)
Inherited Functions
multimedia::MAudioEffectControl::Disable()
multimedia::MAudioEffectControl::Enable()
multimedia::MAudioEffectControl::Enforce(TBool &)
multimedia::MAudioEffectControl::HaveUpdateRights(TBool &)
multimedia::MAudioEffectControl::IsEnabled(TBool &)
multimedia::MAudioEffectControl::IsEnforced(TBool &)
multimedia::MAudioEffectControl::Uid(TUid &)
multimedia::MControl::AddObserver(MControlObserver &)
multimedia::MControl::ControlType()
multimedia::MControl::RemoveObserver(MControlObserver &)
multimedia::MControl::Type()
multimedia::MEffectControl::Apply()
Public Attributes
const TUintKCartesianVelocityChanged
const TUintKFactorChanged
const TUintKMaxFactorChanged
const TUintKSphericalVelocityChanged
Inherited Attributes
multimedia::MAudioEffectControl::KDisabled
multimedia::MAudioEffectControl::KEnabled
multimedia::MAudioEffectControl::KEnforced
multimedia::MAudioEffectControl::KGainedUpdateRights
multimedia::MAudioEffectControl::KLostUpdateRights
multimedia::MAudioEffectControl::KNotEnforced
multimedia::MAudioEffectControl::KSpecificEffectBase

Member Functions Documentation

CartesianVelocity(TInt &, TInt &, TInt &)

TInt CartesianVelocity(TInt &aX,
TInt &aY,
TInt &aZ
)[pure virtual]
Get the velocity's cartesian settings
Since
5.0

Parameters

TInt & aXVelocity in X direction (mm/s)
TInt & aYVelocity in Y direction (mm/s)
TInt & aZVelocity in Z direction (mm/s)

Factor(TUint &)

TInt Factor(TUint &aFactor)[pure virtual]
Get the current multiplier factor
Since
5.0

Parameters

TUint & aFactor

FactorMax(TUint &)

TInt FactorMax(TUint &aFactorMax)[pure virtual]
Get the maximum multiplier factor
Since
5.0

Parameters

TUint & aFactorMax

SetCartesianVelocity(TInt, TInt, TInt)

TInt SetCartesianVelocity(TIntaX,
TIntaY,
TIntaZ
)[pure virtual]
Sets the velocity in Cartesian coordinates of the sound source with respect to the listener.
Since
5.0

Parameters

TInt aXVelocity in X direction (mm/s)
TInt aYVelocity in Y direction (mm/s)
TInt aZVelocity in Z direction (mm/s)

SetFactor(TUint)

TInt SetFactor(TUintaFactor)[pure virtual]
Sets the multiplier factor.
Since
5.0

Parameters

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

SetSphericalVelocity(TInt, TInt, TInt)

TInt SetSphericalVelocity(TIntaAzimuth,
TIntaElevation,
TIntaRadius
)[pure virtual]
Sets the velocity in spherical coordinates of the sound source with respect to the listener.
Since
5.0

Parameters

TInt aAzimuththe Azimuth (thousandths of radians)
TInt aElevationthe elevation (thousandths of radians)
TInt aRadiusthe radius (thousandths of radians)

SphericalVelocity(TInt &, TInt &, TInt &)

TInt SphericalVelocity(TInt &aAzimuth,
TInt &aElevation,
TInt &aRadius
)[pure virtual]
Gets the velocity's spherical coordinates settings.
Since
5.0

Parameters

TInt & aAzimuththe Azimuth (thousandths of radians)
TInt & aElevationthe elevation (thousandths of radians)
TInt & aRadiusthe radius (thousandths of radians)

Member Data Documentation

const TUint KCartesianVelocityChanged

const TUintKCartesianVelocityChanged[static]

const TUint KFactorChanged

const TUintKFactorChanged[static]

const TUint KMaxFactorChanged

const TUintKMaxFactorChanged[static]

const TUint KSphericalVelocityChanged

const TUintKSphericalVelocityChanged[static]

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.