Symbian^3 Application Developer Library >

CDistanceAttenuation Class Reference

class CDistanceAttenuation : public CAudioEffect

This is the Distance Attenuation effect class for managing audio Distance Attenuation settings.

DistanceAttenuationEffect.lib
Since
3.0

Inherits from

Public Member Functions
~CDistanceAttenuation ()
IMPORT_C void DistanceAttenuation ( TInt32 &, TInt32 &, TBool &, TUint32 &, TUint32 &)
IMPORT_C CDistanceAttenuation * NewL (CMdaAudioConvertUtility &)
IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioInputStream &)
IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioOutputStream &)
IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioPlayerUtility &)
IMPORT_C CDistanceAttenuation * NewL (CMdaAudioRecorderUtility &, TBool )
IMPORT_C CDistanceAttenuation * NewL ( CMMFDevSound &)
IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioToneUtility &)
IMPORT_C CDistanceAttenuation * NewL ( CCustomCommandUtility *)
IMPORT_C CDistanceAttenuation * NewL ( MCustomInterface &)
IMPORT_C CDistanceAttenuation * NewL (CMidiClientUtility &)
IMPORT_C CDistanceAttenuation * NewL ( CDrmPlayerUtility &)
IMPORT_C CDistanceAttenuation * NewL ( CVideoPlayerUtility &)
IMPORT_C void RollOffFactorMax ( TUint32 &)
IMPORT_C void RoomRollOffFactorMax ( TUint32 &)
IMPORT_C void SetDistanceAttenuationL ( TInt32 , TInt32 , TBool , TUint32 , TUint32 )
IMPORT_C TUid Uid ()
Protected Member Functions
CDistanceAttenuation ()
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::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
TEfDistanceAttenuationDataPckg iDataPckgFrom
TEfDistanceAttenuationDataPckg iDataPckgTo
TEfDistanceAttenuation iDistanceAttenuationData
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

CDistanceAttenuation()

IMPORT_C CDistanceAttenuation ( ) [protected]
Private C++ constructor for this class.
Since
3.0

~CDistanceAttenuation()

IMPORT_C ~CDistanceAttenuation ( ) [virtual]

Destructor

Member Functions Documentation

DistanceAttenuation(TInt32 &, TInt32 &, TBool &, TUint32 &, TUint32 &)

IMPORT_C void DistanceAttenuation ( TInt32 & aRMin,
TInt32 & aRMax,
TBool & aMuteAfterMax,
TUint32 & aRollOffFactor,
TUint32 & aRoomRollOffFactor
)
Gets the Distance Attenuation of the listener.
Since
3.0

Parameters

TInt32 & aRMin The source-to-listener distance below which the sound level is constant
TInt32 & aRMax The source-to-listener distance above which the sound level is constant or zero
TBool & aMuteAfterMax Indicate if the sound is muted beyond RMax
TUint32 & aRollOffFactor Multiplier factor to source-to-listener distance
TUint32 & aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.

DoEffectData()

IMPORT_C const TDesC8 & DoEffectData ( ) [protected, virtual]
From CAudioEffect Create a package of the effect data
Since
3.0

NewL(CMdaAudioConvertUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioConvertUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioConvertUtility & aUtility A reference to a convert utility

NewL(CMdaAudioInputStream &)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioInputStream & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioInputStream & aUtility A reference to an audio input stream utility

NewL(CMdaAudioOutputStream &)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioOutputStream & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioOutputStream & aUtility A reference to an audio output stream utility

NewL(CMdaAudioPlayerUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioPlayerUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioPlayerUtility & aUtility A reference to an audio player utility

NewL(CMdaAudioRecorderUtility &, TBool)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioRecorderUtility & aUtility,
TBool aRecordStream
) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioRecorderUtility & aUtility A reference to an audio record utility
TBool aRecordStream ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback

NewL(CMMFDevSound &)

IMPORT_C CDistanceAttenuation * NewL ( CMMFDevSound & aDevSound ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMMFDevSound & aDevSound A reference to a DevSound instance

NewL(CMdaAudioToneUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CMdaAudioToneUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMdaAudioToneUtility & aUtility A reference to an audio tone utility

NewL(CCustomCommandUtility *)

IMPORT_C CDistanceAttenuation * NewL ( CCustomCommandUtility * aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CCustomCommandUtility * aUtility A reference to a custom command utility

NewL(MCustomInterface &)

IMPORT_C CDistanceAttenuation * NewL ( MCustomInterface & aCustomInterface ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

MCustomInterface & aCustomInterface A reference to a custom interface

NewL(CMidiClientUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CMidiClientUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CMidiClientUtility & aUtility A reference to a CMidiClientUtility

NewL(CDrmPlayerUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CDrmPlayerUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.0

Parameters

CDrmPlayerUtility & aUtility

NewL(CVideoPlayerUtility &)

IMPORT_C CDistanceAttenuation * NewL ( CVideoPlayerUtility & aUtility ) [static]
Factory function for creating the distance attenuation object.
Since
3.2

Parameters

CVideoPlayerUtility & aUtility

RollOffFactorMax(TUint32 &)

IMPORT_C void RollOffFactorMax ( TUint32 & aRollOfFactorMax )
Get roll off factor maximum value.
Since
3.0

Parameters

TUint32 & aRollOfFactorMax

RoomRollOffFactorMax(TUint32 &)

IMPORT_C void RoomRollOffFactorMax ( TUint32 & aRoomRollOfFactorMax )
Get room roll off factor maximum value.
Since
3.0

Parameters

TUint32 & aRoomRollOfFactorMax

SetDistanceAttenuationL(TInt32, TInt32, TBool, TUint32, TUint32)

IMPORT_C void SetDistanceAttenuationL ( TInt32 aRMin,
TInt32 aRMax,
TBool aMuteAfterMax,
TUint32 aRollOffFactor,
TUint32 aRoomRollOffFactor
)
Sets the Distance Attenuation
Since
3.0

Parameters

TInt32 aRMin The source-to-listener distance below which the sound level is constant
TInt32 aRMax The source-to-listener distance above which the sound level is constant or zero
TBool aMuteAfterMax Indicate if the sound is muted beyond RMax
TUint32 aRollOffFactor Multiplier factor to source-to-listener distance
TUint32 aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.

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

Uid()

IMPORT_C TUid Uid ( ) const [virtual]

Member Data Documentation

TEfDistanceAttenuationDataPckg iDataPckgFrom

TEfDistanceAttenuationDataPckg iDataPckgFrom [protected]

TEfDistanceAttenuationDataPckg iDataPckgTo

TEfDistanceAttenuationDataPckg iDataPckgTo [protected]

TEfDistanceAttenuation iDistanceAttenuationData

TEfDistanceAttenuation iDistanceAttenuationData [protected]

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.