CDistanceAttenuation Class Reference

#include <DistanceAttenuationBase.h>

Link against: DistanceAttenuationEffect.lib

class CDistanceAttenuation : public CAudioEffect

Inherits from

CDistanceAttenuation
- CAudioEffect

Protected Attributes
TEfDistanceAttenuationDataPckg	iDataPckgFrom
TEfDistanceAttenuationDataPckg	iDataPckgTo
TEfDistanceAttenuation	iDistanceAttenuationData

Public Member Functions
virtual	~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)
virtual IMPORT_C TUid	Uid()

Protected Member Functions
	CDistanceAttenuation()
virtual IMPORT_C const TDesC8 &	DoEffectData()
virtual IMPORT_C void	SetEffectData(const TDesC8 &)

Inherited Attributes
	CAudioEffect::iEnabled
	CAudioEffect::iEnforced
	CAudioEffect::iHaveUpdateRights
	CAudioEffect::iObservers

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()

Detailed Description

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

Since: 3.0

Member Attribute Documentation

iDataPckgFrom

TEfDistanceAttenuationDataPckg

iDataPckgFrom

[protected]

iDataPckgTo

TEfDistanceAttenuationDataPckg

iDataPckgTo

[protected]

iDistanceAttenuationData

TEfDistanceAttenuation

iDistanceAttenuationData

[protected]

Constructor & Destructor Documentation

CDistanceAttenuation ( )

IMPORT_C

CDistanceAttenuation

(

)

[protected]

Private C++ constructor for this class.

Since: 3.0

Returns: -

~CDistanceAttenuation ( )

IMPORT_C

~CDistanceAttenuation

(

)

[virtual]

Destructor

Member Function 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

Parameter	Description
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: -

DoEffectData ( )

IMPORT_C const TDesC8 &

DoEffectData

(

)

[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data

Since: 3.0

Returns: A descriptor containing the effect data.

NewL ( CMdaAudioConvertUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMdaAudioConvertUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to a convert utility

Returns: pointer to CDistanceAttenuation object

NewL ( CMdaAudioInputStream & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMdaAudioInputStream &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio input stream utility

Returns: pointer to CDistanceAttenuation object

NewL ( CMdaAudioOutputStream & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMdaAudioOutputStream &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio output stream utility

Returns: pointer to CDistanceAttenuation object

NewL ( CMdaAudioPlayerUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMdaAudioPlayerUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio player utility

Returns: pointer to CDistanceAttenuation object

NewL ( CMdaAudioRecorderUtility &, TBool )

IMPORT_C CDistanceAttenuation *	NewL	(	CMdaAudioRecorderUtility &	aUtility,
			TBool	aRecordStream
		)	[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
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

NewL ( CMMFDevSound & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMMFDevSound &

aDevSound

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aDevSound	A reference to a DevSound instance

Returns: pointer to CDistanceAttenuation object

NewL ( CMdaAudioToneUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMdaAudioToneUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to an audio tone utility

Returns: pointer to CDistanceAttenuation object

NewL ( CCustomCommandUtility * )

IMPORT_C CDistanceAttenuation *

NewL

(

CCustomCommandUtility *

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to a custom command utility

Returns: pointer to CDistanceAttenuation object

NewL ( MCustomInterface & )

IMPORT_C CDistanceAttenuation *

NewL

(

MCustomInterface &

aCustomInterface

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aCustomInterface	A reference to a custom interface

Returns: pointer to CDistanceAttenuation object

NewL ( CMidiClientUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CMidiClientUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Parameter	Description
aUtility	A reference to a CMidiClientUtility

Returns: pointer to CDistanceAttenuation object

NewL ( CDrmPlayerUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CDrmPlayerUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.0

Returns: pointer to CDistanceAttenuation object

NewL ( CVideoPlayerUtility & )

IMPORT_C CDistanceAttenuation *

NewL

(

CVideoPlayerUtility &

aUtility

)

[static]

Factory function for creating the distance attenuation object.

Since: 3.2

Returns: pointer to CDistanceAttenuation object

RollOffFactorMax ( TUint32 & )

IMPORT_C void

RollOffFactorMax

(

TUint32 &

aRollOfFactorMax

)

Get roll off factor maximum value.

Since: 3.0

Returns: -

RoomRollOffFactorMax ( TUint32 & )

IMPORT_C void

RoomRollOffFactorMax

(

TUint32 &

aRoomRollOfFactorMax

)

Get room roll off factor maximum value.

Since: 3.0

Returns: -

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

Parameter	Description
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: -

SetEffectData ( const TDesC8 & )

IMPORT_C void

SetEffectData

(

const TDesC8 &

aEffectDataBuffer

)

[protected, virtual]

Reimplemented from CAudioEffect::SetEffectData(const TDesC8 &)

From CAudioEffect Internal function to unpack effect data

Since: 3.0

Parameter	Description
aEffectDataBuffer	Descriptor containing packed effect data

Returns: -

Uid ( )

IMPORT_C TUid

Uid

(

)

const [virtual]

Reimplemented from CAudioEffect::Uid()const