CDistanceAttenuation Class Reference

API published in: S60 3rd Ed

Link against: distanceattenuationeffect.lib

Capability Information

Required Capabilities

None

#include <distanceattenuationbase.h>

Inherits CAudioEffect.

Detailed Description

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

Public Member Functions

virtual IMPORT_C ~CDistanceAttenuation ()
 Destructor.
IMPORT_C void DistanceAttenuation (TInt32 &aRMin, TInt32 &aRMax, TBool &aMuteAfterMax, TUint32 &aRollOffFactor, TUint32 &aRoomRollOffFactor)
 Gets the Distance Attenuation of the listener.
IMPORT_C void RollOffFactorMax (TUint32 &aRollOfFactorMax)
 Get roll off factor maximum value.
IMPORT_C void RoomRollOffFactorMax (TUint32 &aRoomRollOfFactorMax)
 Get room roll off factor maximum value.
IMPORT_C void SetDistanceAttenuationL (TInt32 aRMin, TInt32 aRMax, TBool aMuteAfterMax, TUint32 aRollOffFactor, TUint32 aRoomRollOffFactor)
 Sets the Distance Attenuation.
IMPORT_C TUid Uid () const

Static Public Member Functions

static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioConvertUtility &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioInputStream &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioOutputStream &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioPlayerUtility &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioRecorderUtility &aUtility, TBool aRecordStream)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMMFDevSound &aDevSound)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMdaAudioToneUtility &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CCustomCommandUtility *aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (MCustomInterface &aCustomInterface)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CMidiClientUtility &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CDrmPlayerUtility &aUtility)
 Factory function for creating the distance attenuation object.
static IMPORT_C CDistanceAttenuation * NewL (CVideoPlayerUtility &aUtility)
 Factory function for creating the distance attenuation object.

Protected Member Functions

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.
IMPORT_C CDistanceAttenuation ()
 Private C++ constructor for this class.

Protected Attributes

TEfDistanceAttenuation iDistanceAttenuationData
TEfDistanceAttenuationDataPckg iDataPckgTo
TEfDistanceAttenuationDataPckg iDataPckgFrom

Friends

class CDistanceAttenuationMessageHandler

Constructor & Destructor Documentation

virtual IMPORT_C CDistanceAttenuation::~CDistanceAttenuation (   )  [virtual]
 

Destructor.

IMPORT_C CDistanceAttenuation::CDistanceAttenuation (   )  [protected]
 

Private C++ constructor for this class.

Parameters:
aEffectObserver reference to event observer object
Returns:
-

Member Function Documentation

IMPORT_C void CDistanceAttenuation::DistanceAttenuation ( TInt32 &  aRMin,
TInt32 &  aRMax,
TBool &  aMuteAfterMax,
TUint32 &  aRollOffFactor,
TUint32 &  aRoomRollOffFactor
) 
 

Gets the Distance Attenuation of the listener.

Parameters:
aRMin The source-to-listener distance below which the sound level is constant
aRMax The source-to-listener distance above which the sound level is constant or zero
aMuteAfterMax Indicate if the sound is muted beyond RMax
aRollOffFactor Multiplier factor to source-to-listener distance
aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.
Returns:
-
IMPORT_C const TDesC8& CDistanceAttenuation::DoEffectData (   )  [protected, virtual]
 

From CAudioEffect Create a package of the effect data.

Returns:
A descriptor containing the effect data.

Implements CAudioEffect.

static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CVideoPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
CVideoPlayerUtility A reference to a CVideoPlayerUtility object
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CDrmPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
CDrmPlayerUtility A reference to a CDrmPlayerUtility object
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMidiClientUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to a CMidiClientUtility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( MCustomInterface &  aCustomInterface  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aCustomInterface A reference to a custom interface
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CCustomCommandUtility *  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to a custom command utility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioToneUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to an audio tone utility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMMFDevSound &  aDevSound  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aDevSound A reference to a DevSound instance
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioRecorderUtility &  aUtility,
TBool  aRecordStream
)  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to an audio record utility
aRecordStream ETrue if the effect is to be applied to the recording, EFalse if the effect is to be applied only to the playback
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioPlayerUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to an audio player utility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioOutputStream &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to an audio output stream utility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioInputStream &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to an audio input stream utility
Returns:
pointer to CDistanceAttenuation object
static IMPORT_C CDistanceAttenuation* CDistanceAttenuation::NewL ( CMdaAudioConvertUtility &  aUtility  )  [static]
 

Factory function for creating the distance attenuation object.

Parameters:
aUtility A reference to a convert utility
Returns:
pointer to CDistanceAttenuation object
IMPORT_C void CDistanceAttenuation::RollOffFactorMax ( TUint32 &  aRollOfFactorMax  ) 
 

Get roll off factor maximum value.

Parameters:
aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect.
Returns:
-
IMPORT_C void CDistanceAttenuation::RoomRollOffFactorMax ( TUint32 &  aRoomRollOfFactorMax  ) 
 

Get room roll off factor maximum value.

Parameters:
aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect.
Returns:
-
IMPORT_C void CDistanceAttenuation::SetDistanceAttenuationL ( TInt32  aRMin,
TInt32  aRMax,
TBool  aMuteAfterMax,
TUint32  aRollOffFactor,
TUint32  aRoomRollOffFactor
) 
 

Sets the Distance Attenuation.

Parameters:
aRMin The source-to-listener distance below which the sound level is constant
aRMax The source-to-listener distance above which the sound level is constant or zero
aMuteAfterMax Indicate if the sound is muted beyond RMax
aRollOffFactor Multiplier factor to source-to-listener distance
aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect.
Returns:
-
IMPORT_C void CDistanceAttenuation::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 TUid CDistanceAttenuation::Uid (   )  const [virtual]
 

Implements CAudioEffect.

Friends And Related Function Documentation

friend class CDistanceAttenuationMessageHandler [friend]
 

Field Documentation

TEfDistanceAttenuationDataPckg CDistanceAttenuation::iDataPckgFrom [protected]
 
TEfDistanceAttenuationDataPckg CDistanceAttenuation::iDataPckgTo [protected]
 
TEfDistanceAttenuation CDistanceAttenuation::iDistanceAttenuationData [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top