Symbian^3 Product Developer Library >

multimedia::MDistanceAttenuationControl Class Reference

class multimedia::MDistanceAttenuationControl : public multimedia::MAudioEffectControl

Inherits from

Public Member Functions
TInt DistanceAttenuation(TInt &, TInt &, TBool &, TUint &, TUint &)
TInt RollOffFactorMax(TUint &)
TInt RoomRollOffFactorMax(TUint &)
TInt SetDistanceAttenuation(TInt, TInt, TBool, TUint, TUint)
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 TUintKDistanceAttenuationChanged
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

DistanceAttenuation(TInt &, TInt &, TBool &, TUint &, TUint &)

TInt DistanceAttenuation(TInt &aRMin,
TInt &aRMax,
TBool &aMuteAfterMax,
TUint &aRollOffFactor,
TUint &aRoomRollOffFactor
)[pure virtual]
Gets the Distance Attenuation of the listener.
Since
3.0

Parameters

TInt & aRMinThe source-to-listener distance below which the sound level is constant
TInt & aRMaxThe source-to-listener distance above which the sound level is constant or zero
TBool & aMuteAfterMaxIndicate if the sound is muted beyond RMax
TUint & aRollOffFactorMultiplier factor to source-to-listener distance
TUint & aRoomRollOffFactorMultiplier factor to source-to-listener distance for Room effect.

RollOffFactorMax(TUint &)

TInt RollOffFactorMax(TUint &aRollOfFactorMax)[pure virtual]
Get roll off factor maximum value.
Since
3.0

Parameters

TUint & aRollOfFactorMax

RoomRollOffFactorMax(TUint &)

TInt RoomRollOffFactorMax(TUint &aRoomRollOfFactorMax)[pure virtual]
Get room roll off factor maximum value.
Since
3.0

Parameters

TUint & aRoomRollOfFactorMax

SetDistanceAttenuation(TInt, TInt, TBool, TUint, TUint)

TInt SetDistanceAttenuation(TIntaRMin,
TIntaRMax,
TBoolaMuteAfterMax,
TUintaRollOffFactor,
TUintaRoomRollOffFactor
)[pure virtual]
Sets the Distance Attenuation
Since
3.0

Parameters

TInt aRMinThe source-to-listener distance below which the sound level is constant
TInt aRMaxThe source-to-listener distance above which the sound level is constant or zero
TBool aMuteAfterMaxIndicate if the sound is muted beyond RMax
TUint aRollOffFactorMultiplier factor to source-to-listener distance
TUint aRoomRollOffFactorMultiplier factor to source-to-listener distance for Room effect.

Member Data Documentation

const TUint KDistanceAttenuationChanged

const TUintKDistanceAttenuationChanged[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.